华为云用户手册

响应示例 状态码：200 OK { "apiVersion" : "v1", "items" : [ { "metadata" : { "annotations" : { "kubernetes.io/created-by" : "{\"kind\":\"SerializedReference\",\"apiVersion\":\"v1\",\"reference\":{\"kind\":\"ReplicationController\",\"namespace\":\"default\",\"name\":\"fdsfsd\",\"uid\":\"7539c329-57c4-11e7-afb7-fa163e218692\",\"apiVersion\":\"v1\",\"resourceVersion\":\"956153\"}}", "kubernetes.io/limit-ranger" : "LimitRanger plugin set: cpu request for container container01" }, "creationTimestamp" : "2017-06-23T03:31:35Z", "generateName" : "fdsfsd-", "labels" : { "cce/appgroup" : "gfsad", "name" : "fdsfsd" }, "name" : "fdsfsd-ddnft", "namespace" : "default", "ownerReferences" : [ { "apiVersion" : "v1", "controller" : true, "kind" : "ReplicationController", "name" : "fdsfsd", "uid" : "7539c329-57c4-11e7-afb7-fa163e218692" } ], "resourceVersion" : "1449034", "selfLink" : "/api/v1/namespaces/default/pods/fdsfsd-ddnft", "uid" : "753a45bc-57c4-11e7-afb7-fa163e218692" }, "spec" : { "containers" : [ { "image" : "10.154.52.159:443/test/apache-php:latest", "imagePullPolicy" : "Always", "name" : "container01", "ports" : [ { "containerPort" : 80, "protocol" : "TCP" } ], "resources" : { "requests" : { "cpu" : "100m" } }, "terminationMessagePath" : "/dev/termination-log", "volumeMounts" : [ { "mountPath" : "/var/run/secrets/kubernetes.io/serviceaccount", "name" : "default-token-863rh", "readOnly" : true } ] } ], "dnsPolicy" : "ClusterFirst", "imagePullSecrets" : [ { "name" : "myregistry" } ], "nodeName" : "192.168.12.187", "restartPolicy" : "Always", "securityContext" : { }, "serviceAccount" : "default", "serviceAccountName" : "default", "volumes" : [ { "name" : "default-token-863rh", "secret" : { "defaultMode" : 420, "secretName" : "default-token-863rh" } } ] }, "status" : { "conditions" : [ { "lastProbeTime" : null, "lastTransitionTime" : "2017-06-23T03:31:36Z", "status" : "True", "type" : "Initialized" }, { "lastProbeTime" : null, "lastTransitionTime" : "2017-06-28T06:34:51Z", "status" : "True", "type" : "Ready" }, { "lastProbeTime" : null, "lastTransitionTime" : "2017-06-23T03:31:35Z", "status" : "True", "type" : "PodScheduled" } ], "containerStatuses" : [ { "containerID" : "docker://f3daa802f753d123fe66b2cba2e917725702f8d446c17541822a68f9d2414c6d", "image" : "10.154.52.159:443/test/apache-php:latest", "imageID" : "docker://sha256:2e233ad9329bd7f65572dd6acb1a03e8839c36abfdb1d1f9012d84d13cecf9fc", "lastState" : { }, "name" : "container01", "ready" : true, "restartCount" : 0, "state" : { "running" : { "startedAt" : "2017-06-28T06:34:46Z" } } } ], "hostIP" : "192.168.12.187", "phase" : "Running", "podIP" : "172.16.56.4", "startTime" : "2017-06-23T03:31:36Z" } } ], "kind" : "PodList", "metadata" : { "resourceVersion" : "1550321", "selfLink" : "/api/v1/pods" } }

响应示例 状态码：200 OK { "apiVersion" : "networking.cci.io/v1beta1", "kind" : "Network", "metadata" : { "annotations" : { "network.alpha.kubernetes.io/default-security-group" : "xxx", "network.alpha.kubernetes.io/domain-id" : "xxx", "network.alpha.kubernetes.io/project-id" : "xxx" }, "creationTimestamp" : "2018-09-03T11:21:00Z", "name" : "namespace-test-dc1-default-network", "namespace" : "namespace-test", "resourceVersion" : "5016899", "selfLink" : "/apis/networking.cci.io/v1beta1/namespaces/namespace-test/networks/namespace-test-dc1-default-network", "uid" : "6fb85414-af6b-11e8-b6ef-f898ef6c78b4" }, "spec" : { "attachedVPC" : "xxx", "availableZone" : "cn-north-4a", "cidr" : "192.168.244.0/23", "networkID" : "xxx", "networkType" : "underlay_neutron", "subnetID" : "xxx" }, "status" : { "state" : "Active" } }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” 表4 请求Body参数 参数 是否必选 参数类型 描述 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 dryRun 否 Array of strings When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed gracePeriodSeconds 否 Long The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. 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 orphanDependents 否 Boolean Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. preconditions 否 io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions object Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. propagationPolicy 否 String Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. 表5 io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions 参数 是否必选 参数类型 描述 resourceVersion 否 String Specifies the target ResourceVersion uid 否 String Specifies the target UID.

