ErrorInfo

Descrive la causa dell'errore con dettagli strutturati.

Esempio di un errore quando si contatta l'API "pubsub.googleapis.com" quando non è abilitata:

{ "reason": "API_DISABLED"
  "domain": "googleapis.com"
  "metadata": {
    "resource": "projects/123",
    "service": "pubsub.googleapis.com"
  }
}

Questa risposta indica che l'API pubsub.googleapis.com non è abilitata.

Esempio di un errore restituito quando si tenta di creare un'istanza Spanner in una regione non disponibile:

{ "reason": "STOCKOUT"
  "domain": "spanner.googleapis.com",
  "metadata": {
    "availableRegions": "us-central1,us-east2"
  }
}
Rappresentazione JSON
{
  "reason": string,
  "domain": string,
  "metadata": {
    string: string,
    ...
  }
}
Campi
reason

string

Il motivo dell'errore. Si tratta di un valore costante che identifica la causa prossima dell'errore. I motivi dell'errore sono univoci all'interno di un determinato dominio di errori. Deve contenere al massimo 63 caratteri e corrispondere a un'espressione regolare di [A-Z][A-Z0-9_]+[A-Z0-9], che rappresenta UPPER_SNAKE_CASE.

domain

string

Il raggruppamento logico a cui appartiene il "motivo". Il dominio di errore è in genere il nome del servizio registrato dello strumento o del prodotto che genera l'errore. Esempio: "pubsub.googleapis.com". Se l'errore viene generato da un'infrastruttura comune, il dominio di errore deve essere un valore univoco a livello globale che identifica l'infrastruttura. Per l'infrastruttura dell'API Google, il dominio di errore è "googleapis.com".

metadata

map (key: string, value: string)

Dettagli strutturati aggiuntivi su questo errore.

Le chiavi devono corrispondere a un'espressione regolare di [a-z][a-zA-Z0-9-_]+, ma idealmente dovrebbero essere in lowerCamelCase. Inoltre, devono essere limitate a 64 caratteri di lunghezza. Quando si identifica il valore corrente di un limite superato, le unità devono essere contenute nella chiave, non nel valore. Ad esempio, anziché {"instanceLimit": "100/request"}, deve essere restituito come {"instanceLimitPerRequest": "100"}, se il client supera il numero di istanze che possono essere create in una singola richiesta (batch).

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.