Reference documentation and code samples for the Kubernetes Engine V1beta1 API module Google::Rpc::Code.

The canonical error codes for gRPC APIs.

Sometimes multiple error codes may apply. Services should returnthe most specific error code that applies. For example, preferOUT_OF_RANGE overFAILED_PRECONDITION if both codes apply.Similarly preferNOT_FOUND orALREADY_EXISTS overFAILED_PRECONDITION.

value:0
Not an error; returned on success.

HTTP Mapping: 200 OK

value:1
The operation was cancelled, typically by the caller.

HTTP Mapping: 499 Client Closed Request

value:2
Unknown error. For example, this error may be returned whenaStatus value received from another address space belongs toan error space that is not known in this address space. Alsoerrors raised by APIs that do not return enough error informationmay be converted to this error.

HTTP Mapping: 500 Internal Server Error

value:3
The client specified an invalid argument. Note that this differsfromFAILED_PRECONDITION.INVALID_ARGUMENT indicates argumentsthat are problematic regardless of the state of the system(e.g., a malformed file name).

HTTP Mapping: 400 Bad Request

value:4
The deadline expired before the operation could complete. For operationsthat change the state of the system, this error may be returnedeven if the operation has completed successfully. For example, asuccessful response from a server could have been delayed longenough for the deadline to expire.

HTTP Mapping: 504 Gateway Timeout

value:5
Some requested entity (e.g., file or directory) was not found.

Note to server developers: if a request is denied for an entire classof users, such as gradual feature rollout or undocumented allowlist,NOT_FOUND may be used. If a request is denied for some users withina class of users, such as user-based access control,PERMISSION_DENIEDmust be used.

HTTP Mapping: 404 Not Found

value:6
The entity that a client attempted to create (e.g., file or directory)already exists.

HTTP Mapping: 409 Conflict

value:7
The caller does not have permission to execute the specifiedoperation.PERMISSION_DENIED must not be used for rejectionscaused by exhausting some resource (useRESOURCE_EXHAUSTEDinstead for those errors).PERMISSION_DENIED must not beused if the caller can not be identified (useUNAUTHENTICATEDinstead for those errors). This error code does not imply therequest is valid or the requested entity exists or satisfiesother pre-conditions.

HTTP Mapping: 403 Forbidden

value:16
The request does not have valid authentication credentials for theoperation.

HTTP Mapping: 401 Unauthorized

value:8
Some resource has been exhausted, perhaps a per-user quota, orperhaps the entire file system is out of space.

HTTP Mapping: 429 Too Many Requests

value:9
The operation was rejected because the system is not in a staterequired for the operation's execution. For example, the directoryto be deleted is non-empty, an rmdir operation is applied toa non-directory, etc.

Service implementors can use the following guidelines to decidebetweenFAILED_PRECONDITION,ABORTED, andUNAVAILABLE: (a) UseUNAVAILABLE if the client can retry just the failing call. (b) UseABORTED if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) UseFAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. For example, if an "rmdir" fails because the directory is non-empty,FAILED_PRECONDITION should be returned since the client should not retry unless the files are deleted from the directory.

HTTP Mapping: 400 Bad Request

value:10
The operation was aborted, typically due to a concurrency issue such asa sequencer check failure or transaction abort.

See the guidelines above for deciding betweenFAILED_PRECONDITION,ABORTED, andUNAVAILABLE.

HTTP Mapping: 409 Conflict

value:11
The operation was attempted past the valid range. E.g., seeking orreading past end-of-file.

UnlikeINVALID_ARGUMENT, this error indicates a problem that maybe fixed if the system state changes. For example, a 32-bit filesystem will generateINVALID_ARGUMENT if asked to read at anoffset that is not in the range [0,2^32-1], but it will generateOUT_OF_RANGE if asked to read from an offset past the currentfile size.

There is a fair bit of overlap betweenFAILED_PRECONDITION andOUT_OF_RANGE. We recommend usingOUT_OF_RANGE (the more specificerror) when it applies so that callers who are iterating througha space can easily look for anOUT_OF_RANGE error to detect whenthey are done.

HTTP Mapping: 400 Bad Request

value:12
The operation is not implemented or is not supported/enabled in thisservice.

HTTP Mapping: 501 Not Implemented

value:13
Internal errors. This means that some invariants expected by theunderlying system have been broken. This error code is reservedfor serious errors.

HTTP Mapping: 500 Internal Server Error

value:14
The service is currently unavailable. This is most likely atransient condition, which can be corrected by retrying witha backoff. Note that it is not always safe to retrynon-idempotent operations.

See the guidelines above for deciding betweenFAILED_PRECONDITION,ABORTED, andUNAVAILABLE.

HTTP Mapping: 503 Service Unavailable

value:15
Unrecoverable data loss or corruption.

HTTP Mapping: 500 Internal Server Error