状态码 状态码 描述 200 OK 202 Accepted 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

URI DELETE /apis/networking.cci.io/v1beta1/namespaces/{namespace}/networks/{name} 表1 路径参数 参数 是否必选 参数类型 描述 name 是 String name of the Network namespace 是 String object name and auth scope, such as for teams and projects 表2 Query参数 参数 是否必选 参数类型 描述 dryRun 否 String When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed gracePeriodSeconds 否 Integer The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. orphanDependents 否 Boolean Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. propagationPolicy 否 String Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. pretty 否 String If 'true', then the output is pretty printed.

状态码 状态码 描述 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

URI PUT /api/v1/namespaces/{namespace}/endpoints/{name} 表1 路径参数 参数 是否必选 参数类型 描述 name 是 String name of the Endpoints namespace 是 String object name and auth scope, such as for teams and projects 表2 Query参数 参数 是否必选 参数类型 描述 dryRun 否 String When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldManager 否 String fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. pretty 否 String If 'true', then the output is pretty printed.

请求示例 替换Endpoint。 { "apiVersion" : "v1", "kind" : "Endpoints", "metadata" : { "annotations" : { "new-key" : "new-value", "test-key" : "test-value" }, "creationTimestamp" : "2023-03-28T13:55:52Z", "name" : "test-endpoint", "namespace" : "test-namespace", "resourceVersion" : "263561274", "selfLink" : "/api/v1/namespaces/test-namespace/endpoints/test-endpoint", "uid" : "3907aa64-c3f3-4de0-b938-9d23e8d12f94" }, "subsets" : [ { "addresses" : [ { "ip" : "192.168.226.222", "targetRef" : { "kind" : "Pod", "name" : "nginx-686bccd6f-ccsqb", "namespace" : "test-namespace", "resourceVersion" : "262055491", "uid" : "ae417968-4f69-40da-9228-2434671e9c66" } } ], "ports" : [ { "name" : "service0", "port" : 80, "protocol" : "TCP" } ] } ] }

响应示例 状态码：200 OK { "apiVersion" : "v1", "kind" : "Endpoints", "metadata" : { "annotations" : { "new-key" : "new-value", "test-key" : "test-value" }, "creationTimestamp" : "2023-03-28T13:55:52Z", "name" : "test-endpoint", "namespace" : "test-namespace", "resourceVersion" : "263576210", "selfLink" : "/api/v1/namespaces/test-namespace/endpoints/test-endpoint", "uid" : "3907aa64-c3f3-4de0-b938-9d23e8d12f94" }, "subsets" : [ { "addresses" : [ { "ip" : "192.168.226.222", "targetRef" : { "kind" : "Pod", "name" : "nginx-686bccd6f-ccsqb", "namespace" : "test-namespace", "resourceVersion" : "262055491", "uid" : "ae417968-4f69-40da-9228-2434671e9c66" } } ], "ports" : [ { "name" : "service0", "port" : 80, "protocol" : "TCP" } ] } ] }

状态码 状态码 描述 200 OK 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

