The API Groups and their versions are summarized in the following table.
Group | Versions |
---|---|
admissionregistration.k8s.io |
v1alpha1 |
apiextensions.k8s.io |
v1beta1 |
apiregistration.k8s.io |
v1beta1 |
apps |
v1beta2, v1beta1 |
authentication.k8s.io |
v1, v1beta1 |
authorization.k8s.io |
v1, v1beta1 |
autoscaling |
v1, v2beta1 |
batch |
v1, v1beta1, v2alpha1 |
certificates.k8s.io |
v1beta1 |
core |
v1 |
networking.k8s.io |
v1 |
policy |
v1beta1 |
extensions |
v1beta1 |
rbac.authorization.k8s.io |
v1, v1beta1, v1alpha1 |
scheduling.k8s.io |
v1alpha1 |
settings.k8s.io |
v1alpha1 |
storage.k8s.io |
v1, v1beta1 |
Group | Version | Kind |
---|---|---|
core |
v1 |
Container |
Warning:
Containers are only ever created within the context of a Pod. This is usually done using a Controller. See Controllers: Deployment, Job, or StatefulSet
Field | Description |
---|---|
args string array |
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
command string array |
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
env EnvVar array patch strategy: merge patch merge key: name |
List of environment variables to set in the container. Cannot be updated. |
envFrom EnvFromSource array |
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. |
image string |
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. |
imagePullPolicy string |
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
lifecycle Lifecycle |
Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
livenessProbe Probe |
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
name string |
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
ports ContainerPort array patch strategy: merge patch merge key: containerPort |
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. |
readinessProbe Probe |
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
resources ResourceRequirements |
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
securityContext SecurityContext |
Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://git.k8s.io/community/contributors/design-proposals/security_context.md |
stdin boolean |
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
stdinOnce boolean |
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
terminationMessagePath string |
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
terminationMessagePolicy string |
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
tty boolean |
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
volumeMounts VolumeMount array patch strategy: merge patch merge key: mountPath |
Pod volumes to mount into the container's filesystem. Cannot be updated. |
workingDir string |
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |
Field | Description |
---|---|
containerID string |
Container's ID in the format 'docker://<container_id>'. |
image string |
The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images |
imageID string |
ImageID of the container's image. |
lastState ContainerState |
Details about the container's last termination condition. |
name string |
This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. |
ready boolean |
Specifies whether the container has passed its readiness probe. |
restartCount integer |
The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. |
state ContainerState |
Details about the container's current condition. |
Group | Version | Kind |
---|---|---|
batch |
v1beta1 |
CronJob |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec CronJobSpec |
Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
status CronJobStatus |
Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
Field | Description |
---|---|
concurrencyPolicy string |
Specifies how to treat concurrent executions of a Job. Defaults to Allow. |
failedJobsHistoryLimit integer |
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
jobTemplate JobTemplateSpec |
Specifies the job that will be created when executing a CronJob. |
schedule string |
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. |
startingDeadlineSeconds integer |
Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. |
successfulJobsHistoryLimit integer |
The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. |
suspend boolean |
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. |
Field | Description |
---|---|
active ObjectReference array |
A list of pointers to currently running jobs. |
lastScheduleTime Time |
Information when was the last time the job was successfully scheduled. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items CronJob array |
items is the list of CronJobs. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a CronJob
POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body CronJob |
Code | Description |
---|---|
200 CronJob |
OK |
partially update the specified CronJob
PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
Parameter | Description |
---|---|
name |
name of the CronJob |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 CronJob |
OK |
replace the specified CronJob
PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
Parameter | Description |
---|---|
name |
name of the CronJob |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body CronJob |
Code | Description |
---|---|
200 CronJob |
OK |
delete a CronJob
DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
Parameter | Description |
---|---|
name |
name of the CronJob |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of CronJob
DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified CronJob
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
Parameter | Description |
---|---|
name |
name of the CronJob |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 CronJob |
OK |
list or watch objects of kind CronJob
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 CronJobList |
OK |
list or watch objects of kind CronJob
GET /apis/batch/v1beta1/cronjobs
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 CronJobList |
OK |
watch changes to an object of kind CronJob
GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs/{name}
Parameter | Description |
---|---|
name |
name of the CronJob |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of CronJob
GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of CronJob
GET /apis/batch/v1beta1/watch/cronjobs
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified CronJob
PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
Parameter | Description |
---|---|
name |
name of the CronJob |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 CronJob |
OK |
read status of the specified CronJob
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
Parameter | Description |
---|---|
name |
name of the CronJob |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 CronJob |
OK |
replace status of the specified CronJob
PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
Parameter | Description |
---|---|
name |
name of the CronJob |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body CronJob |
Code | Description |
---|---|
200 CronJob |
OK |
Group | Version | Kind |
---|---|---|
apps |
v1beta2 |
DaemonSet |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec DaemonSetSpec |
The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
status DaemonSetStatus |
The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
Field | Description |
---|---|
minReadySeconds integer |
The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). |
revisionHistoryLimit integer |
The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. |
selector LabelSelector |
A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
template PodTemplateSpec |
An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
updateStrategy DaemonSetUpdateStrategy |
An update strategy to replace existing DaemonSet pods with new pods. |
Field | Description |
---|---|
collisionCount integer |
Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. |
currentNumberScheduled integer |
The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
desiredNumberScheduled integer |
The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberAvailable integer |
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds) |
numberMisscheduled integer |
The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberReady integer |
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready. |
numberUnavailable integer |
The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds) |
observedGeneration integer |
The most recent generation observed by the daemon set controller. |
updatedNumberScheduled integer |
The total number of nodes that are running updated daemon pod |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items DaemonSet array |
A list of daemon sets. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
Field | Description |
---|---|
maxUnavailable |
The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. |
create a DaemonSet
POST /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body DaemonSet |
Code | Description |
---|---|
200 DaemonSet |
OK |
partially update the specified DaemonSet
PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
Parameter | Description |
---|---|
name |
name of the DaemonSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 DaemonSet |
OK |
replace the specified DaemonSet
PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
Parameter | Description |
---|---|
name |
name of the DaemonSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body DaemonSet |
Code | Description |
---|---|
200 DaemonSet |
OK |
delete a DaemonSet
DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
Parameter | Description |
---|---|
name |
name of the DaemonSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of DaemonSet
DELETE /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified DaemonSet
GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}
Parameter | Description |
---|---|
name |
name of the DaemonSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 DaemonSet |
OK |
list or watch objects of kind DaemonSet
GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 DaemonSetList |
OK |
list or watch objects of kind DaemonSet
GET /apis/apps/v1beta2/daemonsets
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 DaemonSetList |
OK |
watch changes to an object of kind DaemonSet
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets/{name}
Parameter | Description |
---|---|
name |
name of the DaemonSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of DaemonSet
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of DaemonSet
GET /apis/apps/v1beta2/watch/daemonsets
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified DaemonSet
PATCH /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status
Parameter | Description |
---|---|
name |
name of the DaemonSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 DaemonSet |
OK |
read status of the specified DaemonSet
GET /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status
Parameter | Description |
---|---|
name |
name of the DaemonSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 DaemonSet |
OK |
replace status of the specified DaemonSet
PUT /apis/apps/v1beta2/namespaces/{namespace}/daemonsets/{name}/status
Parameter | Description |
---|---|
name |
name of the DaemonSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body DaemonSet |
Code | Description |
---|---|
200 DaemonSet |
OK |
Group | Version | Kind |
---|---|---|
apps |
v1beta2 |
Deployment |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object metadata. |
spec DeploymentSpec |
Specification of the desired behavior of the Deployment. |
status DeploymentStatus |
Most recently observed status of the Deployment. |
Field | Description |
---|---|
minReadySeconds integer |
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) |
paused boolean |
Indicates that the deployment is paused. |
progressDeadlineSeconds integer |
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. |
replicas integer |
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
revisionHistoryLimit integer |
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. |
selector LabelSelector |
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. |
strategy DeploymentStrategy |
The deployment strategy to use to replace existing pods with new ones. |
template PodTemplateSpec |
Template describes the pods that will be created. |
Field | Description |
---|---|
availableReplicas integer |
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. |
collisionCount integer |
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet. |
conditions DeploymentCondition array patch strategy: merge patch merge key: type |
Represents the latest available observations of a deployment's current state. |
observedGeneration integer |
The generation observed by the deployment controller. |
readyReplicas integer |
Total number of ready pods targeted by this deployment. |
replicas integer |
Total number of non-terminated pods targeted by this deployment (their labels match the selector). |
unavailableReplicas integer |
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created. |
updatedReplicas integer |
Total number of non-terminated pods targeted by this deployment that have the desired template spec. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items Deployment array |
Items is the list of Deployments. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. |
Field | Description |
---|---|
rollingUpdate RollingUpdateDeployment |
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. |
type string |
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |
Field | Description |
---|---|
maxSurge |
The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods. |
maxUnavailable |
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. |
create a Deployment
POST /apis/apps/v1beta2/namespaces/{namespace}/deployments
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Deployment |
Code | Description |
---|---|
200 Deployment |
OK |
partially update the specified Deployment
PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
Parameter | Description |
---|---|
name |
name of the Deployment |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Deployment |
OK |
replace the specified Deployment
PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
Parameter | Description |
---|---|
name |
name of the Deployment |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Deployment |
Code | Description |
---|---|
200 Deployment |
OK |
delete a Deployment
DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
Parameter | Description |
---|---|
name |
name of the Deployment |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of Deployment
DELETE /apis/apps/v1beta2/namespaces/{namespace}/deployments
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified Deployment
GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}
Parameter | Description |
---|---|
name |
name of the Deployment |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Deployment |
OK |
list or watch objects of kind Deployment
GET /apis/apps/v1beta2/namespaces/{namespace}/deployments
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 DeploymentList |
OK |
list or watch objects of kind Deployment
GET /apis/apps/v1beta2/deployments
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 DeploymentList |
OK |
watch changes to an object of kind Deployment
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments/{name}
Parameter | Description |
---|---|
name |
name of the Deployment |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Deployment
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Deployment
GET /apis/apps/v1beta2/watch/deployments
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified Deployment
PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status
Parameter | Description |
---|---|
name |
name of the Deployment |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Deployment |
OK |
read status of the specified Deployment
GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status
Parameter | Description |
---|---|
name |
name of the Deployment |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Deployment |
OK |
replace status of the specified Deployment
PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/status
Parameter | Description |
---|---|
name |
name of the Deployment |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Deployment |
Code | Description |
---|---|
200 Deployment |
OK |
read scale of the specified Deployment
GET /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Scale |
OK |
replace scale of the specified Deployment
PUT /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Scale |
Code | Description |
---|---|
200 Scale |
OK |
partially update scale of the specified Deployment
PATCH /apis/apps/v1beta2/namespaces/{namespace}/deployments/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Scale |
OK |
Group | Version | Kind |
---|---|---|
batch |
v1 |
Job |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec JobSpec |
Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
status JobStatus |
Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
Field | Description |
---|---|
activeDeadlineSeconds integer |
Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer |
backoffLimit integer |
Specifies the number of retries before marking this job failed. Defaults to 6 |
completions integer |
Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
manualSelector boolean |
manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://git.k8s.io/community/contributors/design-proposals/selector-generation.md |
parallelism integer |
Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
selector LabelSelector |
A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
template PodTemplateSpec |
Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
Field | Description |
---|---|
active integer |
The number of actively running pods. |
completionTime Time |
Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. |
conditions JobCondition array patch strategy: merge patch merge key: type |
The latest available observations of an object's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
failed integer |
The number of pods which reached phase Failed. |
startTime Time |
Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. |
succeeded integer |
The number of pods which reached phase Succeeded. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items Job array |
items is the list of Jobs. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a Job
POST /apis/batch/v1/namespaces/{namespace}/jobs
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Job |
Code | Description |
---|---|
200 Job |
OK |
partially update the specified Job
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameter | Description |
---|---|
name |
name of the Job |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Job |
OK |
replace the specified Job
PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameter | Description |
---|---|
name |
name of the Job |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Job |
Code | Description |
---|---|
200 Job |
OK |
delete a Job
DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameter | Description |
---|---|
name |
name of the Job |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of Job
DELETE /apis/batch/v1/namespaces/{namespace}/jobs
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified Job
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Parameter | Description |
---|---|
name |
name of the Job |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Job |
OK |
list or watch objects of kind Job
GET /apis/batch/v1/namespaces/{namespace}/jobs
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 JobList |
OK |
list or watch objects of kind Job
GET /apis/batch/v1/jobs
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 JobList |
OK |
watch changes to an object of kind Job
GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
Parameter | Description |
---|---|
name |
name of the Job |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Job
GET /apis/batch/v1/watch/namespaces/{namespace}/jobs
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Job
GET /apis/batch/v1/watch/jobs
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified Job
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
Parameter | Description |
---|---|
name |
name of the Job |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Job |
OK |
read status of the specified Job
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
Parameter | Description |
---|---|
name |
name of the Job |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Job |
OK |
replace status of the specified Job
PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
Parameter | Description |
---|---|
name |
name of the Job |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Job |
Code | Description |
---|---|
200 Job |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
Pod |
Warning:
It is recommended that users create Pods only through a Controller, and not directly. See Controllers: Deployment, Job, or StatefulSet.
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec PodSpec |
Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
status PodStatus |
Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
Field | Description |
---|---|
activeDeadlineSeconds integer |
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
affinity Affinity |
If specified, the pod's scheduling constraints |
automountServiceAccountToken boolean |
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. |
containers Container array patch strategy: merge patch merge key: name |
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. |
dnsPolicy string |
Set DNS policy for containers within the pod. One of 'ClusterFirstWithHostNet', 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst". To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. |
hostAliases HostAlias array patch strategy: merge patch merge key: ip |
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. |
hostIPC boolean |
Use the host's ipc namespace. Optional: Default to false. |
hostNetwork boolean |
Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. |
hostPID boolean |
Use the host's pid namespace. Optional: Default to false. |
hostname string |
Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. |
imagePullSecrets LocalObjectReference array patch strategy: merge patch merge key: name |
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
initContainers Container array patch strategy: merge patch merge key: name |
List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
nodeName string |
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. |
nodeSelector object |
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
priority integer |
The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. |
priorityClassName string |
If specified, indicates the pod's priority. "SYSTEM" is a special keyword which indicates the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. |
restartPolicy string |
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy |
schedulerName string |
If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. |
securityContext PodSecurityContext |
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
serviceAccount string |
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. |
serviceAccountName string |
ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
subdomain string |
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. |
terminationGracePeriodSeconds integer |
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
tolerations Toleration array |
If specified, the pod's tolerations. |
volumes Volume array patch strategy: merge,retainKeys patch merge key: name |
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes |
Field | Description |
---|---|
conditions PodCondition array patch strategy: merge patch merge key: type |
Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
containerStatuses ContainerStatus array |
The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
hostIP string |
IP address of the host to which the pod is assigned. Empty if not yet scheduled. |
initContainerStatuses ContainerStatus array |
The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
message string |
A human readable message indicating details about why the pod is in this condition. |
phase string |
Current condition of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase |
podIP string |
IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. |
qosClass string |
The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://github.com/kubernetes/kubernetes/blob/master/docs/design/resource-qos.md |
reason string |
A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted' |
startTime Time |
RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items Pod array |
List of pods. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a Pod
POST /api/v1/namespaces/{namespace}/pods
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Pod |
Code | Description |
---|---|
200 Pod |
OK |
create eviction of a Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
Parameter | Description |
---|---|
name |
name of the Eviction |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Eviction |
Code | Description |
---|---|
200 Eviction |
OK |
partially update the specified Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Pod |
OK |
replace the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Pod |
Code | Description |
---|---|
200 Pod |
OK |
delete a Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of Pod
DELETE /api/v1/namespaces/{namespace}/pods
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Pod |
OK |
list or watch objects of kind Pod
GET /api/v1/namespaces/{namespace}/pods
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 PodList |
OK |
list or watch objects of kind Pod
GET /api/v1/pods
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 PodList |
OK |
watch changes to an object of kind Pod
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Pod
GET /api/v1/watch/namespaces/{namespace}/pods
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Pod
GET /api/v1/watch/pods
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Pod |
OK |
read status of the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/status
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Pod |
OK |
replace status of the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Pod |
Code | Description |
---|---|
200 Pod |
OK |
connect POST requests to portforward of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
ports |
List of ports to forward Required when using WebSockets |
Code | Description |
---|---|
200 string |
OK |
connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Code | Description |
---|---|
200 string |
OK |
proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Code | Description |
---|---|
200 string |
OK |
connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Code | Description |
---|---|
200 string |
OK |
proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Code | Description |
---|---|
200 string |
OK |
connect GET requests to portforward of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
ports |
List of ports to forward Required when using WebSockets |
Code | Description |
---|---|
200 string |
OK |
connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Code | Description |
---|---|
200 string |
OK |
proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Code | Description |
---|---|
200 string |
OK |
connect HEAD requests to proxy of Pod
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
connect HEAD requests to proxy of Pod
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the URL path to use for the current proxy request to pod. |
Code | Description |
---|---|
200 string |
OK |
proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Code | Description |
---|---|
200 string |
OK |
proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Code | Description |
---|---|
200 string |
OK |
read log of the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/log
Parameter | Description |
---|---|
name |
name of the Pod |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
container |
The container for which to stream logs. Defaults to only container if there is one container in the pod. |
follow |
Follow the log stream of the pod. Defaults to false. |
limitBytes |
If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. |
pretty |
If 'true', then the output is pretty printed. |
previous |
Return previous terminated container logs. Defaults to false. |
sinceSeconds |
A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. |
tailLines |
If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime |
timestamps |
If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. |
Code | Description |
---|---|
200 string |
OK |
Group | Version | Kind |
---|---|---|
apps |
v1beta2 |
ReplicaSet |
Warning:
In many cases it is recommended to create a Deployment instead of ReplicaSet.
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec ReplicaSetSpec |
Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
status ReplicaSetStatus |
Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
Field | Description |
---|---|
minReadySeconds integer |
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) |
replicas integer |
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
selector LabelSelector |
Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
template PodTemplateSpec |
Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
Field | Description |
---|---|
availableReplicas integer |
The number of available replicas (ready for at least minReadySeconds) for this replica set. |
conditions ReplicaSetCondition array patch strategy: merge patch merge key: type |
Represents the latest available observations of a replica set's current state. |
fullyLabeledReplicas integer |
The number of pods that have labels matching the labels of the pod template of the replicaset. |
observedGeneration integer |
ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
readyReplicas integer |
The number of ready replicas for this replica set. |
replicas integer |
Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items ReplicaSet array |
List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a ReplicaSet
POST /apis/apps/v1beta2/namespaces/{namespace}/replicasets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ReplicaSet |
Code | Description |
---|---|
200 ReplicaSet |
OK |
partially update the specified ReplicaSet
PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
Parameter | Description |
---|---|
name |
name of the ReplicaSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 ReplicaSet |
OK |
replace the specified ReplicaSet
PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
Parameter | Description |
---|---|
name |
name of the ReplicaSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ReplicaSet |
Code | Description |
---|---|
200 ReplicaSet |
OK |
delete a ReplicaSet
DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
Parameter | Description |
---|---|
name |
name of the ReplicaSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of ReplicaSet
DELETE /apis/apps/v1beta2/namespaces/{namespace}/replicasets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified ReplicaSet
GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}
Parameter | Description |
---|---|
name |
name of the ReplicaSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 ReplicaSet |
OK |
list or watch objects of kind ReplicaSet
GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ReplicaSetList |
OK |
list or watch objects of kind ReplicaSet
GET /apis/apps/v1beta2/replicasets
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ReplicaSetList |
OK |
watch changes to an object of kind ReplicaSet
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets/{name}
Parameter | Description |
---|---|
name |
name of the ReplicaSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of ReplicaSet
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of ReplicaSet
GET /apis/apps/v1beta2/watch/replicasets
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified ReplicaSet
PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
Parameter | Description |
---|---|
name |
name of the ReplicaSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 ReplicaSet |
OK |
read status of the specified ReplicaSet
GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
Parameter | Description |
---|---|
name |
name of the ReplicaSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 ReplicaSet |
OK |
replace status of the specified ReplicaSet
PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/status
Parameter | Description |
---|---|
name |
name of the ReplicaSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ReplicaSet |
Code | Description |
---|---|
200 ReplicaSet |
OK |
read scale of the specified ReplicaSet
GET /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Scale |
OK |
replace scale of the specified ReplicaSet
PUT /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Scale |
Code | Description |
---|---|
200 Scale |
OK |
partially update scale of the specified ReplicaSet
PATCH /apis/apps/v1beta2/namespaces/{namespace}/replicasets/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Scale |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
ReplicationController |
Warning:
In many cases it is recommended to create a Deployment instead of a ReplicationController.
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec ReplicationControllerSpec |
Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
status ReplicationControllerStatus |
Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
Field | Description |
---|---|
minReadySeconds integer |
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) |
replicas integer |
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller |
selector object |
Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
template PodTemplateSpec |
Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
Field | Description |
---|---|
availableReplicas integer |
The number of available replicas (ready for at least minReadySeconds) for this replication controller. |
conditions ReplicationControllerCondition array patch strategy: merge patch merge key: type |
Represents the latest available observations of a replication controller's current state. |
fullyLabeledReplicas integer |
The number of pods that have labels matching the labels of the pod template of the replication controller. |
observedGeneration integer |
ObservedGeneration reflects the generation of the most recently observed replication controller. |
readyReplicas integer |
The number of ready replicas for this replication controller. |
replicas integer |
Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items ReplicationController array |
List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a ReplicationController
POST /api/v1/namespaces/{namespace}/replicationcontrollers
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ReplicationController |
Code | Description |
---|---|
200 ReplicationController |
OK |
partially update the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | Description |
---|---|
name |
name of the ReplicationController |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 ReplicationController |
OK |
replace the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | Description |
---|---|
name |
name of the ReplicationController |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ReplicationController |
Code | Description |
---|---|
200 ReplicationController |
OK |
delete a ReplicationController
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | Description |
---|---|
name |
name of the ReplicationController |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of ReplicationController
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | Description |
---|---|
name |
name of the ReplicationController |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 ReplicationController |
OK |
list or watch objects of kind ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ReplicationControllerList |
OK |
list or watch objects of kind ReplicationController
GET /api/v1/replicationcontrollers
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ReplicationControllerList |
OK |
watch changes to an object of kind ReplicationController
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
Parameter | Description |
---|---|
name |
name of the ReplicationController |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of ReplicationController
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of ReplicationController
GET /api/v1/watch/replicationcontrollers
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Parameter | Description |
---|---|
name |
name of the ReplicationController |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 ReplicationController |
OK |
read status of the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Parameter | Description |
---|---|
name |
name of the ReplicationController |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 ReplicationController |
OK |
replace status of the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Parameter | Description |
---|---|
name |
name of the ReplicationController |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ReplicationController |
Code | Description |
---|---|
200 ReplicationController |
OK |
read scale of the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Scale |
OK |
replace scale of the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Scale |
Code | Description |
---|---|
200 Scale |
OK |
partially update scale of the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Scale |
OK |
Group | Version | Kind |
---|---|---|
apps |
v1beta2 |
StatefulSet |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
|
spec StatefulSetSpec |
Spec defines the desired identities of pods in this set. |
status StatefulSetStatus |
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. |
Field | Description |
---|---|
podManagementPolicy string |
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. |
replicas integer |
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. |
revisionHistoryLimit integer |
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. |
selector LabelSelector |
selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
serviceName string |
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. |
template PodTemplateSpec |
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. |
updateStrategy StatefulSetUpdateStrategy |
updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. |
volumeClaimTemplates PersistentVolumeClaim array |
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. |
Field | Description |
---|---|
collisionCount integer |
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. |
currentReplicas integer |
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision. |
currentRevision string |
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas). |
observedGeneration integer |
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server. |
readyReplicas integer |
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition. |
replicas integer |
replicas is the number of Pods created by the StatefulSet controller. |
updateRevision string |
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas) |
updatedReplicas integer |
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items StatefulSet array |
|
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
create a StatefulSet
POST /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body StatefulSet |
Code | Description |
---|---|
200 StatefulSet |
OK |
partially update the specified StatefulSet
PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
Parameter | Description |
---|---|
name |
name of the StatefulSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 StatefulSet |
OK |
replace the specified StatefulSet
PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
Parameter | Description |
---|---|
name |
name of the StatefulSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body StatefulSet |
Code | Description |
---|---|
200 StatefulSet |
OK |
delete a StatefulSet
DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
Parameter | Description |
---|---|
name |
name of the StatefulSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of StatefulSet
DELETE /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified StatefulSet
GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}
Parameter | Description |
---|---|
name |
name of the StatefulSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 StatefulSet |
OK |
list or watch objects of kind StatefulSet
GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 StatefulSetList |
OK |
list or watch objects of kind StatefulSet
GET /apis/apps/v1beta2/statefulsets
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 StatefulSetList |
OK |
watch changes to an object of kind StatefulSet
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets/{name}
Parameter | Description |
---|---|
name |
name of the StatefulSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of StatefulSet
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of StatefulSet
GET /apis/apps/v1beta2/watch/statefulsets
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified StatefulSet
PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
Parameter | Description |
---|---|
name |
name of the StatefulSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 StatefulSet |
OK |
read status of the specified StatefulSet
GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
Parameter | Description |
---|---|
name |
name of the StatefulSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 StatefulSet |
OK |
replace status of the specified StatefulSet
PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/status
Parameter | Description |
---|---|
name |
name of the StatefulSet |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body StatefulSet |
Code | Description |
---|---|
200 StatefulSet |
OK |
read scale of the specified StatefulSet
GET /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Scale |
OK |
replace scale of the specified StatefulSet
PUT /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Scale |
Code | Description |
---|---|
200 Scale |
OK |
partially update scale of the specified StatefulSet
PATCH /apis/apps/v1beta2/namespaces/{namespace}/statefulsets/{name}/scale
Parameter | Description |
---|---|
name |
name of the Scale |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Scale |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
Endpoints |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
subsets EndpointSubset array |
The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items Endpoints array |
List of endpoints. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create Endpoints
POST /api/v1/namespaces/{namespace}/endpoints
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Endpoints |
Code | Description |
---|---|
200 Endpoints |
OK |
partially update the specified Endpoints
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
Parameter | Description |
---|---|
name |
name of the Endpoints |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Endpoints |
OK |
replace the specified Endpoints
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
Parameter | Description |
---|---|
name |
name of the Endpoints |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Endpoints |
Code | Description |
---|---|
200 Endpoints |
OK |
delete Endpoints
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
Parameter | Description |
---|---|
name |
name of the Endpoints |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of Endpoints
DELETE /api/v1/namespaces/{namespace}/endpoints
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified Endpoints
GET /api/v1/namespaces/{namespace}/endpoints/{name}
Parameter | Description |
---|---|
name |
name of the Endpoints |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Endpoints |
OK |
list or watch objects of kind Endpoints
GET /api/v1/namespaces/{namespace}/endpoints
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 EndpointsList |
OK |
list or watch objects of kind Endpoints
GET /api/v1/endpoints
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 EndpointsList |
OK |
watch changes to an object of kind Endpoints
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
Parameter | Description |
---|---|
name |
name of the Endpoints |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Endpoints
GET /api/v1/watch/namespaces/{namespace}/endpoints
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Endpoints
GET /api/v1/watch/endpoints
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
Group | Version | Kind |
---|---|---|
extensions |
v1beta1 |
Ingress |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec IngressSpec |
Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
status IngressStatus |
Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
Field | Description |
---|---|
backend IngressBackend |
A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. |
rules IngressRule array |
A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. |
tls IngressTLS array |
TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. |
Field | Description |
---|---|
loadBalancer LoadBalancerStatus |
LoadBalancer contains the current status of the load-balancer. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items Ingress array |
Items is the list of Ingress. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create an Ingress
POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Ingress |
Code | Description |
---|---|
200 Ingress |
OK |
partially update the specified Ingress
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
Parameter | Description |
---|---|
name |
name of the Ingress |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Ingress |
OK |
replace the specified Ingress
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
Parameter | Description |
---|---|
name |
name of the Ingress |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Ingress |
Code | Description |
---|---|
200 Ingress |
OK |
delete an Ingress
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
Parameter | Description |
---|---|
name |
name of the Ingress |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of Ingress
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified Ingress
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
Parameter | Description |
---|---|
name |
name of the Ingress |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Ingress |
OK |
list or watch objects of kind Ingress
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 IngressList |
OK |
list or watch objects of kind Ingress
GET /apis/extensions/v1beta1/ingresses
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 IngressList |
OK |
watch changes to an object of kind Ingress
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
Parameter | Description |
---|---|
name |
name of the Ingress |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Ingress
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Ingress
GET /apis/extensions/v1beta1/watch/ingresses
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified Ingress
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
Parameter | Description |
---|---|
name |
name of the Ingress |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Ingress |
OK |
read status of the specified Ingress
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
Parameter | Description |
---|---|
name |
name of the Ingress |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Ingress |
OK |
replace status of the specified Ingress
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
Parameter | Description |
---|---|
name |
name of the Ingress |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Ingress |
Code | Description |
---|---|
200 Ingress |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
Service |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec ServiceSpec |
Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
status ServiceStatus |
Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
Field | Description |
---|---|
clusterIP string |
clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
externalIPs string array |
externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. |
externalName string |
externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName. |
externalTrafficPolicy string |
externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. |
healthCheckNodePort integer |
healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local. |
loadBalancerIP string |
Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. |
loadBalancerSourceRanges string array |
If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ |
ports ServicePort array patch strategy: merge patch merge key: port |
The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
publishNotReadyAddresses boolean |
publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery. This field will replace the service.alpha.kubernetes.io/tolerate-unready-endpoints when that annotation is deprecated and all clients have been converted to use this field. |
selector object |
Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ |
sessionAffinity string |
Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
sessionAffinityConfig SessionAffinityConfig |
sessionAffinityConfig contains the configurations of session affinity. |
type string |
type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services---service-types |
Field | Description |
---|---|
loadBalancer LoadBalancerStatus |
LoadBalancer contains the current status of the load-balancer, if one is present. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items Service array |
List of services |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a Service
POST /api/v1/namespaces/{namespace}/services
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Service |
Code | Description |
---|---|
200 Service |
OK |
partially update the specified Service
PATCH /api/v1/namespaces/{namespace}/services/{name}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Service |
OK |
replace the specified Service
PUT /api/v1/namespaces/{namespace}/services/{name}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Service |
Code | Description |
---|---|
200 Service |
OK |
delete a Service
DELETE /api/v1/namespaces/{namespace}/services/{name}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Status |
OK |
read the specified Service
GET /api/v1/namespaces/{namespace}/services/{name}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Service |
OK |
list or watch objects of kind Service
GET /api/v1/namespaces/{namespace}/services
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ServiceList |
OK |
list or watch objects of kind Service
GET /api/v1/services
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ServiceList |
OK |
watch changes to an object of kind Service
GET /api/v1/watch/namespaces/{namespace}/services/{name}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Service
GET /api/v1/watch/namespaces/{namespace}/services
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Service
GET /api/v1/watch/services
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified Service
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Service |
OK |
read status of the specified Service
GET /api/v1/namespaces/{namespace}/services/{name}/status
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Service |
OK |
replace status of the specified Service
PUT /api/v1/namespaces/{namespace}/services/{name}/status
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Service |
Code | Description |
---|---|
200 Service |
OK |
connect POST requests to proxy of Service
POST /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
connect POST requests to proxy of Service
POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Code | Description |
---|---|
200 string |
OK |
proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Code | Description |
---|---|
200 string |
OK |
connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Code | Description |
---|---|
200 string |
OK |
proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Code | Description |
---|---|
200 string |
OK |
connect GET requests to proxy of Service
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
connect GET requests to proxy of Service
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Code | Description |
---|---|
200 string |
OK |
proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Code | Description |
---|---|
200 string |
OK |
connect HEAD requests to proxy of Service
HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
connect HEAD requests to proxy of Service
HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
connect PUT requests to proxy of Service
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
connect PUT requests to proxy of Service
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Parameter | Description |
---|---|
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
Code | Description |
---|---|
200 string |
OK |
proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Code | Description |
---|---|
200 string |
OK |
proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
Code | Description |
---|---|
200 string |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
ConfigMap |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
data object |
Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items ConfigMap array |
Items is the list of ConfigMaps. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a ConfigMap
POST /api/v1/namespaces/{namespace}/configmaps
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ConfigMap |
Code | Description |
---|---|
200 ConfigMap |
OK |
partially update the specified ConfigMap
PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
Parameter | Description |
---|---|
name |
name of the ConfigMap |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 ConfigMap |
OK |
replace the specified ConfigMap
PUT /api/v1/namespaces/{namespace}/configmaps/{name}
Parameter | Description |
---|---|
name |
name of the ConfigMap |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ConfigMap |
Code | Description |
---|---|
200 ConfigMap |
OK |
delete a ConfigMap
DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
Parameter | Description |
---|---|
name |
name of the ConfigMap |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of ConfigMap
DELETE /api/v1/namespaces/{namespace}/configmaps
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified ConfigMap
GET /api/v1/namespaces/{namespace}/configmaps/{name}
Parameter | Description |
---|---|
name |
name of the ConfigMap |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 ConfigMap |
OK |
list or watch objects of kind ConfigMap
GET /api/v1/namespaces/{namespace}/configmaps
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ConfigMapList |
OK |
list or watch objects of kind ConfigMap
GET /api/v1/configmaps
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ConfigMapList |
OK |
watch changes to an object of kind ConfigMap
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
Parameter | Description |
---|---|
name |
name of the ConfigMap |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of ConfigMap
GET /api/v1/watch/namespaces/{namespace}/configmaps
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of ConfigMap
GET /api/v1/watch/configmaps
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
Secret |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
data object |
Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
stringData object |
stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API. |
type string |
Used to facilitate programmatic handling of secret data. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items Secret array |
Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a Secret
POST /api/v1/namespaces/{namespace}/secrets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Secret |
Code | Description |
---|---|
200 Secret |
OK |
partially update the specified Secret
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
Parameter | Description |
---|---|
name |
name of the Secret |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Secret |
OK |
replace the specified Secret
PUT /api/v1/namespaces/{namespace}/secrets/{name}
Parameter | Description |
---|---|
name |
name of the Secret |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Secret |
Code | Description |
---|---|
200 Secret |
OK |
delete a Secret
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
Parameter | Description |
---|---|
name |
name of the Secret |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of Secret
DELETE /api/v1/namespaces/{namespace}/secrets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified Secret
GET /api/v1/namespaces/{namespace}/secrets/{name}
Parameter | Description |
---|---|
name |
name of the Secret |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Secret |
OK |
list or watch objects of kind Secret
GET /api/v1/namespaces/{namespace}/secrets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 SecretList |
OK |
list or watch objects of kind Secret
GET /api/v1/secrets
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 SecretList |
OK |
watch changes to an object of kind Secret
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
Parameter | Description |
---|---|
name |
name of the Secret |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Secret
GET /api/v1/watch/namespaces/{namespace}/secrets
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Secret
GET /api/v1/watch/secrets
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
PersistentVolumeClaim |
A PersistentVolume must be allocated in the cluster to use this.
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec PersistentVolumeClaimSpec |
Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
status PersistentVolumeClaimStatus |
Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
Field | Description |
---|---|
accessModes string array |
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
resources ResourceRequirements |
Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
selector LabelSelector |
A label query over volumes to consider for binding. |
storageClassName string |
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
volumeName string |
VolumeName is the binding reference to the PersistentVolume backing this claim. |
Field | Description |
---|---|
accessModes string array |
AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
capacity object |
Represents the actual resources of the underlying volume. |
conditions PersistentVolumeClaimCondition array patch strategy: merge patch merge key: type |
Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. |
phase string |
Phase represents the current phase of PersistentVolumeClaim. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items PersistentVolumeClaim array |
A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a PersistentVolumeClaim
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body PersistentVolumeClaim |
Code | Description |
---|---|
200 PersistentVolumeClaim |
OK |
partially update the specified PersistentVolumeClaim
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | Description |
---|---|
name |
name of the PersistentVolumeClaim |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 PersistentVolumeClaim |
OK |
replace the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | Description |
---|---|
name |
name of the PersistentVolumeClaim |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body PersistentVolumeClaim |
Code | Description |
---|---|
200 PersistentVolumeClaim |
OK |
delete a PersistentVolumeClaim
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | Description |
---|---|
name |
name of the PersistentVolumeClaim |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of PersistentVolumeClaim
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | Description |
---|---|
name |
name of the PersistentVolumeClaim |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 PersistentVolumeClaim |
OK |
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 PersistentVolumeClaimList |
OK |
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/persistentvolumeclaims
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 PersistentVolumeClaimList |
OK |
watch changes to an object of kind PersistentVolumeClaim
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameter | Description |
---|---|
name |
name of the PersistentVolumeClaim |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of PersistentVolumeClaim
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of PersistentVolumeClaim
GET /api/v1/watch/persistentvolumeclaims
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
partially update status of the specified PersistentVolumeClaim
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameter | Description |
---|---|
name |
name of the PersistentVolumeClaim |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 PersistentVolumeClaim |
OK |
read status of the specified PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameter | Description |
---|---|
name |
name of the PersistentVolumeClaim |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 PersistentVolumeClaim |
OK |
replace status of the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameter | Description |
---|---|
name |
name of the PersistentVolumeClaim |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body PersistentVolumeClaim |
Code | Description |
---|---|
200 PersistentVolumeClaim |
OK |
Group | Version | Kind |
---|---|---|
storage.k8s.io |
v1 |
StorageClass |
Field | Description |
---|---|
allowVolumeExpansion boolean |
AllowVolumeExpansion shows whether the storage class allow volume expand |
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
mountOptions string array |
Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. |
parameters object |
Parameters holds the parameters for the provisioner that should create volumes of this storage class. |
provisioner string |
Provisioner indicates the type of the provisioner. |
reclaimPolicy string |
Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items StorageClass array |
Items is the list of StorageClasses |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a StorageClass
POST /apis/storage.k8s.io/v1/storageclasses
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body StorageClass |
Code | Description |
---|---|
200 StorageClass |
OK |
partially update the specified StorageClass
PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
Parameter | Description |
---|---|
name |
name of the StorageClass |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 StorageClass |
OK |
replace the specified StorageClass
PUT /apis/storage.k8s.io/v1/storageclasses/{name}
Parameter | Description |
---|---|
name |
name of the StorageClass |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body StorageClass |
Code | Description |
---|---|
200 StorageClass |
OK |
delete a StorageClass
DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
Parameter | Description |
---|---|
name |
name of the StorageClass |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of StorageClass
DELETE /apis/storage.k8s.io/v1/storageclasses
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified StorageClass
GET /apis/storage.k8s.io/v1/storageclasses/{name}
Parameter | Description |
---|---|
name |
name of the StorageClass |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 StorageClass |
OK |
list or watch objects of kind StorageClass
GET /apis/storage.k8s.io/v1/storageclasses
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 StorageClassList |
OK |
watch changes to an object of kind StorageClass
GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}
Parameter | Description |
---|---|
name |
name of the StorageClass |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of StorageClass
GET /apis/storage.k8s.io/v1/watch/storageclasses
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
Volume |
Field | Description |
---|---|
awsElasticBlockStore AWSElasticBlockStoreVolumeSource |
AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
azureDisk AzureDiskVolumeSource |
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
azureFile AzureFileVolumeSource |
AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
cephfs CephFSVolumeSource |
CephFS represents a Ceph FS mount on the host that shares a pod's lifetime |
cinder CinderVolumeSource |
Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
configMap ConfigMapVolumeSource |
ConfigMap represents a configMap that should populate this volume |
downwardAPI DownwardAPIVolumeSource |
DownwardAPI represents downward API about the pod that should populate this volume |
emptyDir EmptyDirVolumeSource |
EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
fc FCVolumeSource |
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. |
flexVolume FlexVolumeSource |
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future. |
flocker FlockerVolumeSource |
Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running |
gcePersistentDisk GCEPersistentDiskVolumeSource |
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
gitRepo GitRepoVolumeSource |
GitRepo represents a git repository at a particular revision. |
glusterfs GlusterfsVolumeSource |
Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md |
hostPath HostPathVolumeSource |
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
iscsi ISCSIVolumeSource |
ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md |
name string |
Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
nfs NFSVolumeSource |
NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
persistentVolumeClaim PersistentVolumeClaimVolumeSource |
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
photonPersistentDisk PhotonPersistentDiskVolumeSource |
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
portworxVolume PortworxVolumeSource |
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
projected ProjectedVolumeSource |
Items for all in one resources secrets, configmaps, and downward API |
quobyte QuobyteVolumeSource |
Quobyte represents a Quobyte mount on the host that shares a pod's lifetime |
rbd RBDVolumeSource |
RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md |
scaleIO ScaleIOVolumeSource |
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
secret SecretVolumeSource |
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
storageos StorageOSVolumeSource |
StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. |
vsphereVolume VsphereVirtualDiskVolumeSource |
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
Group | Version | Kind |
---|---|---|
apps |
v1beta2 |
ControllerRevision |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
data |
Data is the serialized representation of the state. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
revision integer |
Revision indicates the revision of the state represented by Data. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items ControllerRevision array |
Items is the list of ControllerRevisions |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
create a ControllerRevision
POST /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ControllerRevision |
Code | Description |
---|---|
200 ControllerRevision |
OK |
partially update the specified ControllerRevision
PATCH /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
Parameter | Description |
---|---|
name |
name of the ControllerRevision |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 ControllerRevision |
OK |
replace the specified ControllerRevision
PUT /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
Parameter | Description |
---|---|
name |
name of the ControllerRevision |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body ControllerRevision |
Code | Description |
---|---|
200 ControllerRevision |
OK |
delete a ControllerRevision
DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
Parameter | Description |
---|---|
name |
name of the ControllerRevision |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of ControllerRevision
DELETE /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified ControllerRevision
GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions/{name}
Parameter | Description |
---|---|
name |
name of the ControllerRevision |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 ControllerRevision |
OK |
list or watch objects of kind ControllerRevision
GET /apis/apps/v1beta2/namespaces/{namespace}/controllerrevisions
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ControllerRevisionList |
OK |
list or watch objects of kind ControllerRevision
GET /apis/apps/v1beta2/controllerrevisions
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 ControllerRevisionList |
OK |
watch changes to an object of kind ControllerRevision
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions/{name}
Parameter | Description |
---|---|
name |
name of the ControllerRevision |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of ControllerRevision
GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of ControllerRevision
GET /apis/apps/v1beta2/watch/controllerrevisions
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
Group | Version | Kind |
---|---|---|
apiextensions.k8s.io |
v1beta1 |
CustomResourceDefinition |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
|
spec CustomResourceDefinitionSpec |
Spec describes how the user wants the resources to appear |
status CustomResourceDefinitionStatus |
Status indicates the actual state of the CustomResourceDefinition |
Field | Description |
---|---|
group string |
Group is the group this resource belongs in |
names CustomResourceDefinitionNames |
Names are the names used to describe this custom resource |
scope string |
Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced |
validation CustomResourceValidation |
Validation describes the validation methods for CustomResources This field is alpha-level and should only be sent to servers that enable the CustomResourceValidation feature. |
version string |
Version is the version this resource belongs in |
Field | Description |
---|---|
acceptedNames CustomResourceDefinitionNames |
AcceptedNames are the names that are actually being used to serve discovery They may be different than the names in spec. |
conditions CustomResourceDefinitionCondition array |
Conditions indicate state for particular aspects of a CustomResourceDefinition |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items CustomResourceDefinition array |
Items individual CustomResourceDefinitions |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
create a CustomResourceDefinition
POST /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body CustomResourceDefinition |
Code | Description |
---|---|
200 CustomResourceDefinition |
OK |
partially update the specified CustomResourceDefinition
PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
Parameter | Description |
---|---|
name |
name of the CustomResourceDefinition |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 CustomResourceDefinition |
OK |
replace the specified CustomResourceDefinition
PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
Parameter | Description |
---|---|
name |
name of the CustomResourceDefinition |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body CustomResourceDefinition |
Code | Description |
---|---|
200 CustomResourceDefinition |
OK |
delete a CustomResourceDefinition
DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
Parameter | Description |
---|---|
name |
name of the CustomResourceDefinition |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of CustomResourceDefinition
DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
Parameter | Description |
---|---|
name |
name of the CustomResourceDefinition |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 CustomResourceDefinition |
OK |
list or watch objects of kind CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 CustomResourceDefinitionList |
OK |
watch changes to an object of kind CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name}
Parameter | Description |
---|---|
name |
name of the CustomResourceDefinition |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
replace status of the specified CustomResourceDefinition
PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
Parameter | Description |
---|---|
name |
name of the CustomResourceDefinition |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body CustomResourceDefinition |
Code | Description |
---|---|
200 CustomResourceDefinition |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
Event |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
count integer |
The number of times this event has occurred. |
firstTimestamp Time |
The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
involvedObject ObjectReference |
The object that this event is about. |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
lastTimestamp Time |
The time at which the most recent occurrence of this event was recorded. |
message string |
A human-readable description of the status of this operation. |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
reason string |
This should be a short, machine understandable string that gives the reason for the transition into the object's current status. |
source EventSource |
The component reporting this event. Should be a short machine understandable string. |
type string |
Type of this event (Normal, Warning), new types could be added in the future |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items Event array |
List of events |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create an Event
POST /api/v1/namespaces/{namespace}/events
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Event |
Code | Description |
---|---|
200 Event |
OK |
partially update the specified Event
PATCH /api/v1/namespaces/{namespace}/events/{name}
Parameter | Description |
---|---|
name |
name of the Event |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Patch |
Code | Description |
---|---|
200 Event |
OK |
replace the specified Event
PUT /api/v1/namespaces/{namespace}/events/{name}
Parameter | Description |
---|---|
name |
name of the Event |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
Parameter | Description |
---|---|
body Event |
Code | Description |
---|---|
200 Event |
OK |
delete an Event
DELETE /api/v1/namespaces/{namespace}/events/{name}
Parameter | Description |
---|---|
name |
name of the Event |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
gracePeriodSeconds |
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 |
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. |
pretty |
If 'true', then the output is pretty printed. |
propagationPolicy |
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. |
Parameter | Description |
---|---|
body DeleteOptions |
Code | Description |
---|---|
200 Status |
OK |
delete collection of Event
DELETE /api/v1/namespaces/{namespace}/events
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 Status |
OK |
read the specified Event
GET /api/v1/namespaces/{namespace}/events/{name}
Parameter | Description |
---|---|
name |
name of the Event |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
export |
Should this value be exported. Export strips fields that a user can not specify. |
pretty |
If 'true', then the output is pretty printed. |
Code | Description |
---|---|
200 Event |
OK |
list or watch objects of kind Event
GET /api/v1/namespaces/{namespace}/events
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 EventList |
OK |
list or watch objects of kind Event
GET /api/v1/events
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 EventList |
OK |
watch changes to an object of kind Event
GET /api/v1/watch/namespaces/{namespace}/events/{name}
Parameter | Description |
---|---|
name |
name of the Event |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Event
GET /api/v1/watch/namespaces/{namespace}/events
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
watch individual changes to a list of Event
GET /api/v1/watch/events
Parameter | Description |
---|---|
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. |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
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. |
pretty |
If 'true', then the output is pretty printed. |
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. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Code | Description |
---|---|
200 WatchEvent |
OK |
Group | Version | Kind |
---|---|---|
core |
v1 |
LimitRange |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ObjectMeta |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
spec LimitRangeSpec |
Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
Field | Description |
---|---|
limits LimitRangeItem array |
Limits is the list of LimitRangeItem objects that are enforced. |
Field | Description |
---|---|
apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
items LimitRange array |
Items is a list of LimitRange objects. More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_limit_range.md |
kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
metadata ListMeta |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
create a LimitRange
POST /api/v1/namespaces/{namespace}/limitranges