Top Level API Objects
+-
+
- + + +
- + + +
Definitions
+v1.APIResourceList
+APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
+false |
+string |
++ |
groupVersion |
+groupVersion is the group and version this APIResourceList is for. |
+true |
+string |
++ |
resources |
+resources contains the name of the resources and if they are namespaced. |
+true |
+v1.APIResource array |
++ |
v1.Patch
+Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+v1.DeleteOptions
+DeleteOptions may be provided when deleting an API object.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
+false |
+string |
++ |
gracePeriodSeconds |
+The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
+false |
+integer (int64) |
++ |
preconditions |
+Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
+false |
++ | + |
orphanDependents |
+Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
+false |
+boolean |
+false |
+
propagationPolicy |
+Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: Orphan - orphan the dependents; Background - allow the garbage collector to delete the dependents in the background; Foreground - a cascading policy that deletes all dependents in the foreground. |
+false |
++ | + |
dryRun |
+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 |
+false |
+string array |
++ |
v1.ListMeta
+ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
selfLink |
+selfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
++ |
resourceVersion |
+String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
+false |
+string |
++ |
continue |
+continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. |
+false |
+string |
++ |
v1.StatusDetails
+StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
+false |
+string |
++ |
group |
+The group attribute of the resource associated with the status StatusReason. |
+false |
+string |
++ |
kind |
+The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
uid |
+UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
+false |
+string |
++ |
causes |
+The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
+false |
+v1.StatusCause array |
++ |
retryAfterSeconds |
+If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. |
+false |
+integer (int32) |
++ |
v1.Preconditions
+Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
uid |
+Specifies the target UID. |
+false |
++ | + |
v1.Initializers
+Initializers tracks the progress of initialization.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
pending |
+Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients. |
+true |
+v1.Initializer array |
++ |
result |
+If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion. |
+false |
++ | + |
v1.Initializer
+Initializer is information about an initializer that has not yet completed.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+name of the process that is responsible for initializing this object. |
+true |
+string |
++ |
v1.Status
+Status is a return value for calls that don’t return other objects.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
+false |
++ | + |
status |
+Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
+false |
+string |
++ |
message |
+A human-readable description of the status of this operation. |
+false |
+string |
++ |
reason |
+A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. |
+false |
+string |
++ |
details |
+Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. |
+false |
++ | + |
code |
+Suggested HTTP return code for this status, 0 if not set. |
+false |
+integer (int32) |
++ |
v1.WatchEvent
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
type |
++ | true |
+string |
++ |
object |
++ | true |
+string |
++ |
v1.ObjectMeta
+ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
+false |
+string |
++ |
generateName |
+GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. |
+false |
+string |
++ |
namespace |
+Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. |
+false |
+string |
++ |
selfLink |
+SelfLink is a URL representing this object. Populated by the system. Read-only. |
+false |
+string |
++ |
uid |
+UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. |
+false |
+string |
++ |
resourceVersion |
+An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. |
+false |
+string |
++ |
generation |
+A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
+false |
+integer (int64) |
++ |
creationTimestamp |
+CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. |
+false |
+string |
++ |
deletionTimestamp |
+DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. |
+false |
+string |
++ |
deletionGracePeriodSeconds |
+Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
+false |
+integer (int64) |
++ |
labels |
+Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels |
+false |
+object |
++ |
annotations |
+Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations |
+false |
+object |
++ |
ownerReferences |
+List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. |
+false |
+v1.OwnerReference array |
++ |
initializers |
+An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven’t explicitly asked to observe uninitialized objects. |
+false |
++ | + |
finalizers |
+Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. |
+false |
+string array |
++ |
clusterName |
+The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. |
+false |
+string |
++ |
v1.OwnerReference
+OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
apiVersion |
+API version of the referent. |
+true |
+string |
++ |
kind |
+Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
+true |
+string |
++ |
name |
+Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
+true |
+string |
++ |
uid |
+UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
+true |
+string |
++ |
controller |
+If true, this reference points to the managing controller. |
+false |
+boolean |
+false |
+
blockOwnerDeletion |
+If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
+false |
+boolean |
+false |
+
v1.LeaseSpec
+LeaseSpec is a specification of a Lease.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
holderIdentity |
+holderIdentity contains the identity of the holder of a current lease. |
+false |
+string |
++ |
leaseDurationSeconds |
+leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime. |
+false |
+integer (int32) |
++ |
acquireTime |
+acquireTime is a time when the current lease was acquired. |
+false |
+string |
++ |
renewTime |
+renewTime is a time when the current holder of a lease has last updated the lease. |
+false |
+string |
++ |
leaseTransitions |
+leaseTransitions is the number of transitions of a lease between holders. |
+false |
+integer (int32) |
++ |
v1.APIResource
+APIResource specifies the name of a resource and whether it is namespaced.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
name |
+name is the plural name of the resource. |
+true |
+string |
++ |
singularName |
+singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface. |
+true |
+string |
++ |
namespaced |
+namespaced indicates if a resource is namespaced or not. |
+true |
+boolean |
+false |
+
group |
+group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale". |
+false |
+string |
++ |
version |
+version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource’s group)". |
+false |
+string |
++ |
kind |
+kind is the kind for the resource (e.g. Foo is the kind for a resource foo) |
+true |
+string |
++ |
verbs |
+verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy) |
+true |
+string array |
++ |
shortNames |
+shortNames is a list of suggested short names of the resource. |
+false |
+string array |
++ |
categories |
+categories is a list of the grouped resources this resource belongs to (e.g. all) |
+false |
+string array |
++ |
types.UID
+ +v1.LeaseList
+LeaseList is a list of Lease objects.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
+false |
++ | + |
items |
+Items is a list of schema objects. |
+true |
+v1.Lease array |
++ |
v1.Lease
+Lease defines a lease concept.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
kind |
+Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
+false |
+string |
++ |
apiVersion |
+APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
+false |
+string |
++ |
metadata |
+More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
+false |
++ | + |
spec |
+Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
+false |
++ | + |
v1.StatusCause
+StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
+| Name | +Description | +Required | +Schema | +Default | +
|---|---|---|---|---|
reason |
+A machine-readable description of the cause of the error. If this value is empty there is no information available. |
+false |
+string |
++ |
message |
+A human-readable description of the cause of the error. This field may be presented as-is to a reader. |
+false |
+string |
++ |
field |
+The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. |
+false |
+string |
++ |
v1.DeletionPropagation
+ +any
+Represents an untyped JSON map - see the description of the field for more info about the structure of this object.
+