替换Service - replaceNamespacedService
功能介绍
该API用于替换指定Namespace下的指定Service。
其中以下字段支持更新:
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /apis/cci/v2/namespaces/{namespace}/services/{name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
name of the Service |
|
namespace |
是 |
String |
object name and auth scope, such as for teams and projects |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见认证鉴权 |
|
Content-Type |
是 |
String |
消息体的类型(格式),默认取值为“application/json” |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds |
|
metadata |
是 |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
spec |
是 |
Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
annotations |
否 |
Map<String,String> |
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. Here is the support annotations of CCI: CCI Service Annotations. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
|
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 return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
|
labels |
否 |
Map<String,String> |
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 |
|
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 which 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 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ports |
否 |
Array of io.cci.api.pkg.apis.versioned.cci.v2.ServicePort objects |
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 |
|
selector |
否 |
Map<String,String> |
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 LoadBalancer. Ignored if type is ExternalName. The valid key or value must be an empty string or consist of alphanumeric characters, '-', '_' or '.', start and end with an alphanumeric character, and length cannot exceed 63. The key can be separated by a prefix with a '/', and the prefix must complies with the definition of DNS_SUBDOMAIN in RFC 1123. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
|
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 Possible enum values: |
|
sessionAffinityConfig |
否 |
io.cci.api.pkg.apis.versioned.cci.v2.SessionAffinityConfig object |
sessionAffinityConfig contains the configurations of session affinity. |
|
type |
是 |
String |
type determines how the Service is exposed. Valid option is LoadBalancer. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. - "LoadBalancer" means a service will be exposed via an external load balancer (if the cloud provider supports it). |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
port |
是 |
Integer |
The port that will be exposed by this service. Port must be in the range 1 to 65535. |
|
protocol |
否 |
String |
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. Possible enum values: |
|
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 the 'port' field is used (an identity map). This field should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds |
|
metadata |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
spec |
Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
|
|
status |
Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
annotations |
Map<String,String> |
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. Here is the support annotations of CCI: CCI Service Annotations. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
|
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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
deletionGracePeriodSeconds |
Long |
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 |
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 is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is 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. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
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. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. |
|
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 return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
|
generation |
Long |
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
|
labels |
Map<String,String> |
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 |
|
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 which 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 of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects |
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/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
selfLink |
String |
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. |
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
API version of the referent. |
|
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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
|
controller |
Boolean |
If true, this reference points to the managing controller. |
|
kind |
String |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
name |
String |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
|
uid |
String |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ports |
Array of io.cci.api.pkg.apis.versioned.cci.v2.ServicePort objects |
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 |
|
selector |
Map<String,String> |
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 LoadBalancer. Ignored if type is ExternalName. The valid key or value must be an empty string or consist of alphanumeric characters, '-', '_' or '.', start and end with an alphanumeric character, and length cannot exceed 63. The key can be separated by a prefix with a '/', and the prefix must complies with the definition of DNS_SUBDOMAIN in RFC 1123. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
|
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 Possible enum values: |
|
sessionAffinityConfig |
io.cci.api.pkg.apis.versioned.cci.v2.SessionAffinityConfig object |
sessionAffinityConfig contains the configurations of session affinity. |
|
type |
String |
type determines how the Service is exposed. Valid option is LoadBalancer. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. - "LoadBalancer" means a service will be exposed via an external load balancer (if the cloud provider supports it). |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
port |
Integer |
The port that will be exposed by this service. Port must be in the range 1 to 65535. |
|
protocol |
String |
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. Possible enum values: |
|
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 the 'port' field is used (an identity map). This field should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
clientIP |
clientIP contains the configurations of Client IP based session affinity. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
timeoutSeconds |
Integer |
timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
conditions |
Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects |
Current service state |
|
loadBalancer |
io.cci.api.pkg.apis.versioned.cci.v2.LoadBalancerStatus object |
LoadBalancer contains the current status of the load-balancer, if one is present. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
lastTransitionTime |
String |
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
|
message |
String |
message is a human readable message indicating details about the transition. This may be an empty string. |
|
observedGeneration |
Long |
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
|
reason |
String |
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
|
status |
String |
status of the condition, one of True, False, Unknown. |
|
type |
String |
type of condition in CamelCase or in foo.example.com/CamelCase. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ingress |
Array of io.cci.api.pkg.apis.versioned.cci.v2.LoadBalancerIngress objects |
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 (typically GCE or OpenStack load-balancers) |
|
ports |
Array of io.cci.api.pkg.apis.versioned.cci.v2.PortStatus objects |
Ports is a list of records of service ports If used, every port defined in the service should have an entry in it |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
String |
Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names format foo.example.com/CamelCase. |
|
port |
Integer |
Port is the port number of the service port of which status is recorded here |
|
protocol |
String |
Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP" Possible enum values: |
状态码:201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds |
|
metadata |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
spec |
Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
|
|
status |
Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
annotations |
Map<String,String> |
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. Here is the support annotations of CCI: CCI Service Annotations. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
|
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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
deletionGracePeriodSeconds |
Long |
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 |
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 is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is 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. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
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. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. |
|
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 return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
|
generation |
Long |
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
|
labels |
Map<String,String> |
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 |
|
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 which 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 of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects |
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/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
selfLink |
String |
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. |
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
API version of the referent. |
|
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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
|
controller |
Boolean |
If true, this reference points to the managing controller. |
|
kind |
String |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
name |
String |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
|
uid |
String |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ports |
Array of io.cci.api.pkg.apis.versioned.cci.v2.ServicePort objects |
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 |
|
selector |
Map<String,String> |
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 LoadBalancer. Ignored if type is ExternalName. The valid key or value must be an empty string or consist of alphanumeric characters, '-', '_' or '.', start and end with an alphanumeric character, and length cannot exceed 63. The key can be separated by a prefix with a '/', and the prefix must complies with the definition of DNS_SUBDOMAIN in RFC 1123. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
|
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 Possible enum values: |
|
sessionAffinityConfig |
io.cci.api.pkg.apis.versioned.cci.v2.SessionAffinityConfig object |
sessionAffinityConfig contains the configurations of session affinity. |
|
type |
String |
type determines how the Service is exposed. Valid option is LoadBalancer. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. - "LoadBalancer" means a service will be exposed via an external load balancer (if the cloud provider supports it). |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
port |
Integer |
The port that will be exposed by this service. Port must be in the range 1 to 65535. |
|
protocol |
String |
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. Possible enum values: |
|
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 the 'port' field is used (an identity map). This field should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
clientIP |
clientIP contains the configurations of Client IP based session affinity. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
timeoutSeconds |
Integer |
timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
conditions |
Array of io.k8s.apimachinery.pkg.apis.meta.v1.Condition objects |
Current service state |
|
loadBalancer |
io.cci.api.pkg.apis.versioned.cci.v2.LoadBalancerStatus object |
LoadBalancer contains the current status of the load-balancer, if one is present. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
lastTransitionTime |
String |
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
|
message |
String |
message is a human readable message indicating details about the transition. This may be an empty string. |
|
observedGeneration |
Long |
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
|
reason |
String |
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
|
status |
String |
status of the condition, one of True, False, Unknown. |
|
type |
String |
type of condition in CamelCase or in foo.example.com/CamelCase. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ingress |
Array of io.cci.api.pkg.apis.versioned.cci.v2.LoadBalancerIngress objects |
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 (typically GCE or OpenStack load-balancers) |
|
ports |
Array of io.cci.api.pkg.apis.versioned.cci.v2.PortStatus objects |
Ports is a list of records of service ports If used, every port defined in the service should have an entry in it |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
String |
Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names format foo.example.com/CamelCase. |
|
port |
Integer |
Port is the port number of the service port of which status is recorded here |
|
protocol |
String |
Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP" Possible enum values: |
请求示例
{
"apiVersion" : "cci/v2",
"kind" : "Service",
"metadata" : {
"annotations" : {
"kubernetes.io/elb.class" : "elb",
"kubernetes.io/elb.id" : "31ede280-933b-45f5-9981-a09f809a126b",
"tenant.cci.io/tenant-id" : "08a2*************************c03",
"tenant.kubernetes.io/domain-id" : "08a*************************ee60",
"tenant.kubernetes.io/project-id" : "08a2*************************c03"
},
"creationTimestamp" : "2024-09-26T03:21:42Z",
"finalizers" : [ "service.kubernetes.io/load-balancer-cleanup" ],
"labels" : {
"tenant.kubernetes.io/project-id" : "08a2*************************c03"
},
"name" : "service-example",
"namespace" : "test-api",
"resourceVersion" : "20208842",
"uid" : "5c06c480-da50-4ca8-8ded-0b2c6c26f68d"
},
"spec" : {
"ports" : [ {
"name" : "service-example-port",
"port" : 8888,
"protocol" : "TCP",
"targetPort" : 80
} ],
"selector" : {
"app" : "de-6"
},
"sessionAffinity" : "None",
"type" : "LoadBalancer"
},
"status" : {
"loadBalancer" : {
"ingress" : [ {
"ip" : "192.168.0.93"
} ]
}
}
}
响应示例
状态码:200
OK
{
"apiVersion" : "cci/v2",
"kind" : "Service",
"metadata" : {
"annotations" : {
"kubernetes.io/elb.class" : "elb",
"kubernetes.io/elb.id" : "31ede280-933b-45f5-9981-a09f809a126b",
"tenant.cci.io/tenant-id" : "08a2*************************c03",
"tenant.kubernetes.io/domain-id" : "08a*************************ee60",
"tenant.kubernetes.io/project-id" : "08a2*************************c03"
},
"creationTimestamp" : "2024-09-26T03:21:42Z",
"finalizers" : [ "service.kubernetes.io/load-balancer-cleanup" ],
"labels" : {
"tenant.kubernetes.io/project-id" : "08a2*************************c03"
},
"name" : "service-example",
"namespace" : "test-api",
"resourceVersion" : "20208842",
"uid" : "5c06c480-da50-4ca8-8ded-0b2c6c26f68d"
},
"spec" : {
"ports" : [ {
"name" : "service-example-port",
"port" : 8888,
"protocol" : "TCP",
"targetPort" : 80
} ],
"selector" : {
"app" : "de-6"
},
"sessionAffinity" : "None",
"type" : "LoadBalancer"
},
"status" : {
"loadBalancer" : {
"ingress" : [ {
"ip" : "192.168.0.93"
} ]
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
201 |
Created |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
NotFound |
|
405 |
MethodNotAllowed |
|
406 |
NotAcceptable |
|
409 |
Conflict |
|
415 |
UnsupportedMediaType |
|
422 |
Invalid |
|
429 |
TooManyRequests |
|
500 |
InternalError |
|
503 |
ServiceUnavailable |
|
504 |
ServerTimeout |