Method: projects.locations.endpoints.queryData

Esegue query sulla rete per informazioni memorizzate nel ledger, come account e transazioni.

L'accesso a determinati campi sensibili, come i saldi dei conti, potrebbe essere limitato in base all'identità del mittente derivata dalla firma nella richiesta. Se il mittente non dispone dell'autorizzazione, i campi sensibili verranno oscurati dalla risposta e segnalati nel campo redactedFields.

Richiesta HTTP


POST https://universalledger.googleapis.com/v1/{endpoint=projects/*/locations/*/endpoints/*}:queryData

Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
endpoint

string

Obbligatorio. L'endpoint per gestire la richiesta. Formato: projects/{project}/locations/{location}/endpoints/{endpoint} La posizione è una regione.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "serializedSignedQueryRequest": string
}
Campi
serializedSignedQueryRequest

string (bytes format)

Obbligatorio. Un SignedQueryRequest serializzato protobuf per eseguire query sulla rete Universal Ledger.

Una stringa con codifica in base64.

Corpo della risposta

Messaggio di risposta per endpoints.queryData.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "redactedFields": [
    {
      object (RedactedField)
    }
  ],

  // Union field kind can be only one of the following:
  "account": {
    object (Account)
  },
  "transactionState": {
    object (TransactionState)
  }
  // End of list of possible types for union field kind.
}
Campi
redactedFields[]

object (RedactedField)

Indica quali campi sono stati oscurati dalla risposta a causa di limitazioni delle autorizzazioni.
Campo unione kind. Il risultato specifico della query. kind può essere solo uno dei seguenti tipi:
account

object (Account)

I dati dell'account, se la query riguardava un account.
transactionState

object (TransactionState)

Lo stato di una transazione, se la query riguardava una transazione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Per saperne di più, consulta la Authentication Overview.

TransactionState

Lo stato di una transazione.

Rappresentazione JSON 
{
  "transactionAttempts": [
    {
      object (TransactionAttempt)
    }
  ]
}
Campi
transactionAttempts[]

object (TransactionAttempt)

Una voce per ogni invio noto della transazione al validatore che gestisce la richiesta.

RedactedField

Informazioni su un campo oscurato nella risposta.

Rappresentazione JSON 
{
  "redactedPath": string,
  "reason": string,
  "reasonCode": enum (Code)
}
Campi
redactedPath

string (FieldMask format)

Solo output. I percorsi dei campi completi che sono stati oscurati dal payload.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".
reason

string

Solo output. Una spiegazione leggibile del motivo per cui i campi sono stati oscurati.
reasonCode

enum (Code)

Solo output. Un codice leggibile dalla macchina che indica il motivo per cui i campi sono stati oscurati.

Codice

I codici di errore canonici per le API gRPC.

A volte possono essere applicati più codici di errore. I servizi devono restituire il codice di errore più specifico applicabile. Ad esempio, preferisci OUT_OF_RANGE a FAILED_PRECONDITION se entrambi i codici sono applicabili. Allo stesso modo, preferisci NOT_FOUND o ALREADY_EXISTS a FAILED_PRECONDITION.

Enum
OK

Non è un errore; viene restituito in caso di esito positivo.

Mappatura HTTP: 200 OK
CANCELLED

L'operazione è stata annullata, in genere dal chiamante.

Mapping HTTP: 499 Client Closed Request
UNKNOWN

Errore sconosciuto. Ad esempio, questo errore può essere restituito quando un valore Status ricevuto da un altro spazio di indirizzi appartiene a uno spazio di errore sconosciuto in questo spazio di indirizzi. Anche gli errori generati dalle API che non restituiscono informazioni sufficienti sugli errori possono essere convertiti in questo errore.

Mapping HTTP: 500 Internal Server Error
INVALID_ARGUMENT

Il client ha specificato un argomento non valido. Tieni presente che questo valore è diverso da FAILED_PRECONDITION. INVALID_ARGUMENT indica gli argomenti problematici indipendentemente dallo stato del sistema (ad es. un nome file non valido).

Mapping HTTP: 400 Bad Request
DEADLINE_EXCEEDED

La scadenza è terminata prima che l'operazione potesse essere completata. Per le operazioni che modificano lo stato del sistema, questo errore può essere restituito anche se l'operazione è stata completata correttamente. Ad esempio, una risposta riuscita da un server potrebbe essere stata ritardata abbastanza a lungo da far scadere il termine.

Mappatura HTTP: 504 Gateway Timeout
NOT_FOUND

Impossibile trovare alcune entità richieste (ad es. file o directory).

