GetRevision - Banco de dados Amazon Quantum Ledger (AmazonQLDB)

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

GetRevision

Retorna um objeto de dados de revisão para uma ID do documento e endereço do bloco especificados. Também devolve uma prova da revisão especificada para verificação, se DigestTipAddress for fornecida.

Sintaxe da Solicitação

POST /ledgers/name/revision HTTP/1.1 Content-type: application/json { "BlockAddress": { "IonText": "string" }, "DigestTipAddress": { "IonText": "string" }, "DocumentId": "string" }

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

name

O nome do ledger.

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 32.

Padrão: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Exigido: Sim

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

BlockAddress

A localização do bloco de diário da revisão do documento a ser verificada. Um endereço é uma estrutura Amazon Ion que tem dois campos: strandId e sequenceNo.

Por exemplo: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.

Tipo: objeto ValueHolder

Obrigatório: Sim

DigestTipAddress

O último local do bloco coberto pelo resumo para o qual solicitar uma prova. Um endereço é uma estrutura Amazon Ion que tem dois campos: strandId e sequenceNo.

Por exemplo: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.

Tipo: objeto ValueHolder

Obrigatório: Não

DocumentId

O UUID (representado em texto codificado em Base62) do documento a ser verificado.

Tipo: sequência

Restrições de comprimento: comprimento fixo de 22.

Padrão: ^[A-Za-z-0-9]+$

Exigido: Sim

Sintaxe da Resposta

HTTP/1.1 200 Content-type: application/json { "Proof": { "IonText": "string" }, "Revision": { "IonText": "string" } }

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

Proof

O objeto de prova no formato Amazon Ion retornado por uma solicitação GetRevision. Uma prova contém a lista de valores de hash necessários para recalcular o resumo especificado usando uma árvore Merkle, começando com a revisão do documento especificada.

Tipo: objeto ValueHolder

Revision

O objeto de dados de revisão do documento no formato Amazon Ion.

Tipo: objeto ValueHolder

Erros

Para obter informações sobre os erros comuns que são comuns a todas as ações, consulte Erros comuns.

InvalidParameterException

Um ou mais parâmetros na solicitação não são válidos.

Código de Status HTTP: 400

ResourceNotFoundException

O recurso especificado não existe.

Código de Status HTTP: 404

ResourcePreconditionNotMetException

A operação falhou porque uma condição não foi satisfeita com antecedência.

Código de status HTTP: 412

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: