Index
BadRequest
(message)BadRequest.FieldViolation
(message)Help
(message)Help.Link
(message)LocalizedMessage
(message)PreconditionFailure
(message)PreconditionFailure.Violation
(message)QuotaFailure
(message)QuotaFailure.Violation
(message)RequestInfo
(message)ResourceInfo
(message)RetryInfo
(message)Status
(message)
BadRequest
Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
Fields | |
---|---|
field_violations[] |
Describes all violations in a client request. |
FieldViolation
A message type used to describe a single bad request field.
Fields | |
---|---|
field |
A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following:
In this example, in proto
In JSON, the same values are represented as:
|
description |
A description of why the request element is bad. |
reason |
The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of |
localized_message |
Provides a localized error message for field-level errors that is safe to return to the API consumer. |
Help
Provides links to documentation or for performing an out of band action.
For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
Fields | |
---|---|
links[] |
URL(s) pointing to additional information on handling the current error. |
Link
Describes a URL link.
Fields | |
---|---|
description |
Describes what the link offers. |
url |
The URL of the link. |
LocalizedMessage
Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
Fields | |
---|---|
locale |
The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" |
message |
The localized error message in the above locale. |
PreconditionFailure
Describes what preconditions have failed.
For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.
Fields | |
---|---|
violations[] |
Describes all precondition violations. |
Violation
A message type used to describe a single precondition failure.
Fields | |
---|---|
type |
The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation". |
subject |
The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced. |
description |
A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: "Terms of service not accepted". |
QuotaFailure
Describes how a quota check failed.
For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled
to true.
Also see RetryInfo and Help types for other details about handling a quota failure.
Fields | |
---|---|
violations[] |
Describes all quota violations. |
Violation
A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
Fields | |
---|---|
subject |
The subject on which the quota check failed. For example, "clientip: |
description |
A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console. For example: "Service disabled" or "Daily Limit for read operations exceeded". |
api_service |
The API Service from which the For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com". |
quota_metric |
The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected. For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth". |
quota_id |
The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service. For example, "CPUS-PER-VM-FAMILY-per-project-region". |
quota_dimensions |
The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased. For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be, { "region": "us-central1", "vm_family": "n1", } When a quota is enforced globally, the quota_dimensions would always be empty. |
quota_value |
The enforced quota value at the time of the For example, if the enforced quota value at the time of the |
future_quota_value |
The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set. For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field. |
RequestInfo
Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
Fields | |
---|---|
request_id |
An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs. |
serving_data |
Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging. |
ResourceInfo
Describes the resource that is being accessed.
Fields | |
---|---|
resource_type |
A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic". |
resource_name |
The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is |
owner |
The owner of the resource (optional). For example, "user: |
description |
Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the |
RetryInfo
Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.
It's always recommended that clients should use exponential backoff when retrying.
Clients should wait until retry_delay
amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on retry_delay
, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.
Fields | |
---|---|
retry_delay |
Clients should wait at least this long between retrying the same request. |
Status
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the API Design Guide.
Fields | |
---|---|
code |
The status code, which should be an enum value of |
message |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
details[] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. |