Status

Stay organized with collections Save and categorize content based on your preferences.

Status is a return value for calls that don't return other objects.

JSON representation
{
  "metadata": {
    object (ListMeta)
  },
  "status": string,
  "message": string,
  "reason": string,
  "details": {
    object (StatusDetails)
  },
  "code": integer
}
Fields
metadata

object (ListMeta)

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

status

string

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

message

string

A human-readable description of the status of this operation.

reason

string

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

details

object (StatusDetails)

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.

code

integer

Suggested HTTP return code for this status, 0 if not set.

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.

JSON representation
{
  "name": string,
  "group": string,
  "kind": string,
  "uid": string,
  "causes": [
    {
      object (StatusCause)
    }
  ],
  "retryAfterSeconds": integer
}
Fields
name

string

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

group

string

The group attribute of the resource associated with the status StatusReason.

kind

string

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

uid

string

UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/user-guide/identifiers#uids

causes[]

object (StatusCause)

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

retryAfterSeconds

integer

If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.

StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

JSON representation
{
  "reason": string,
  "message": string,
  "field": string
}
Fields
reason

string

A machine-readable description of the cause of the error. If this value is empty there is no information available.

message

string

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

field

string

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors.

Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"