/api/v1/namespaces/{namespace}/services/{name}

开发中

GET

core_v1

read the specified Service

请求参数

Path 参数

namespace

string

必需

name

string

必需

Query 参数

exact

string

可选

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18.

export

string

可选

Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18.

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200OK

application/json

Body

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

apiVersion

string

可选

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

kind

string

可选

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

metadata

object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta)

可选

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

可选

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

clusterName

string

可选

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

creationTimestamp

string <date-time>

可选

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionGracePeriodSeconds

integer <int64>

可选

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp

string <date-time>

可选

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

finalizers

array[string]

可选

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

generateName

string

可选

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

generation

integer <int64>

可选

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

initializers

object (io.k8s.apimachinery.pkg.apis.meta.v1.Initializers)

可选

Initializers tracks the progress of initialization.

labels

object

可选

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

managedFields

array[object (io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry) {5}]

可选

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

This field is alpha and can be changed or removed without notice.

name

string

可选

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

string

可选

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

array[object (io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference) {6}]

可选

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

resourceVersion

string

可选

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

selfLink

string

可选

SelfLink is a URL representing this object. Populated by the system. Read-only.

uid

string

可选

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

object (io.k8s.api.core.v1.ServiceSpec)

可选

ServiceSpec describes the attributes that a user creates on a service.

clusterIP

string

可选

clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

externalIPs

array[string]

可选

externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.

externalName

string

可选

externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.

externalTrafficPolicy

string

可选

externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.

healthCheckNodePort

integer <int32>

可选

healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local.

loadBalancerIP

string

可选

Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.

loadBalancerSourceRanges

array[string]

可选

If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/

ports

array[object (io.k8s.api.core.v1.ServicePort) {5}]

可选

The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

publishNotReadyAddresses

boolean

可选

publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery.

selector

object

可选

Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/

sessionAffinity

string

可选

Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

sessionAffinityConfig

object (io.k8s.api.core.v1.SessionAffinityConfig)

可选

SessionAffinityConfig represents the configurations of session affinity.

type

string

可选

type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types

status

object (io.k8s.api.core.v1.ServiceStatus)

可选

ServiceStatus represents the current status of a service.

loadBalancer

object (io.k8s.api.core.v1.LoadBalancerStatus)

可选

LoadBalancerStatus represents the status of a load-balancer.

示例

{
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
        "annotations": {
            "property1": "string",
            "property2": "string"
        },
        "clusterName": "string",
        "creationTimestamp": "2019-08-24T14:15:22Z",
        "deletionGracePeriodSeconds": 0,
        "deletionTimestamp": "2019-08-24T14:15:22Z",
        "finalizers": [
            "string"
        ],
        "generateName": "string",
        "generation": 0,
        "initializers": {
            "pending": [
                {
                    "name": "string"
                }
            ],
            "result": {
                "apiVersion": "string",
                "code": 0,
                "details": {
                    "causes": [
                        {
                            "field": "string",
                            "message": "string",
                            "reason": "string"
                        }
                    ],
                    "group": "string",
                    "kind": "string",
                    "name": "string",
                    "retryAfterSeconds": 0,
                    "uid": "string"
                },
                "kind": "string",
                "message": "string",
                "metadata": {
                    "continue": "string",
                    "resourceVersion": "string",
                    "selfLink": "string"
                },
                "reason": "string",
                "status": "string"
            }
        },
        "labels": {
            "property1": "string",
            "property2": "string"
        },
        "managedFields": [
            {
                "apiVersion": "string",
                "fields": {},
                "manager": "string",
                "operation": "string",
                "time": "2019-08-24T14:15:22Z"
            }
        ],
        "name": "string",
        "namespace": "string",
        "ownerReferences": [
            {
                "apiVersion": "string",
                "blockOwnerDeletion": true,
                "controller": true,
                "kind": "string",
                "name": "string",
                "uid": "string"
            }
        ],
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
    },
    "spec": {
        "clusterIP": "string",
        "externalIPs": [
            "string"
        ],
        "externalName": "string",
        "externalTrafficPolicy": "string",
        "healthCheckNodePort": 0,
        "loadBalancerIP": "string",
        "loadBalancerSourceRanges": [
            "string"
        ],
        "ports": [
            {
                "name": "string",
                "nodePort": 0,
                "port": 0,
                "protocol": "string",
                "targetPort": "string"
            }
        ],
        "publishNotReadyAddresses": true,
        "selector": {
            "property1": "string",
            "property2": "string"
        },
        "sessionAffinity": "string",
        "sessionAffinityConfig": {
            "clientIP": {
                "timeoutSeconds": 0
            }
        },
        "type": "string"
    },
    "status": {
        "loadBalancer": {
            "ingress": [
                {
                    "hostname": "string",
                    "ip": "string"
                }
            ]
        }
    }
}

🟠401Unauthorized

/api/v1/namespaces/{namespace}/services/{name}