GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale+
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json index e156a0c560f..a8f2d390606 100644 --- a/api/openapi-spec/swagger.json +++ b/api/openapi-spec/swagger.json @@ -23987,6 +23987,166 @@ } ] }, + "/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale": { + "get": { + "description": "read scale of the specified Deployment", + "consumes": [ + "*/*" + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "schemes": [ + "https" + ], + "tags": [ + "apps_v1" + ], + "operationId": "readAppsV1NamespacedDeploymentScale", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-kubernetes-action": "get", + "x-kubernetes-group-version-kind": { + "group": "autoscaling", + "kind": "Scale", + "version": "v1" + } + }, + "put": { + "description": "replace scale of the specified Deployment", + "consumes": [ + "*/*" + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "schemes": [ + "https" + ], + "tags": [ + "apps_v1" + ], + "operationId": "replaceAppsV1NamespacedDeploymentScale", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-kubernetes-action": "put", + "x-kubernetes-group-version-kind": { + "group": "autoscaling", + "kind": "Scale", + "version": "v1" + } + }, + "patch": { + "description": "partially update scale of the specified Deployment", + "consumes": [ + "application/json-patch+json", + "application/merge-patch+json", + "application/strategic-merge-patch+json" + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "schemes": [ + "https" + ], + "tags": [ + "apps_v1" + ], + "operationId": "patchAppsV1NamespacedDeploymentScale", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Patch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-kubernetes-action": "patch", + "x-kubernetes-group-version-kind": { + "group": "autoscaling", + "kind": "Scale", + "version": "v1" + } + }, + "parameters": [ + { + "uniqueItems": true, + "type": "string", + "description": "name of the Scale", + "name": "name", + "in": "path", + "required": true + }, + { + "uniqueItems": true, + "type": "string", + "description": "object name and auth scope, such as for teams and projects", + "name": "namespace", + "in": "path", + "required": true + }, + { + "uniqueItems": true, + "type": "string", + "description": "If 'true', then the output is pretty printed.", + "name": "pretty", + "in": "query" + } + ] + }, "/apis/apps/v1/namespaces/{namespace}/deployments/{name}/status": { "get": { "description": "read status of the specified Deployment", @@ -24653,6 +24813,166 @@ } ] }, + "/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale": { + "get": { + "description": "read scale of the specified ReplicaSet", + "consumes": [ + "*/*" + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "schemes": [ + "https" + ], + "tags": [ + "apps_v1" + ], + "operationId": "readAppsV1NamespacedReplicaSetScale", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-kubernetes-action": "get", + "x-kubernetes-group-version-kind": { + "group": "autoscaling", + "kind": "Scale", + "version": "v1" + } + }, + "put": { + "description": "replace scale of the specified ReplicaSet", + "consumes": [ + "*/*" + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "schemes": [ + "https" + ], + "tags": [ + "apps_v1" + ], + "operationId": "replaceAppsV1NamespacedReplicaSetScale", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-kubernetes-action": "put", + "x-kubernetes-group-version-kind": { + "group": "autoscaling", + "kind": "Scale", + "version": "v1" + } + }, + "patch": { + "description": "partially update scale of the specified ReplicaSet", + "consumes": [ + "application/json-patch+json", + "application/merge-patch+json", + "application/strategic-merge-patch+json" + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "schemes": [ + "https" + ], + "tags": [ + "apps_v1" + ], + "operationId": "patchAppsV1NamespacedReplicaSetScale", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Patch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-kubernetes-action": "patch", + "x-kubernetes-group-version-kind": { + "group": "autoscaling", + "kind": "Scale", + "version": "v1" + } + }, + "parameters": [ + { + "uniqueItems": true, + "type": "string", + "description": "name of the Scale", + "name": "name", + "in": "path", + "required": true + }, + { + "uniqueItems": true, + "type": "string", + "description": "object name and auth scope, such as for teams and projects", + "name": "namespace", + "in": "path", + "required": true + }, + { + "uniqueItems": true, + "type": "string", + "description": "If 'true', then the output is pretty printed.", + "name": "pretty", + "in": "query" + } + ] + }, "/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status": { "get": { "description": "read status of the specified ReplicaSet", @@ -25319,6 +25639,166 @@ } ] }, + "/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale": { + "get": { + "description": "read scale of the specified StatefulSet", + "consumes": [ + "*/*" + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "schemes": [ + "https" + ], + "tags": [ + "apps_v1" + ], + "operationId": "readAppsV1NamespacedStatefulSetScale", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-kubernetes-action": "get", + "x-kubernetes-group-version-kind": { + "group": "autoscaling", + "kind": "Scale", + "version": "v1" + } + }, + "put": { + "description": "replace scale of the specified StatefulSet", + "consumes": [ + "*/*" + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "schemes": [ + "https" + ], + "tags": [ + "apps_v1" + ], + "operationId": "replaceAppsV1NamespacedStatefulSetScale", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-kubernetes-action": "put", + "x-kubernetes-group-version-kind": { + "group": "autoscaling", + "kind": "Scale", + "version": "v1" + } + }, + "patch": { + "description": "partially update scale of the specified StatefulSet", + "consumes": [ + "application/json-patch+json", + "application/merge-patch+json", + "application/strategic-merge-patch+json" + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "schemes": [ + "https" + ], + "tags": [ + "apps_v1" + ], + "operationId": "patchAppsV1NamespacedStatefulSetScale", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Patch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/io.k8s.api.autoscaling.v1.Scale" + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-kubernetes-action": "patch", + "x-kubernetes-group-version-kind": { + "group": "autoscaling", + "kind": "Scale", + "version": "v1" + } + }, + "parameters": [ + { + "uniqueItems": true, + "type": "string", + "description": "name of the Scale", + "name": "name", + "in": "path", + "required": true + }, + { + "uniqueItems": true, + "type": "string", + "description": "object name and auth scope, such as for teams and projects", + "name": "namespace", + "in": "path", + "required": true + }, + { + "uniqueItems": true, + "type": "string", + "description": "If 'true', then the output is pretty printed.", + "name": "pretty", + "in": "query" + } + ] + }, "/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status": { "get": { "description": "read status of the specified StatefulSet", diff --git a/api/swagger-spec/apps_v1.json b/api/swagger-spec/apps_v1.json index 7f5a7099be5..efe7308092c 100644 --- a/api/swagger-spec/apps_v1.json +++ b/api/swagger-spec/apps_v1.json @@ -3094,6 +3094,176 @@ } ] }, + { + "path": "/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale", + "description": "API at /apis/apps/v1", + "operations": [ + { + "type": "v1.Scale", + "method": "GET", + "summary": "read scale of the specified Deployment", + "nickname": "readNamespacedDeploymentScale", + "parameters": [ + { + "type": "string", + "paramType": "query", + "name": "pretty", + "description": "If 'true', then the output is pretty printed.", + "required": false, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "namespace", + "description": "object name and auth scope, such as for teams and projects", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "name", + "description": "name of the Scale", + "required": true, + "allowMultiple": false + } + ], + "responseMessages": [ + { + "code": 200, + "message": "OK", + "responseModel": "v1.Scale" + } + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "consumes": [ + "*/*" + ] + }, + { + "type": "v1.Scale", + "method": "PUT", + "summary": "replace scale of the specified Deployment", + "nickname": "replaceNamespacedDeploymentScale", + "parameters": [ + { + "type": "string", + "paramType": "query", + "name": "pretty", + "description": "If 'true', then the output is pretty printed.", + "required": false, + "allowMultiple": false + }, + { + "type": "v1.Scale", + "paramType": "body", + "name": "body", + "description": "", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "namespace", + "description": "object name and auth scope, such as for teams and projects", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "name", + "description": "name of the Scale", + "required": true, + "allowMultiple": false + } + ], + "responseMessages": [ + { + "code": 200, + "message": "OK", + "responseModel": "v1.Scale" + }, + { + "code": 201, + "message": "Created", + "responseModel": "v1.Scale" + } + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "consumes": [ + "*/*" + ] + }, + { + "type": "v1.Scale", + "method": "PATCH", + "summary": "partially update scale of the specified Deployment", + "nickname": "patchNamespacedDeploymentScale", + "parameters": [ + { + "type": "string", + "paramType": "query", + "name": "pretty", + "description": "If 'true', then the output is pretty printed.", + "required": false, + "allowMultiple": false + }, + { + "type": "v1.Patch", + "paramType": "body", + "name": "body", + "description": "", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "namespace", + "description": "object name and auth scope, such as for teams and projects", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "name", + "description": "name of the Scale", + "required": true, + "allowMultiple": false + } + ], + "responseMessages": [ + { + "code": 200, + "message": "OK", + "responseModel": "v1.Scale" + } + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "consumes": [ + "application/json-patch+json", + "application/merge-patch+json", + "application/strategic-merge-patch+json" + ] + } + ] + }, { "path": "/apis/apps/v1/namespaces/{namespace}/deployments/{name}/status", "description": "API at /apis/apps/v1", @@ -4236,6 +4406,176 @@ } ] }, + { + "path": "/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale", + "description": "API at /apis/apps/v1", + "operations": [ + { + "type": "v1.Scale", + "method": "GET", + "summary": "read scale of the specified ReplicaSet", + "nickname": "readNamespacedReplicaSetScale", + "parameters": [ + { + "type": "string", + "paramType": "query", + "name": "pretty", + "description": "If 'true', then the output is pretty printed.", + "required": false, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "namespace", + "description": "object name and auth scope, such as for teams and projects", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "name", + "description": "name of the Scale", + "required": true, + "allowMultiple": false + } + ], + "responseMessages": [ + { + "code": 200, + "message": "OK", + "responseModel": "v1.Scale" + } + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "consumes": [ + "*/*" + ] + }, + { + "type": "v1.Scale", + "method": "PUT", + "summary": "replace scale of the specified ReplicaSet", + "nickname": "replaceNamespacedReplicaSetScale", + "parameters": [ + { + "type": "string", + "paramType": "query", + "name": "pretty", + "description": "If 'true', then the output is pretty printed.", + "required": false, + "allowMultiple": false + }, + { + "type": "v1.Scale", + "paramType": "body", + "name": "body", + "description": "", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "namespace", + "description": "object name and auth scope, such as for teams and projects", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "name", + "description": "name of the Scale", + "required": true, + "allowMultiple": false + } + ], + "responseMessages": [ + { + "code": 200, + "message": "OK", + "responseModel": "v1.Scale" + }, + { + "code": 201, + "message": "Created", + "responseModel": "v1.Scale" + } + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "consumes": [ + "*/*" + ] + }, + { + "type": "v1.Scale", + "method": "PATCH", + "summary": "partially update scale of the specified ReplicaSet", + "nickname": "patchNamespacedReplicaSetScale", + "parameters": [ + { + "type": "string", + "paramType": "query", + "name": "pretty", + "description": "If 'true', then the output is pretty printed.", + "required": false, + "allowMultiple": false + }, + { + "type": "v1.Patch", + "paramType": "body", + "name": "body", + "description": "", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "namespace", + "description": "object name and auth scope, such as for teams and projects", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "name", + "description": "name of the Scale", + "required": true, + "allowMultiple": false + } + ], + "responseMessages": [ + { + "code": 200, + "message": "OK", + "responseModel": "v1.Scale" + } + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "consumes": [ + "application/json-patch+json", + "application/merge-patch+json", + "application/strategic-merge-patch+json" + ] + } + ] + }, { "path": "/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status", "description": "API at /apis/apps/v1", @@ -5378,6 +5718,176 @@ } ] }, + { + "path": "/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale", + "description": "API at /apis/apps/v1", + "operations": [ + { + "type": "v1.Scale", + "method": "GET", + "summary": "read scale of the specified StatefulSet", + "nickname": "readNamespacedStatefulSetScale", + "parameters": [ + { + "type": "string", + "paramType": "query", + "name": "pretty", + "description": "If 'true', then the output is pretty printed.", + "required": false, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "namespace", + "description": "object name and auth scope, such as for teams and projects", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "name", + "description": "name of the Scale", + "required": true, + "allowMultiple": false + } + ], + "responseMessages": [ + { + "code": 200, + "message": "OK", + "responseModel": "v1.Scale" + } + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "consumes": [ + "*/*" + ] + }, + { + "type": "v1.Scale", + "method": "PUT", + "summary": "replace scale of the specified StatefulSet", + "nickname": "replaceNamespacedStatefulSetScale", + "parameters": [ + { + "type": "string", + "paramType": "query", + "name": "pretty", + "description": "If 'true', then the output is pretty printed.", + "required": false, + "allowMultiple": false + }, + { + "type": "v1.Scale", + "paramType": "body", + "name": "body", + "description": "", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "namespace", + "description": "object name and auth scope, such as for teams and projects", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "name", + "description": "name of the Scale", + "required": true, + "allowMultiple": false + } + ], + "responseMessages": [ + { + "code": 200, + "message": "OK", + "responseModel": "v1.Scale" + }, + { + "code": 201, + "message": "Created", + "responseModel": "v1.Scale" + } + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "consumes": [ + "*/*" + ] + }, + { + "type": "v1.Scale", + "method": "PATCH", + "summary": "partially update scale of the specified StatefulSet", + "nickname": "patchNamespacedStatefulSetScale", + "parameters": [ + { + "type": "string", + "paramType": "query", + "name": "pretty", + "description": "If 'true', then the output is pretty printed.", + "required": false, + "allowMultiple": false + }, + { + "type": "v1.Patch", + "paramType": "body", + "name": "body", + "description": "", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "namespace", + "description": "object name and auth scope, such as for teams and projects", + "required": true, + "allowMultiple": false + }, + { + "type": "string", + "paramType": "path", + "name": "name", + "description": "name of the Scale", + "required": true, + "allowMultiple": false + } + ], + "responseMessages": [ + { + "code": 200, + "message": "OK", + "responseModel": "v1.Scale" + } + ], + "produces": [ + "application/json", + "application/yaml", + "application/vnd.kubernetes.protobuf" + ], + "consumes": [ + "application/json-patch+json", + "application/merge-patch+json", + "application/strategic-merge-patch+json" + ] + } + ] + }, { "path": "/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status", "description": "API at /apis/apps/v1", @@ -8395,6 +8905,61 @@ } } }, + "v1.Scale": { + "id": "v1.Scale", + "description": "Scale represents a scaling request for a resource.", + "properties": { + "kind": { + "type": "string", + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" + }, + "apiVersion": { + "type": "string", + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources" + }, + "metadata": { + "$ref": "v1.ObjectMeta", + "description": "Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata." + }, + "spec": { + "$ref": "v1.ScaleSpec", + "description": "defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status." + }, + "status": { + "$ref": "v1.ScaleStatus", + "description": "current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only." + } + } + }, + "v1.ScaleSpec": { + "id": "v1.ScaleSpec", + "description": "ScaleSpec describes the attributes of a scale subresource.", + "properties": { + "replicas": { + "type": "integer", + "format": "int32", + "description": "desired number of instances for the scaled object." + } + } + }, + "v1.ScaleStatus": { + "id": "v1.ScaleStatus", + "description": "ScaleStatus represents the current status of a scale subresource.", + "required": [ + "replicas" + ], + "properties": { + "replicas": { + "type": "integer", + "format": "int32", + "description": "actual number of observed instances of the scaled object." + }, + "selector": { + "type": "string", + "description": "label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors" + } + } + }, "v1.ReplicaSetList": { "id": "v1.ReplicaSetList", "description": "ReplicaSetList is a collection of ReplicaSets.", diff --git a/docs/api-reference/apps/v1/definitions.html b/docs/api-reference/apps/v1/definitions.html index 12dafd8eb2b..069baa1351d 100755 --- a/docs/api-reference/apps/v1/definitions.html +++ b/docs/api-reference/apps/v1/definitions.html @@ -1413,6 +1413,47 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } + +
ScaleStatus represents the current status of a scale subresource.
+Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|
replicas |
+actual number of observed instances of the scaled object. |
+true |
+integer (int32) |
++ |
selector |
+label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors |
+false |
+string |
++ |
Scale represents a scaling request for a resource.
+Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. |
+false |
++ | + |
spec |
+defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. |
+false |
++ | + |
status |
+current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. |
+false |
++ | + |
ScaleSpec describes the attributes of a scale subresource.
+Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|
replicas |
+desired number of instances for the scaled object. |
+false |
+integer (int32) |
++ |
GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the Scale |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
BodyParameter |
+body |
++ | true |
++ | + |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the Scale |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
201 |
+Created |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
BodyParameter |
+body |
++ | true |
++ | + |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the Scale |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
application/json-patch+json
+application/merge-patch+json
+application/strategic-merge-patch+json
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+HTTP Code | -Description | -Schema | -
---|---|---|
200 |
-success |
-- |
/
-application/json
-application/yaml
-application/vnd.kubernetes.protobuf
-apisappsv1
-PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}-
Type | -Name | -Description | -Required | -Schema | -Default | -
---|---|---|---|---|---|
QueryParameter |
-pretty |
-If true, then the output is pretty printed. |
-false |
-string |
-- |
BodyParameter |
-body |
-- | true |
-- | - |
PathParameter |
-namespace |
-object name and auth scope, such as for teams and projects |
-true |
-string |
-- |
PathParameter |
-name |
-name of the ReplicaSet |
-true |
-string |
-- |
HTTP Code | -Description | -Schema | -
---|---|---|
200 |
-success |
-- |
application/json-patch+json
-application/merge-patch+json
-application/strategic-merge-patch+json
-application/json
-application/yaml
-application/vnd.kubernetes.protobuf
-apisappsv1
-GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status-
Type | -Name | -Description | -Required | -Schema | -Default | -
---|---|---|---|---|---|
QueryParameter |
-pretty |
-If true, then the output is pretty printed. |
-false |
-string |
-- |
PathParameter |
-namespace |
-object name and auth scope, such as for teams and projects |
-true |
-string |
-- |
PathParameter |
-name |
-name of the ReplicaSet |
-true |
-string |
-- |
HTTP Code | -Description | -Schema | -
---|---|---|
200 |
-success |
-- |
/
-application/json
-application/yaml
-application/vnd.kubernetes.protobuf
-apisappsv1
-PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status-
Type | -Name | -Description | -Required | -Schema | -Default | -
---|---|---|---|---|---|
QueryParameter |
-pretty |
-If true, then the output is pretty printed. |
-false |
-string |
-- |
BodyParameter |
-body |
-- | true |
-- | - |
PathParameter |
-namespace |
-object name and auth scope, such as for teams and projects |
-true |
-string |
-- |
PathParameter |
-name |
-name of the ReplicaSet |
-true |
-string |
-- |
200
success
201
Created
PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status+
PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
GET /apis/apps/v1/namespaces/{namespace}/statefulsets+
GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
QueryParameter
labelSelector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
false
string
QueryParameter
fieldSelector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
false
string
QueryParameter
includeUninitialized
If true, partially initialized resources are included in the response.
false
boolean
QueryParameter
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
false
boolean
QueryParameter
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
false
string
QueryParameter
timeoutSeconds
Timeout for the list/watch call.
false
integer (int32)
QueryParameter
limit
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.
false
integer (int32)
QueryParameter
continue
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 indicating the client must restart their list without the continue field. 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.
false
PathParameter
namespace
object name and auth scope, such as for teams and projects
true
string
PathParameter
namespace
object name and auth scope, such as for teams and projects
name
name of the Scale
true
string
200
success
application/vnd.kubernetes.protobuf
application/json;stream=watch
-application/vnd.kubernetes.protobuf;stream=watch
-DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets+
PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
QueryParameter
labelSelector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
false
string
BodyParameter
body
QueryParameter
fieldSelector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
false
string
QueryParameter
includeUninitialized
If true, partially initialized resources are included in the response.
false
boolean
QueryParameter
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
false
boolean
QueryParameter
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
false
string
QueryParameter
timeoutSeconds
Timeout for the list/watch call.
false
integer (int32)
QueryParameter
limit
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.
false
integer (int32)
QueryParameter
continue
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 indicating the client must restart their list without the continue field. 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.
false
string
true
string
PathParameter
name
name of the Scale
true
string
200
success
201
Created
PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
BodyParameter |
+body |
++ | true |
++ | + |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the Scale |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
application/json-patch+json
+application/merge-patch+json
+application/strategic-merge-patch+json
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
BodyParameter |
+body |
++ | true |
++ | + |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
201 |
+Created |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
BodyParameter |
+body |
++ | true |
++ | + |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the ReplicaSet |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
application/json-patch+json
+application/merge-patch+json
+application/strategic-merge-patch+json
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+GET /apis/apps/v1/namespaces/{namespace}/statefulsets+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+includeUninitialized |
+If true, partially initialized resources are included in the response. |
+false |
+boolean |
++ |
QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
++ |
QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
+false |
+string |
++ |
QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
++ |
QueryParameter |
+limit |
+limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
+false |
+integer (int32) |
++ |
QueryParameter |
+continue |
+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 indicating the client must restart their list without the continue field. 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. |
+false |
+string |
++ |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+application/json;stream=watch
+application/vnd.kubernetes.protobuf;stream=watch
+apisappsv1
+DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+includeUninitialized |
+If true, partially initialized resources are included in the response. |
+false |
+boolean |
++ |
QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
++ |
QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
+false |
+string |
++ |
QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
++ |
QueryParameter |
+limit |
+limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
+false |
+integer (int32) |
++ |
QueryParameter |
+continue |
+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 indicating the client must restart their list without the continue field. 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. |
+false |
+string |
++ |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+HTTP Code | -Description | -Schema | -
---|---|---|
200 |
-success |
-- |
/
-application/json
-application/yaml
-application/vnd.kubernetes.protobuf
-apisappsv1
-PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}-
Type | -Name | -Description | -Required | -Schema | -Default | -
---|---|---|---|---|---|
QueryParameter |
-pretty |
-If true, then the output is pretty printed. |
-false |
-string |
-- |
BodyParameter |
-body |
-- | true |
-- | - |
PathParameter |
-namespace |
-object name and auth scope, such as for teams and projects |
-true |
-string |
-- |
PathParameter |
-name |
-name of the StatefulSet |
-true |
-string |
-- |
HTTP Code | -Description | -Schema | -
---|---|---|
200 |
-success |
-- |
application/json-patch+json
-application/merge-patch+json
-application/strategic-merge-patch+json
-application/json
-application/yaml
-application/vnd.kubernetes.protobuf
-apisappsv1
-GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status-
Type | -Name | -Description | -Required | -Schema | -Default | -
---|---|---|---|---|---|
QueryParameter |
-pretty |
-If true, then the output is pretty printed. |
-false |
-string |
-- |
PathParameter |
-namespace |
-object name and auth scope, such as for teams and projects |
-true |
-string |
-- |
PathParameter |
-name |
-name of the StatefulSet |
-true |
-string |
-- |
HTTP Code | -Description | -Schema | -
---|---|---|
200 |
-success |
-- |
/
-application/json
-application/yaml
-application/vnd.kubernetes.protobuf
-apisappsv1
-PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status-
Type | -Name | -Description | -Required | -Schema | -Default | -
---|---|---|---|---|---|
QueryParameter |
-pretty |
-If true, then the output is pretty printed. |
-false |
-string |
-- |
BodyParameter |
-body |
-- | true |
-- | - |
PathParameter |
-namespace |
-object name and auth scope, such as for teams and projects |
-true |
-string |
-- |
PathParameter |
-name |
-name of the StatefulSet |
-true |
-string |
-- |
HTTP Code | -Description | -Schema | -
---|---|---|
200 |
-success |
-- |
201 |
-Created |
-- |
/
-application/json
-application/yaml
-application/vnd.kubernetes.protobuf
-apisappsv1
-PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status-
Type | -Name | -Description | -Required | -Schema | -Default | -
---|---|---|---|---|---|
QueryParameter |
-pretty |
-If true, then the output is pretty printed. |
-false |
-string |
-- |
BodyParameter |
-body |
-- | true |
-- | - |
PathParameter |
-namespace |
-object name and auth scope, such as for teams and projects |
-true |
-string |
-- |
PathParameter |
-name |
-name of the StatefulSet |
-true |
-string |
-- |
HTTP Code | -Description | -Schema | -
---|---|---|
200 |
-success |
-- |
application/json-patch+json
-application/merge-patch+json
-application/strategic-merge-patch+json
-application/json
-application/yaml
-application/vnd.kubernetes.protobuf
-apisappsv1
-GET /apis/apps/v1/replicasets-
Type | -Name | -Description | -Required | -Schema | -Default | -
---|---|---|---|---|---|
QueryParameter |
-pretty |
-If true, then the output is pretty printed. |
-false |
-string |
-- |
QueryParameter |
-labelSelector |
-A selector to restrict the list of returned objects by their labels. Defaults to everything. |
-false |
-string |
-- |
QueryParameter |
-fieldSelector |
-A selector to restrict the list of returned objects by their fields. Defaults to everything. |
-false |
-string |
-- |
QueryParameter |
-includeUninitialized |
-If true, partially initialized resources are included in the response. |
-false |
-boolean |
-- |
QueryParameter |
-watch |
-Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
-false |
-boolean |
-- |
QueryParameter |
-resourceVersion |
-When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
-false |
-string |
-- |
QueryParameter |
-timeoutSeconds |
-Timeout for the list/watch call. |
-false |
-integer (int32) |
-- |
QueryParameter |
-limit |
-limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
-false |
-integer (int32) |
-- |
QueryParameter |
-continue |
-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 indicating the client must restart their list without the continue field. 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. |
-false |
-string |
-- |
HTTP Code | -Description | -Schema | -
---|---|---|
200 |
-success |
-- |
/
-application/json
-application/yaml
-application/vnd.kubernetes.protobuf
-application/json;stream=watch
-application/vnd.kubernetes.protobuf;stream=watch
-apisappsv1
-GET /apis/apps/v1/statefulsets-
Type | -Name | -Description | -Required | -Schema | -Default | -
---|---|---|---|---|---|
QueryParameter |
-pretty |
-If true, then the output is pretty printed. |
-false |
-string |
-- |
QueryParameter |
-labelSelector |
-A selector to restrict the list of returned objects by their labels. Defaults to everything. |
-false |
-string |
-- |
QueryParameter |
-fieldSelector |
-A selector to restrict the list of returned objects by their fields. Defaults to everything. |
-false |
-string |
-- |
QueryParameter |
-includeUninitialized |
-If true, partially initialized resources are included in the response. |
-false |
-boolean |
-- |
QueryParameter |
-watch |
-Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
-false |
-boolean |
-- |
QueryParameter |
-resourceVersion |
-When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
-false |
-string |
-- |
QueryParameter |
-timeoutSeconds |
-Timeout for the list/watch call. |
-false |
-integer (int32) |
-- |
QueryParameter |
-limit |
-limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
-false |
-integer (int32) |
-- |
QueryParameter |
-continue |
-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 indicating the client must restart their list without the continue field. 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. |
-false |
-string |
-- |
200
success
application/vnd.kubernetes.protobuf
application/json;stream=watch
-application/vnd.kubernetes.protobuf;stream=watch
-GET /apis/apps/v1/watch/controllerrevisions+
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
QueryParameter
labelSelector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
false
BodyParameter
body
true
PathParameter
namespace
object name and auth scope, such as for teams and projects
true
string
QueryParameter
fieldSelector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
false
string
QueryParameter
includeUninitialized
If true, partially initialized resources are included in the response.
false
boolean
QueryParameter
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
false
boolean
QueryParameter
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
false
string
QueryParameter
timeoutSeconds
Timeout for the list/watch call.
false
integer (int32)
QueryParameter
limit
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.
false
integer (int32)
QueryParameter
continue
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 indicating the client must restart their list without the continue field. 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.
false
PathParameter
name
name of the StatefulSet
true
string
200
success
/
+application/json-patch+json
+application/merge-patch+json
+application/strategic-merge-patch+json
application/vnd.kubernetes.protobuf
application/json;stream=watch
-application/vnd.kubernetes.protobuf;stream=watch
-GET /apis/apps/v1/watch/daemonsets+
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
QueryParameter
labelSelector
A selector to restrict the list of returned objects by their labels. Defaults to everything.
false
PathParameter
namespace
object name and auth scope, such as for teams and projects
true
string
QueryParameter
fieldSelector
A selector to restrict the list of returned objects by their fields. Defaults to everything.
false
string
QueryParameter
includeUninitialized
If true, partially initialized resources are included in the response.
false
boolean
QueryParameter
watch
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
false
boolean
QueryParameter
resourceVersion
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
false
string
QueryParameter
timeoutSeconds
Timeout for the list/watch call.
false
integer (int32)
QueryParameter
limit
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.
false
integer (int32)
QueryParameter
continue
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 indicating the client must restart their list without the continue field. 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.
false
PathParameter
name
name of the Scale
true
string
200
success
application/vnd.kubernetes.protobuf
application/json;stream=watch
-application/vnd.kubernetes.protobuf;stream=watch
-GET /apis/apps/v1/watch/deployments+
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
BodyParameter
body
true
PathParameter
namespace
object name and auth scope, such as for teams and projects
true
string
PathParameter
name
name of the Scale
true
string
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
201 |
+Created |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
BodyParameter |
+body |
++ | true |
++ | + |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the Scale |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
application/json-patch+json
+application/merge-patch+json
+application/strategic-merge-patch+json
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the StatefulSet |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
BodyParameter |
+body |
++ | true |
++ | + |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the StatefulSet |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
201 |
+Created |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
BodyParameter |
+body |
++ | true |
++ | + |
PathParameter |
+namespace |
+object name and auth scope, such as for teams and projects |
+true |
+string |
++ |
PathParameter |
+name |
+name of the StatefulSet |
+true |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
application/json-patch+json
+application/merge-patch+json
+application/strategic-merge-patch+json
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+apisappsv1
+GET /apis/apps/v1/replicasets+
Type | +Name | +Description | +Required | +Schema | +Default | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
@@ -8493,7 +8949,355 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+application/json;stream=watch
+application/vnd.kubernetes.protobuf;stream=watch
+apisappsv1
+GET /apis/apps/v1/statefulsets+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+includeUninitialized |
+If true, partially initialized resources are included in the response. |
+false |
+boolean |
++ |
QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
++ |
QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
+false |
+string |
++ |
QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
++ |
QueryParameter |
+limit |
+limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
+false |
+integer (int32) |
++ |
QueryParameter |
+continue |
+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 indicating the client must restart their list without the continue field. 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. |
+false |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+application/json;stream=watch
+application/vnd.kubernetes.protobuf;stream=watch
+apisappsv1
+GET /apis/apps/v1/watch/controllerrevisions+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+includeUninitialized |
+If true, partially initialized resources are included in the response. |
+false |
+boolean |
++ |
QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
++ |
QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
+false |
+string |
++ |
QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
++ |
QueryParameter |
+limit |
+limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
+false |
+integer (int32) |
++ |
QueryParameter |
+continue |
+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 indicating the client must restart their list without the continue field. 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. |
+false |
+string |
++ |
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+includeUninitialized |
+If true, partially initialized resources are included in the response. |
+false |
+boolean |
++ |
QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
++ |
QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
+false |
+string |
++ |
QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
++ |
QueryParameter |
+limit |
+limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
+false |
+integer (int32) |
++ |
QueryParameter |
+continue |
+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 indicating the client must restart their list without the continue field. 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. |
+false |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+application/json;stream=watch
+application/vnd.kubernetes.protobuf;stream=watch
+apisappsv1
+GET /apis/apps/v1/watch/deployments+
Type | +Name | +Description | +Required | +Schema | +Default | +
---|---|---|---|---|---|
QueryParameter |
+pretty |
+If true, then the output is pretty printed. |
+false |
+string |
++ |
QueryParameter |
+labelSelector |
+A selector to restrict the list of returned objects by their labels. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+fieldSelector |
+A selector to restrict the list of returned objects by their fields. Defaults to everything. |
+false |
+string |
++ |
QueryParameter |
+includeUninitialized |
+If true, partially initialized resources are included in the response. |
+false |
+boolean |
++ |
QueryParameter |
+watch |
+Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
+false |
+boolean |
++ |
QueryParameter |
+resourceVersion |
+When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
+false |
+string |
++ |
QueryParameter |
+timeoutSeconds |
+Timeout for the list/watch call. |
+false |
+integer (int32) |
++ |
QueryParameter |
+limit |
+limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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. |
+false |
+integer (int32) |
++ |
QueryParameter |
+continue |
+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 indicating the client must restart their list without the continue field. 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. |
+false |
+string |
++ |
HTTP Code | +Description | +Schema | +
---|---|---|
200 |
+success |
++ |
/
+application/json
+application/yaml
+application/vnd.kubernetes.protobuf
+application/json;stream=watch
+application/vnd.kubernetes.protobuf;stream=watch
+