响应示例 状态码：200 OK { "apiVersion" : "batch.volcano.sh/v1alpha1", "items" : [ { "apiVersion" : "batch.volcano.sh/v1alpha1", "kind" : "Job", "metadata" : { "creationTimestamp" : "2019-06-26T03:16:26Z", "generation" : 1, "labels" : { "app" : "patchlabel" }, "name" : "openmpi-hello-2-com", "namespace" : "cci-namespace-42263891", "resourceVersion" : "7695210", "selfLink" : "/apis/batch.volcano.sh/v1alpha1/namespaces/cci-namespace-42263891/jobs/openmpi-hello-2-com", "uid" : "c84d86f0-97c0-11e9-9d09-dc9914fb58e0" }, "spec" : { "minAvailable" : 1, "plugins" : { "env" : [ ], "ssh" : [ ], "svc" : [ ] }, "queue" : "default", "schedulerName" : "volcano", "tasks" : [ { "name" : "mpimaster", "policies" : [ { "action" : "CompleteJob", "event" : "TaskCompleted" } ], "replicas" : 1, "template" : { "spec" : { "containers" : [ { "command" : [ "/bin/sh", "-c", "MPI_HOST=`cat /etc/volcano/mpiworker.host | tr \"\\n\" \",\"`;\nmkdir -p /var/run/sshd; /usr/sbin/sshd;\nmpiexec --allow-run-as-root --host ${MPI_HOST} -np 2 mpi_hello_world 003e /home/re" ], "image" : "*.*.*.*:20202/l00427178/openmpi-hello:3.28", "name" : "mpimaster", "ports" : [ { "containerPort" : 22, "name" : "mpijob-port" } ], "resources" : { "limits" : { "cpu" : "250m", "memory" : "1Gi" }, "requests" : { "cpu" : "250m", "memory" : "1Gi" } }, "workingDir" : "/home" } ], "imagePullSecrets" : [ { "name" : "imagepull-secret" } ], "restartPolicy" : "OnFailure" } } }, { "name" : "mpiworker", "replicas" : 2, "template" : { "spec" : { "containers" : [ { "command" : [ "/bin/sh", "-c", "mkdir -p /var/run/sshd; /usr/sbin/sshd -D;" ], "image" : "*.*.*.*:20202/l00427178/openmpi-hello:3.28", "name" : "mpiworker", "ports" : [ { "containerPort" : 22, "name" : "mpijob-port" } ], "resources" : { "limits" : { "cpu" : "250m", "memory" : "1Gi" }, "requests" : { "cpu" : "250m", "memory" : "1Gi" } }, "workingDir" : "/home" } ], "imagePullSecrets" : [ { "name" : "imagepull-secret" } ], "restartPolicy" : "OnFailure" } } } ] }, "status" : { "minAvailable" : 1, "pending" : 3, "state" : { "phase" : "Inqueue" } } } ], "kind" : "JobList", "metadata" : { "continue" : "", "resourceVersion" : "7732232", "selfLink" : "/apis/batch.volcano.sh/v1alpha1/namespaces/cci-namespace-42263891/jobs" } }

URI DELETE /apis/batch.volcano.sh/v1alpha1/namespaces/{namespace}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String object name and auth scope, such as for teams and projects 表2 Query参数 参数 是否必选 参数类型 描述 allowWatchBookmarks 否 Boolean allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. continue 否 String The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. fieldSelector 否 String A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector 否 String A selector to restrict the list of returned objects by their labels. Defaults to everything. limit 否 Integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. resourceVersion 否 String resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch 否 String resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset timeoutSeconds 否 Integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. watch 否 Boolean Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. pretty 否 String If 'true', then the output is pretty printed.

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 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 code Integer Suggested HTTP return code for this status, 0 if not set. details io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. 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 message String A human-readable description of the status of this operation. metadata io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds reason String A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. status String Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status 表5 io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails 参数 参数类型 描述 causes Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. group String The group attribute of the resource associated with the status StatusReason. kind String The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds name String The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). retryAfterSeconds Integer If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action for those errors this field may indicate how long to wait before taking the alternate action. uid String UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids 表6 io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause 参数 参数类型 描述 field String The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items" message String A human-readable description of the cause of the error. This field may be presented as-is to a reader. reason String A machine-readable description of the cause of the error. If this value is empty there is no information available. 表7 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta 参数 参数类型 描述 continue String continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. remainingItemCount Long remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. resourceVersion String String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency selfLink String selfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

请求示例 将已创建Service的名称替换为“service-test”。 { "apiVersion" : "v1", "kind" : "Service", "metadata" : { "annotations" : { "kubernetes.io/elb.class" : "dnat", "kubernetes.io/natgateway.id" : "xxx", "tenant.kubernetes.io/domain-id" : "xxx", "tenant.kubernetes.io/project-id" : "xxx" }, "creationTimestamp" : "2022-09-06T06:28:09Z", "finalizers" : [ "service.kubernetes.io/load-balancer-cleanup" ], "labels" : { "app" : "service-test" }, "name" : "service-test", "namespace" : "namespace-test", "resourceVersion" : "41521168", "selfLink" : "/api/v1/namespaces/namespace-test/services/service-test", "uid" : "7dfc42ef-f938-401c-b44a-1f7bd79b3fcb" }, "spec" : { "clusterIP" : "10.247.64.172", "externalTrafficPolicy" : "Cluster", "loadBalancerIP" : "100.93.1.98", "ports" : [ { "name" : "service0", "nodePort" : 31966, "port" : 30157, "protocol" : "TCP", "targetPort" : 80 } ], "selector" : { "app" : "service-test" }, "sessionAffinity" : "None", "type" : "LoadBalancer" }, "status" : { "loadBalancer" : { } } }

