此内容没有您所选择的语言版本。
Metadata APIs
Reference guide for metadata APIs
Abstract
Chapter 1. Metadata APIs 复制链接链接已复制到粘贴板!
1.1. APIRequestCount [apiserver.openshift.io/v1] 复制链接链接已复制到粘贴板!
- Description
-
APIRequestCount tracks requests made to an API. The instance name must be of the form
resource.version.group, matching the resource. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). - Type
-
object
1.2. Binding [v1] 复制链接链接已复制到粘贴板!
- Description
- Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.
- Type
-
object
1.3. ComponentStatus [v1] 复制链接链接已复制到粘贴板!
- Description
- ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+
- Type
-
object
1.4. ConfigMap [v1] 复制链接链接已复制到粘贴板!
- Description
- ConfigMap holds configuration data for pods to consume.
- Type
-
object
1.5. ControllerRevision [apps/v1] 复制链接链接已复制到粘贴板!
- Description
- ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
- Type
-
object
1.6. Event [events.k8s.io/v1] 复制链接链接已复制到粘贴板!
- Description
- Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
- Type
-
object
1.7. Event [v1] 复制链接链接已复制到粘贴板!
- Description
- Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
- Type
-
object
1.8. Lease [coordination.k8s.io/v1] 复制链接链接已复制到粘贴板!
- Description
- Lease defines a lease concept.
- Type
-
object
1.9. Namespace [v1] 复制链接链接已复制到粘贴板!
- Description
- Namespace provides a scope for Names. Use of multiple namespaces is optional.
- Type
-
object
Chapter 2. APIRequestCount [apiserver.openshift.io/v1] 复制链接链接已复制到粘贴板!
- Description
-
APIRequestCount tracks requests made to an API. The instance name must be of the form
resource.version.group, matching the resource. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). - Type
-
object - Required
-
spec
-
2.1. Specification 复制链接链接已复制到粘贴板!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec defines the characteristics of the resource. |
|
|
| status contains the observed state of the resource. |
2.1.1. .spec 复制链接链接已复制到粘贴板!
- Description
- spec defines the characteristics of the resource.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| numberOfUsersToReport is the number of users to include in the report. If unspecified or zero, the default is ten. This is default is subject to change. |
2.1.2. .status 复制链接链接已复制到粘贴板!
- Description
- status contains the observed state of the resource.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| conditions contains details of the current status of this API Resource. |
|
|
|
Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition |
|
|
| currentHour contains request history for the current hour. This is porcelain to make the API easier to read by humans seeing if they addressed a problem. This field is reset on the hour. |
|
|
| last24h contains request history for the last 24 hours, indexed by the hour, so 12:00AM-12:59 is in index 0, 6am-6:59am is index 6, etc. The index of the current hour is updated live and then duplicated into the requestsLastHour field. |
|
|
| PerResourceAPIRequestLog logs request for various nodes. |
|
|
| removedInRelease is when the API will be removed. |
|
|
| requestCount is a sum of all requestCounts across all current hours, nodes, and users. |
2.1.3. .status.conditions 复制链接链接已复制到粘贴板!
- Description
- conditions contains details of the current status of this API Resource.
- Type
-
array
2.1.4. .status.conditions[] 复制链接链接已复制到粘贴板!
- Description
-
Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"// other fields } - Type
-
object - Required
-
lastTransitionTime -
message -
reason -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
|
|
| message is a human readable message indicating details about the transition. This may be an empty string. |
|
|
| observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
|
|
| reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
|
|
| status of the condition, one of True, False, Unknown. |
|
|
| type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |
2.1.5. .status.currentHour 复制链接链接已复制到粘贴板!
- Description
- currentHour contains request history for the current hour. This is porcelain to make the API easier to read by humans seeing if they addressed a problem. This field is reset on the hour.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| byNode contains logs of requests per node. |
|
|
| PerNodeAPIRequestLog contains logs of requests to a certain node. |
|
|
| requestCount is a sum of all requestCounts across nodes. |
2.1.6. .status.currentHour.byNode 复制链接链接已复制到粘贴板!
- Description
- byNode contains logs of requests per node.
- Type
-
array
2.1.7. .status.currentHour.byNode[] 复制链接链接已复制到粘贴板!
- Description
- PerNodeAPIRequestLog contains logs of requests to a certain node.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| byUser contains request details by top .spec.numberOfUsersToReport users. Note that because in the case of an apiserver, restart the list of top users is determined on a best-effort basis, the list might be imprecise. In addition, some system users may be explicitly included in the list. |
|
|
| PerUserAPIRequestCount contains logs of a user’s requests. |
|
|
| nodeName where the request are being handled. |
|
|
| requestCount is a sum of all requestCounts across all users, even those outside of the top 10 users. |
2.1.8. .status.currentHour.byNode[].byUser 复制链接链接已复制到粘贴板!
- Description
- byUser contains request details by top .spec.numberOfUsersToReport users. Note that because in the case of an apiserver, restart the list of top users is determined on a best-effort basis, the list might be imprecise. In addition, some system users may be explicitly included in the list.
- Type
-
array
2.1.9. .status.currentHour.byNode[].byUser[] 复制链接链接已复制到粘贴板!
- Description
- PerUserAPIRequestCount contains logs of a user’s requests.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| byVerb details by verb. |
|
|
| PerVerbAPIRequestCount requestCounts requests by API request verb. |
|
|
| requestCount of requests by the user across all verbs. |
|
|
| userAgent that made the request. The same user often has multiple binaries which connect (pods with many containers). The different binaries will have different userAgents, but the same user. In addition, we have userAgents with version information embedded and the userName isn’t likely to change. |
|
|
| userName that made the request. |
2.1.10. .status.currentHour.byNode[].byUser[].byVerb 复制链接链接已复制到粘贴板!
- Description
- byVerb details by verb.
- Type
-
array
2.1.11. .status.currentHour.byNode[].byUser[].byVerb[] 复制链接链接已复制到粘贴板!
- Description
- PerVerbAPIRequestCount requestCounts requests by API request verb.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| requestCount of requests for verb. |
|
|
| verb of API request (get, list, create, etc…) |
2.1.12. .status.last24h 复制链接链接已复制到粘贴板!
- Description
- last24h contains request history for the last 24 hours, indexed by the hour, so 12:00AM-12:59 is in index 0, 6am-6:59am is index 6, etc. The index of the current hour is updated live and then duplicated into the requestsLastHour field.
- Type
-
array
2.1.13. .status.last24h[] 复制链接链接已复制到粘贴板!
- Description
- PerResourceAPIRequestLog logs request for various nodes.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| byNode contains logs of requests per node. |
|
|
| PerNodeAPIRequestLog contains logs of requests to a certain node. |
|
|
| requestCount is a sum of all requestCounts across nodes. |
2.1.14. .status.last24h[].byNode 复制链接链接已复制到粘贴板!
- Description
- byNode contains logs of requests per node.
- Type
-
array
2.1.15. .status.last24h[].byNode[] 复制链接链接已复制到粘贴板!
- Description
- PerNodeAPIRequestLog contains logs of requests to a certain node.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| byUser contains request details by top .spec.numberOfUsersToReport users. Note that because in the case of an apiserver, restart the list of top users is determined on a best-effort basis, the list might be imprecise. In addition, some system users may be explicitly included in the list. |
|
|
| PerUserAPIRequestCount contains logs of a user’s requests. |
|
|
| nodeName where the request are being handled. |
|
|
| requestCount is a sum of all requestCounts across all users, even those outside of the top 10 users. |
2.1.16. .status.last24h[].byNode[].byUser 复制链接链接已复制到粘贴板!
- Description
- byUser contains request details by top .spec.numberOfUsersToReport users. Note that because in the case of an apiserver, restart the list of top users is determined on a best-effort basis, the list might be imprecise. In addition, some system users may be explicitly included in the list.
- Type
-
array
2.1.17. .status.last24h[].byNode[].byUser[] 复制链接链接已复制到粘贴板!
- Description
- PerUserAPIRequestCount contains logs of a user’s requests.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| byVerb details by verb. |
|
|
| PerVerbAPIRequestCount requestCounts requests by API request verb. |
|
|
| requestCount of requests by the user across all verbs. |
|
|
| userAgent that made the request. The same user often has multiple binaries which connect (pods with many containers). The different binaries will have different userAgents, but the same user. In addition, we have userAgents with version information embedded and the userName isn’t likely to change. |
|
|
| userName that made the request. |
2.1.18. .status.last24h[].byNode[].byUser[].byVerb 复制链接链接已复制到粘贴板!
- Description
- byVerb details by verb.
- Type
-
array
2.1.19. .status.last24h[].byNode[].byUser[].byVerb[] 复制链接链接已复制到粘贴板!
- Description
- PerVerbAPIRequestCount requestCounts requests by API request verb.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| requestCount of requests for verb. |
|
|
| verb of API request (get, list, create, etc…) |
2.2. API endpoints 复制链接链接已复制到粘贴板!
The following API endpoints are available:
/apis/apiserver.openshift.io/v1/apirequestcounts-
DELETE: delete collection of APIRequestCount -
GET: list objects of kind APIRequestCount -
POST: create an APIRequestCount
-
/apis/apiserver.openshift.io/v1/apirequestcounts/{name}-
DELETE: delete an APIRequestCount -
GET: read the specified APIRequestCount -
PATCH: partially update the specified APIRequestCount -
PUT: replace the specified APIRequestCount
-
/apis/apiserver.openshift.io/v1/apirequestcounts/{name}/status-
GET: read status of the specified APIRequestCount -
PATCH: partially update status of the specified APIRequestCount -
PUT: replace status of the specified APIRequestCount
-
2.2.1. /apis/apiserver.openshift.io/v1/apirequestcounts 复制链接链接已复制到粘贴板!
- HTTP method
-
DELETE - Description
- delete collection of APIRequestCount
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind APIRequestCount
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create an APIRequestCount
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the APIRequestCount |
- HTTP method
-
DELETE - Description
- delete an APIRequestCount
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified APIRequestCount
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified APIRequestCount
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified APIRequestCount
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the APIRequestCount |
- HTTP method
-
GET - Description
- read status of the specified APIRequestCount
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified APIRequestCount
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified APIRequestCount
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
Chapter 3. Binding [v1] 复制链接链接已复制到粘贴板!
- Description
- Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.
- Type
-
object - Required
-
target
-
3.1. Specification 复制链接链接已复制到粘贴板!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| ObjectReference contains enough information to let you inspect or modify the referred object. |
3.1.1. .target 复制链接链接已复制到粘贴板!
- Description
- ObjectReference contains enough information to let you inspect or modify the referred object.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| API version of the referent. |
|
|
| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. |
|
|
| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
3.2. API endpoints 复制链接链接已复制到粘贴板!
The following API endpoints are available:
/api/v1/namespaces/{namespace}/bindings-
POST: create a Binding
-
/api/v1/namespaces/{namespace}/pods/{name}/binding-
POST: create binding of a Pod
-
3.2.1. /api/v1/namespaces/{namespace}/bindings 复制链接链接已复制到粘贴板!
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
- HTTP method
-
POST - Description
- create a Binding
| Parameter | Type | Description |
|---|---|---|
|
|
|
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Binding |
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
- HTTP method
-
POST - Description
- create binding of a Pod
| Parameter | Type | Description |
|---|---|---|
|
|
|
Chapter 4. ComponentStatus [v1] 复制链接链接已复制到粘贴板!
- Description
- ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+
- Type
-
object
4.1. Specification 复制链接链接已复制到粘贴板!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| List of component conditions observed |
|
|
| Information about the condition of a component. |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
4.1.1. .conditions 复制链接链接已复制到粘贴板!
- Description
- List of component conditions observed
- Type
-
array
4.1.2. .conditions[] 复制链接链接已复制到粘贴板!
- Description
- Information about the condition of a component.
- Type
-
object - Required
-
type -
status
-
| Property | Type | Description |
|---|---|---|
|
|
| Condition error code for a component. For example, a health check error code. |
|
|
| Message about the condition for a component. For example, information about a health check. |
|
|
| Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". |
|
|
| Type of condition for a component. Valid value: "Healthy" |
4.2. API endpoints 复制链接链接已复制到粘贴板!
The following API endpoints are available:
/api/v1/componentstatuses-
GET: list objects of kind ComponentStatus
-
/api/v1/componentstatuses/{name}-
GET: read the specified ComponentStatus
-
4.2.1. /api/v1/componentstatuses 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- list objects of kind ComponentStatus
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
4.2.2. /api/v1/componentstatuses/{name} 复制链接链接已复制到粘贴板!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ComponentStatus |
- HTTP method
-
GET - Description
- read the specified ComponentStatus
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
Chapter 5. ConfigMap [v1] 复制链接链接已复制到粘贴板!
- Description
- ConfigMap holds configuration data for pods to consume.
- Type
-
object
5.1. Specification 复制链接链接已复制到粘贴板!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. |
|
|
| Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. |
|
|
| Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
5.2. API endpoints 复制链接链接已复制到粘贴板!
The following API endpoints are available:
/api/v1/configmaps-
GET: list or watch objects of kind ConfigMap
-
/api/v1/watch/configmaps-
GET: watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.
-
/api/v1/namespaces/{namespace}/configmaps-
DELETE: delete collection of ConfigMap -
GET: list or watch objects of kind ConfigMap -
POST: create a ConfigMap
-
/api/v1/watch/namespaces/{namespace}/configmaps-
GET: watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.
-
/api/v1/namespaces/{namespace}/configmaps/{name}-
DELETE: delete a ConfigMap -
GET: read the specified ConfigMap -
PATCH: partially update the specified ConfigMap -
PUT: replace the specified ConfigMap
-
/api/v1/watch/namespaces/{namespace}/configmaps/{name}-
GET: watch changes to an object of kind ConfigMap. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
5.2.1. /api/v1/configmaps 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- list or watch objects of kind ConfigMap
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
5.2.2. /api/v1/watch/configmaps 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
5.2.3. /api/v1/namespaces/{namespace}/configmaps 复制链接链接已复制到粘贴板!
- HTTP method
-
DELETE - Description
- delete collection of ConfigMap
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list or watch objects of kind ConfigMap
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a ConfigMap
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
5.2.4. /api/v1/watch/namespaces/{namespace}/configmaps 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
5.2.5. /api/v1/namespaces/{namespace}/configmaps/{name} 复制链接链接已复制到粘贴板!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ConfigMap |
- HTTP method
-
DELETE - Description
- delete a ConfigMap
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified ConfigMap
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified ConfigMap
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified ConfigMap
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ConfigMap |
- HTTP method
-
GET - Description
- watch changes to an object of kind ConfigMap. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
Chapter 6. ControllerRevision [apps/v1] 复制链接链接已复制到粘贴板!
- Description
- ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.
- Type
-
object - Required
-
revision
-
6.1. Specification 复制链接链接已复制到粘贴板!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Data is the serialized representation of the state. | |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| Revision indicates the revision of the state represented by Data. |
6.2. API endpoints 复制链接链接已复制到粘贴板!
The following API endpoints are available:
/apis/apps/v1/controllerrevisions-
GET: list or watch objects of kind ControllerRevision
-
/apis/apps/v1/watch/controllerrevisions-
GET: watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/apps/v1/namespaces/{namespace}/controllerrevisions-
DELETE: delete collection of ControllerRevision -
GET: list or watch objects of kind ControllerRevision -
POST: create a ControllerRevision
-
/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions-
GET: watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}-
DELETE: delete a ControllerRevision -
GET: read the specified ControllerRevision -
PATCH: partially update the specified ControllerRevision -
PUT: replace the specified ControllerRevision
-
/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}-
GET: watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
6.2.1. /apis/apps/v1/controllerrevisions 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- list or watch objects of kind ControllerRevision
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
6.2.2. /apis/apps/v1/watch/controllerrevisions 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
DELETE - Description
- delete collection of ControllerRevision
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list or watch objects of kind ControllerRevision
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a ControllerRevision
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ControllerRevision |
- HTTP method
-
DELETE - Description
- delete a ControllerRevision
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified ControllerRevision
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified ControllerRevision
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified ControllerRevision
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the ControllerRevision |
- HTTP method
-
GET - Description
- watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
Chapter 7. Event [events.k8s.io/v1] 复制链接链接已复制到粘贴板!
- Description
- Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
- Type
-
object - Required
-
eventTime
-
7.1. Specification 复制链接链接已复制到粘贴板!
| Property | Type | Description |
|---|---|---|
|
|
| action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters. |
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. |
|
| deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | |
|
| deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | |
|
| deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. | |
|
| eventTime is the time when this Event was first observed. It is required. | |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. |
|
|
| reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters. |
|
| regarding contains the object this Event is about. In most cases it’s an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. | |
|
| related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object. | |
|
|
|
reportingController is the name of the controller that emitted this Event, e.g. |
|
|
|
reportingInstance is the ID of the controller instance, e.g. |
|
|
| EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations. |
|
|
| type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events. |
7.1.1. .series 复制链接链接已复制到粘贴板!
- Description
- EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations.
- Type
-
object - Required
-
count -
lastObservedTime
-
| Property | Type | Description |
|---|---|---|
|
|
| count is the number of occurrences in this series up to the last heartbeat time. |
|
| lastObservedTime is the time when last Event from the series was seen before last heartbeat. |
7.2. API endpoints 复制链接链接已复制到粘贴板!
The following API endpoints are available:
/apis/events.k8s.io/v1/events-
GET: list or watch objects of kind Event
-
/apis/events.k8s.io/v1/watch/events-
GET: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/events.k8s.io/v1/namespaces/{namespace}/events-
DELETE: delete collection of Event -
GET: list or watch objects of kind Event -
POST: create an Event
-
/apis/events.k8s.io/v1/watch/namespaces/{namespace}/events-
GET: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}-
DELETE: delete an Event -
GET: read the specified Event -
PATCH: partially update the specified Event -
PUT: replace the specified Event
-
/apis/events.k8s.io/v1/watch/namespaces/{namespace}/events/{name}-
GET: watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
7.2.1. /apis/events.k8s.io/v1/events 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- list or watch objects of kind Event
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
7.2.2. /apis/events.k8s.io/v1/watch/events 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
DELETE - Description
- delete collection of Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list or watch objects of kind Event
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create an Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
- HTTP method
-
GET - Description
- watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Event |
- HTTP method
-
DELETE - Description
- delete an Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified Event
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Event |
- HTTP method
-
GET - Description
- watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
Chapter 8. Event [v1] 复制链接链接已复制到粘贴板!
- Description
- Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
- Type
-
object - Required
-
metadata -
involvedObject
-
8.1. Specification 复制链接链接已复制到粘贴板!
| Property | Type | Description |
|---|---|---|
|
|
| What action was taken/failed regarding to the Regarding object. |
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| The number of times this event has occurred. |
|
| Time when this Event was first observed. | |
|
| The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) | |
|
|
| ObjectReference contains enough information to let you inspect or modify the referred object. |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| The time at which the most recent occurrence of this event was recorded. | |
|
|
| A human-readable description of the status of this operation. |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| This should be a short, machine understandable string that gives the reason for the transition into the object’s current status. |
|
|
| ObjectReference contains enough information to let you inspect or modify the referred object. |
|
|
|
Name of the controller that emitted this Event, e.g. |
|
|
|
ID of the controller instance, e.g. |
|
|
| EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. |
|
|
| EventSource contains information for an event. |
|
|
| Type of this event (Normal, Warning), new types could be added in the future |
8.1.1. .involvedObject 复制链接链接已复制到粘贴板!
- Description
- ObjectReference contains enough information to let you inspect or modify the referred object.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| API version of the referent. |
|
|
| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. |
|
|
| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
8.1.3. .series 复制链接链接已复制到粘贴板!
- Description
- EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Number of occurrences in this series up to the last heartbeat time |
|
| Time of the last occurrence observed |
8.1.4. .source 复制链接链接已复制到粘贴板!
- Description
- EventSource contains information for an event.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Component from which the event is generated. |
|
|
| Node name on which the event is generated. |
8.2. API endpoints 复制链接链接已复制到粘贴板!
The following API endpoints are available:
/api/v1/events-
GET: list or watch objects of kind Event
-
/api/v1/watch/events-
GET: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
-
/api/v1/namespaces/{namespace}/events-
DELETE: delete collection of Event -
GET: list or watch objects of kind Event -
POST: create an Event
-
/api/v1/watch/namespaces/{namespace}/events-
GET: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
-
/api/v1/namespaces/{namespace}/events/{name}-
DELETE: delete an Event -
GET: read the specified Event -
PATCH: partially update the specified Event -
PUT: replace the specified Event
-
/api/v1/watch/namespaces/{namespace}/events/{name}-
GET: watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
8.2.1. /api/v1/events 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- list or watch objects of kind Event
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
8.2.2. /api/v1/watch/events 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
8.2.3. /api/v1/namespaces/{namespace}/events 复制链接链接已复制到粘贴板!
- HTTP method
-
DELETE - Description
- delete collection of Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list or watch objects of kind Event
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create an Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
8.2.4. /api/v1/watch/namespaces/{namespace}/events 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
8.2.5. /api/v1/namespaces/{namespace}/events/{name} 复制链接链接已复制到粘贴板!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Event |
- HTTP method
-
DELETE - Description
- delete an Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified Event
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified Event
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Event |
- HTTP method
-
GET - Description
- watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
Chapter 9. Lease [coordination.k8s.io/v1] 复制链接链接已复制到粘贴板!
- Description
- Lease defines a lease concept.
- Type
-
object
9.1. Specification 复制链接链接已复制到粘贴板!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| LeaseSpec is a specification of a Lease. |
9.1.1. .spec 复制链接链接已复制到粘贴板!
- Description
- LeaseSpec is a specification of a Lease.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
| acquireTime is a time when the current lease was acquired. | |
|
|
| holderIdentity contains the identity of the holder of a current lease. If Coordinated Leader Election is used, the holder identity must be equal to the elected LeaseCandidate.metadata.name field. |
|
|
| leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measured against the time of last observed renewTime. |
|
|
| leaseTransitions is the number of transitions of a lease between holders. |
|
|
| PreferredHolder signals to a lease holder that the lease has a more optimal holder and should be given up. This field can only be set if Strategy is also set. |
|
| renewTime is a time when the current holder of a lease has last updated the lease. | |
|
|
| Strategy indicates the strategy for picking the leader for coordinated leader election. If the field is not specified, there is no active coordination for this lease. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled. |
9.2. API endpoints 复制链接链接已复制到粘贴板!
The following API endpoints are available:
/apis/coordination.k8s.io/v1/leases-
GET: list or watch objects of kind Lease
-
/apis/coordination.k8s.io/v1/watch/leases-
GET: watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases-
DELETE: delete collection of Lease -
GET: list or watch objects of kind Lease -
POST: create a Lease
-
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases-
GET: watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
-
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}-
DELETE: delete a Lease -
GET: read the specified Lease -
PATCH: partially update the specified Lease -
PUT: replace the specified Lease
-
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}-
GET: watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
9.2.1. /apis/coordination.k8s.io/v1/leases 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- list or watch objects of kind Lease
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
9.2.2. /apis/coordination.k8s.io/v1/watch/leases 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
DELETE - Description
- delete collection of Lease
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list or watch objects of kind Lease
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a Lease
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
- HTTP method
-
GET - Description
- watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Lease |
- HTTP method
-
DELETE - Description
- delete a Lease
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified Lease
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified Lease
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified Lease
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Lease |
- HTTP method
-
GET - Description
- watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
Chapter 10. Namespace [v1] 复制链接链接已复制到粘贴板!
- Description
- Namespace provides a scope for Names. Use of multiple namespaces is optional.
- Type
-
object
10.1. Specification 复制链接链接已复制到粘贴板!
| Property | Type | Description |
|---|---|---|
|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| NamespaceSpec describes the attributes on a Namespace. |
|
|
| NamespaceStatus is information about the current status of a Namespace. |
10.1.1. .spec 复制链接链接已复制到粘贴板!
- Description
- NamespaceSpec describes the attributes on a Namespace.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ |
10.1.2. .status 复制链接链接已复制到粘贴板!
- Description
- NamespaceStatus is information about the current status of a Namespace.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Represents the latest available observations of a namespace’s current state. |
|
|
| NamespaceCondition contains details about state of namespace. |
|
|
| Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
Possible enum values: - |
10.1.3. .status.conditions 复制链接链接已复制到粘贴板!
- Description
- Represents the latest available observations of a namespace’s current state.
- Type
-
array
10.1.4. .status.conditions[] 复制链接链接已复制到粘贴板!
- Description
- NamespaceCondition contains details about state of namespace.
- Type
-
object - Required
-
type -
status
-
| Property | Type | Description |
|---|---|---|
|
| ||
|
|
| |
|
|
| |
|
|
| Status of the condition, one of True, False, Unknown. |
|
|
| Type of namespace controller condition. |
10.2. API endpoints 复制链接链接已复制到粘贴板!
The following API endpoints are available:
/api/v1/namespaces-
GET: list or watch objects of kind Namespace -
POST: create a Namespace
-
/api/v1/watch/namespaces-
GET: watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead.
-
/api/v1/namespaces/{name}-
DELETE: delete a Namespace -
GET: read the specified Namespace -
PATCH: partially update the specified Namespace -
PUT: replace the specified Namespace
-
/api/v1/watch/namespaces/{name}-
GET: watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
-
/api/v1/namespaces/{name}/status-
GET: read status of the specified Namespace -
PATCH: partially update status of the specified Namespace -
PUT: replace status of the specified Namespace
-
/api/v1/namespaces/{name}/finalize-
PUT: replace finalize of the specified Namespace
-
10.2.1. /api/v1/namespaces 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- list or watch objects of kind Namespace
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a Namespace
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
10.2.2. /api/v1/watch/namespaces 复制链接链接已复制到粘贴板!
- HTTP method
-
GET - Description
- watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
10.2.3. /api/v1/namespaces/{name} 复制链接链接已复制到粘贴板!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Namespace |
- HTTP method
-
DELETE - Description
- delete a Namespace
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified Namespace
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified Namespace
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified Namespace
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
10.2.4. /api/v1/watch/namespaces/{name} 复制链接链接已复制到粘贴板!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Namespace |
- HTTP method
-
GET - Description
- watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
10.2.5. /api/v1/namespaces/{name}/status 复制链接链接已复制到粘贴板!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Namespace |
- HTTP method
-
GET - Description
- read status of the specified Namespace
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified Namespace
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified Namespace
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
10.2.6. /api/v1/namespaces/{name}/finalize 复制链接链接已复制到粘贴板!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Namespace |
| Parameter | Type | Description |
|---|---|---|
|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
- HTTP method
-
PUT - Description
- replace finalize of the specified Namespace
| Parameter | Type | Description |
|---|---|---|
|
|
|
Legal Notice
复制链接链接已复制到粘贴板!
Copyright © 2025 Red Hat
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.