Nota per gli sviluppatori di server: se una richiesta viene negata per un'intera classe di utenti, ad esempio per il lancio graduale di funzionalità o per una lista consentita non documentata, è possibile utilizzare NOT_FOUND. Se una richiesta viene negata per alcuni utenti all'interno di una classe di utenti, ad esempio controllo dell'accesso basato sull'utente, è necessario utilizzare PERMISSION_DENIED.

Mappatura HTTP: 404 - Non trovato
ALREADY_EXISTS

L'entità che un client ha tentato di creare (ad es. file o directory) esiste già.

Mapping HTTP: 409 Conflict
PERMISSION_DENIED

Il chiamante non dispone dell'autorizzazione per eseguire l'operazione specificata. PERMISSION_DENIED non deve essere utilizzato per i rifiuti causati dall'esaurimento di alcune risorse (utilizza invece RESOURCE_EXHAUSTED per questi errori). PERMISSION_DENIED non deve essere utilizzato se il chiamante non può essere identificato (utilizza UNAUTHENTICATED per questi errori). Questo codice di errore non implica che la richiesta sia valida o che l'entità richiesta esista o soddisfi altre precondizioni.

Mappatura HTTP: 403 - Non consentito
UNAUTHENTICATED

La richiesta non ha credenziali di autenticazione valide per l'operazione.

Mappatura HTTP: 401 - Non autorizzato
RESOURCE_EXHAUSTED

Alcune risorse sono esaurite, ad esempio una quota per utente o l'intero file system è esaurito.

Mapping HTTP: 429 Too Many Requests
FAILED_PRECONDITION

L'operazione è stata rifiutata perché il sistema non si trova nello stato richiesto per l'esecuzione dell'operazione. Ad esempio, la directory da eliminare non è vuota, un'operazione rmdir viene applicata a un elemento che non è una directory e così via.

Gli implementatori di servizi possono utilizzare le seguenti linee guida per decidere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE: (a) Utilizza UNAVAILABLE se il client può riprovare solo la chiamata non riuscita. (b) Utilizza ABORTED se il client deve riprovare a un livello superiore. Ad esempio, quando un test-and-set specificato dal client non riesce, indicando che il client deve riavviare una sequenza di lettura-modifica-scrittura. (c) Utilizza FAILED_PRECONDITION se il client non deve riprovare finché lo stato del sistema non è stato corretto in modo esplicito. Ad esempio, se un comando "rmdir" non va a buon fine perché la directory non è vuota, FAILED_PRECONDITION deve essere restituito perché il client non deve riprovare a meno che i file non vengano eliminati dalla directory.

Mapping HTTP: 400 Bad Request
ABORTED

L'operazione è stata interrotta, in genere a causa di un problema di concorrenza, ad esempio un errore di controllo del sequencer o un'interruzione della transazione.

Consulta le linee guida riportate sopra per decidere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE.

Mapping HTTP: 409 Conflict
OUT_OF_RANGE

L'operazione è stata tentata oltre l'intervallo valido. Ad esempio, cercare o leggere oltre la fine del file.

A differenza di INVALID_ARGUMENT, questo errore indica un problema che potrebbe essere risolto se lo stato del sistema cambia. Ad esempio, un file system a 32 bit genererà INVALID_ARGUMENT se gli viene chiesto di leggere a un offset non compreso nell'intervallo [0,2^32-1], ma genererà OUT_OF_RANGE se gli viene chiesto di leggere da un offset successivo alla dimensione corrente del file.

Esiste una sovrapposizione piuttosto ampia tra FAILED_PRECONDITION e OUT_OF_RANGE. Ti consigliamo di utilizzare OUT_OF_RANGE (l'errore più specifico) quando si applica, in modo che i chiamanti che scorrono uno spazio possano cercare facilmente un errore OUT_OF_RANGE per rilevare quando hanno terminato.

Mapping HTTP: 400 Bad Request
UNIMPLEMENTED

L'operazione non è implementata o non è supportata/abilitata in questo servizio.

Mappatura HTTP: 501 Not Implemented
INTERNAL

Errori interni. Ciò significa che alcuni invarianti previsti dal sistema sottostante sono stati violati. Questo codice di errore è riservato agli errori gravi.

Mapping HTTP: 500 Internal Server Error
UNAVAILABLE

Il servizio non è attualmente disponibile. Si tratta molto probabilmente di una condizione temporanea, che può essere corretta riprovando con un backoff. Tieni presente che non è sempre sicuro riprovare le operazioni non idempotenti.

Consulta le linee guida riportate sopra per decidere tra FAILED_PRECONDITION, ABORTED e UNAVAILABLE.

Mappatura HTTP: 503 Servizio non disponibile
DATA_LOSS

Perdita o danneggiamento dei dati non recuperabili.

Mapping HTTP: 500 Internal Server Error