响应示例 状态码：200 OK { "apiVersion" : "v1", "kind" : "Service", "metadata" : { "annotations" : { "kubernetes.io/elb.class" : "dnat", "kubernetes.io/natgateway.id" : "4ed25dd6-1887-439f-aef6-b1e3f2b57b5c", "tenant.kubernetes.io/domain-id" : "08a2c8ef8180d4150ff5c0012463ee60", "tenant.kubernetes.io/project-id" : "08a2c8ef8d80d4152ff8c001d0281c03" }, "creationTimestamp" : "2022-09-06T06:28:09Z", "finalizers" : [ "service.kubernetes.io/load-balancer-cleanup" ], "labels" : { "app" : "service-test" }, "name" : "service-test", "namespace" : "namespace-test", "resourceVersion" : "41521168", "selfLink" : "/api/v1/namespaces/namespace-test/services/service-test", "uid" : "7dfc42ef-f938-401c-b44a-1f7bd79b3fcb" }, "spec" : { "clusterIP" : "10.247.64.172", "externalTrafficPolicy" : "Cluster", "loadBalancerIP" : "100.93.1.98", "ports" : [ { "name" : "service0", "nodePort" : 31966, "port" : 30157, "protocol" : "TCP", "targetPort" : 80 } ], "selector" : { "app" : "service-test" }, "sessionAffinity" : "None", "type" : "LoadBalancer" }, "status" : { "loadBalancer" : { } } }

状态码 状态码 描述 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

URI PUT /api/v1/namespaces/{namespace}/services/{name} 表1 路径参数 参数 是否必选 参数类型 描述 name 是 String name of the Service namespace 是 String object name and auth scope, such as for teams and projects 表2 Query参数 参数 是否必选 参数类型 描述 dryRun 否 String When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldManager 否 String fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. pretty 否 String If 'true', then the output is pretty printed.

响应示例 状态码：200 OK { "apiVersion" : "v1", "kind" : "APIGroup", "name" : "batch.volcano.sh", "preferredVersion" : { "groupVersion" : "batch.volcano.sh/v1alpha1", "version" : "v1alpha1" }, "versions" : [ { "groupVersion" : "batch.volcano.sh/v1alpha1", "version" : "v1alpha1" } ] }

状态码 状态码 描述 200 OK 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

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 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 name String name is the name of the group. preferredVersion io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery object preferredVersion is the version preferred by the API server, which probably is the storage version. serverAddressByClientCIDRs Array of io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR objects a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. versions Array of io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery objects versions are the versions supported in this group. 表3 io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery 参数 参数类型 描述 groupVersion String groupVersion specifies the API group and version in the form "group/version" version String version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion. 表4 io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR 参数 参数类型 描述 clientCIDR String The CIDR with which clients can match their IP to figure out the server address that they should use. serverAddress String Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

URI GET /api/v1/namespaces 表1 Query参数 参数 是否必选 参数类型 描述 allowWatchBookmarks 否 Boolean allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. continue 否 String The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. fieldSelector 否 String A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector 否 String A selector to restrict the list of returned objects by their labels. Defaults to everything. limit 否 Integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. resourceVersion 否 String resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch 否 String resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset timeoutSeconds 否 Integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. watch 否 Boolean Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. pretty 否 String If 'true', then the output is pretty printed.

响应示例 状态码：200 OK { "apiVersion" : "v1", "items" : [ { "metadata" : { "creationTimestamp" : "2017-06-24T02:05:16Z", "name" : "default", "resourceVersion" : "6", "selfLink" : "/api/v1/namespaces/default", "uid" : "90dd5244-5881-11e7-b5d7-fa163e08a2fd" }, "spec" : { "finalizers" : [ "kubernetes" ] }, "status" : { "phase" : "Active" } }, { "metadata" : { "creationTimestamp" : "2017-06-24T02:05:17Z", "name" : "kube-system", "resourceVersion" : "25", "selfLink" : "/api/v1/namespaces/kube-system", "uid" : "9178fce6-5881-11e7-b5d7-fa163e08a2fd" }, "spec" : { "finalizers" : [ "kubernetes" ] }, "status" : { "phase" : "Active" } } ], "kind" : "NamespaceList", "metadata" : { "resourceVersion" : "594181", "selfLink" : "/api/v1/namespaces" } }

状态码 状态码 描述 200 OK 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

