获取指定的Service
功能介绍
该API用于获取指定的Service对象。
URI
GET /api/v1/namespaces/{namespace}/services/{name}
表1 描述该API的参数。
参数 |
是否必选 |
描述 |
---|---|---|
pretty |
No |
If 'true', then the output is pretty printed. |
namespace |
Yes |
Object name and auth scope, such as for teams and projects. |
name |
Yes |
Name of the Service. |
exact |
No |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
No |
Should this value be exported. Export strips fields that a user can not specify. |
请求消息
N/A
响应消息
响应参数:
响应参数如表2所示。
参数 |
参数类型 |
描述 |
---|---|---|
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. |
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. |
metadata |
metadata object |
- |
spec |
spec object |
- |
status |
status object |
- |
参数 |
参数类型 |
描述 |
---|---|---|
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. |
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. |
initializers |
initializers object |
An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user. |
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. |
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. |
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. |
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. |
generation |
Integer |
A sequence number representing a specific generation of the desired state. Currently only implemented by replication controllers. Populated by the system. Read-only. |
creationTimestamp |
String |
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. |
deletionTimestamp |
String |
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. |
deletionGracePeriodSeconds |
Integer |
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. |
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. |
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. |
ownerReferences |
ownerReferences object |
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. |
finalizers |
Array of strings |
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. |
参数 |
参数类型 |
描述 |
---|---|---|
ports |
ports object |
The list of ports that are exposed by this service. |
selector |
No |
This service will route traffic to pods having labels matching this selector. Label keys and values that must match in order to receive traffic for this service. If empty, all pods are selected, if not specified, endpoints must be manually specified. |
clusterIP |
String |
ClusterIP is usually assigned by the master and is the IP address of the service. If specified, it will be allocated to the service if it is unused or else creation of the service will fail. Valid values are None, empty string (""), or a valid IP address. 'None' can be specified for a headless service when proxying is not required. Cannot be updated. |
type |
String |
Type of exposed service. Must be ClusterIP, NodePort, or LoadBalancer. Defaults to ClusterIP. |
externalIPs |
Array of strings |
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. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field. |
healthCheckNodePort |
Integer |
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. |
loadBalancerSourceRanges |
Array of strings |
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. |
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 DNS name and requires Type to be ExternalName. |
deprecatedPublicIPs |
Array of strings |
deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used. |
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. |
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. |
参数 |
参数类型 |
描述 |
---|---|---|
apiVersion |
String |
API version of the referent. |
kind |
String |
Kind of the referent. |
name |
String |
Name of the referent. |
uid |
String |
UID of the referent. |
controller |
Boolean |
If true, this reference points to the managing controller. |
blockOwnerDeletion |
Boolean |
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service. |
protocol |
String |
The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP. |
port |
Integer |
The port that will be exposed by this service. |
targetPort |
String |
Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of Port is used (an identity map). Defaults to the service port. |
nodePort |
Integer |
The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. |
参数 |
参数类型 |
描述 |
---|---|---|
ingress |
ingress object |
Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. |
参数 |
参数类型 |
描述 |
---|---|---|
ip |
String |
IP is set for load-balancer ingress points that are IP based |
hostname |
String |
Hostname is set for load-balancer ingress points that are DNS based |
响应示例:
{ "kind": "Service", "apiVersion": "v1", "metadata": { "name": "myapp", "namespace": "default", "selfLink": "/api/v1/namespaces/default/services/myapp", "uid": "58b5ca7c-5d12-11e6-aeb9-286ed488fafe", "resourceVersion": "683", "creationTimestamp": "2016-08-08T02:46:46Z" }, "spec": { "ports": [ { "protocol": "TCP", "port": 8765, "targetPort": 9376 } ], "selector": { "app": "example" }, "clusterIP": "10.0.0.139", "type": "ClusterIP", "sessionAffinity": "None" }, "status": { "loadBalancer": {} } }