请求示例 创建一个名为“statefulset-test”的StatefuiSet负载，使用redis镜像创建3个Pod。 { "apiVersion" : "apps/v1", "kind" : "StatefulSet", "metadata" : { "name" : "statefulset-test" }, "spec" : { "replicas" : 3, "selector" : { "matchLabels" : { "app" : "statefulset-test" } }, "serviceName" : "statefulset-test", "template" : { "metadata" : { "labels" : { "app" : "statefulset-test" } }, "spec" : { "containers" : [ { "image" : "redis", "name" : "container-0", "resources" : { "limits" : { "cpu" : "500m", "memory" : "1024Mi" }, "requests" : { "cpu" : "500m", "memory" : "1024Mi" } } } ], "imagePullSecrets" : [ { "name" : "imagepull-secret" } ], "priority" : 0 } } } }

URI POST /apis/apps/v1/namespaces/{namespace}/statefulsets 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String object name and auth scope, such as for teams and projects 表2 Query参数 参数 是否必选 参数类型 描述 dryRun 否 String When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldManager 否 String fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. pretty 否 String If 'true', then the output is pretty printed.

状态码 状态码 描述 200 OK 201 Created 202 Accepted 400 BadRequest 401 Unauthorized 403 Forbidden 404 NotFound 405 MethodNotAllowed 406 NotAcceptable 409 AlreadyExists 415 UnsupportedMediaType 422 Invalid 429 TooManyRequests 500 InternalError 503 ServiceUnavailable 504 ServerTimeout

响应示例 状态码：200 OK { "apiVersion" : "apps/v1", "kind" : "StatefulSet", "metadata" : { "creationTimestamp" : "2018-09-04T07:13:00Z", "generation" : 1, "labels" : { "app" : "statefulset-test" }, "name" : "statefulset-test", "namespace" : "namespace-test", "resourceVersion" : "5207623", "selfLink" : "/apis/apps/v1/namespaces/namespace-test/statefulsets/statefulset-test", "uid" : "f4a35f35-b011-11e8-b6ef-f898ef6c78b4" }, "spec" : { "podManagementPolicy" : "OrderedReady", "replicas" : 3, "revisionHistoryLimit" : 10, "selector" : { "matchLabels" : { "app" : "statefulset-test" } }, "serviceName" : "", "template" : { "metadata" : { "annotations" : { "cri.cci.io/container-type" : "secure-container" }, "creationTimestamp" : null, "labels" : { "app" : "statefulset-test" } }, "spec" : { "containers" : [ { "image" : "redis", "imagePullPolicy" : "IfNotPresent", "name" : "container-0", "resources" : { "limits" : { "cpu" : "500m", "memory" : "1Gi" }, "requests" : { "cpu" : "500m", "memory" : "1Gi" } }, "terminationMessagePath" : "/dev/termination-log", "terminationMessagePolicy" : "File" } ], "dnsPolicy" : "ClusterFirst", "imagePullSecrets" : [ { "name" : "imagepull-secret" } ], "restartPolicy" : "Always", "schedulerName" : "default-scheduler", "securityContext" : { } } }, "updateStrategy" : { "type" : "OnDelete" } }, "status" : { "replicas" : 0 } }

URI PATCH /api/v1/namespaces/{namespace}/endpoints/{name} 表1 路径参数 参数 是否必选 参数类型 描述 name 是 String name of the Endpoints namespace 是 String object name and auth scope, such as for teams and projects 表2 Query参数 参数 是否必选 参数类型 描述 dryRun 否 String When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldManager 否 String fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). force 否 Boolean Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. pretty 否 String If 'true', then the output is pretty printed.

状态码 状态码 描述 200 OK 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

响应示例 状态码：200 OK { "apiVersion" : "v1", "kind" : "Endpoints", "metadata" : { "annotations" : { "test-key" : "test-value" }, "creationTimestamp" : "2023-03-28T13:55:52Z", "name" : "test-endpoint", "namespace" : "test-namespace", "resourceVersion" : "263561274", "selfLink" : "/api/v1/namespaces/test-namespace/endpoints/test-endpoint", "uid" : "3907aa64-c3f3-4de0-b938-9d23e8d12f94" }, "subsets" : [ { "addresses" : [ { "ip" : "192.168.226.222", "targetRef" : { "kind" : "Pod", "name" : "nginx-686bccd6f-ccsqb", "namespace" : "test-namespace", "resourceVersion" : "262055491", "uid" : "ae417968-4f69-40da-9228-2434671e9c66" } } ], "ports" : [ { "name" : "service0", "port" : 80, "protocol" : "TCP" } ] } ] }