Get Ledger Entry - Get Ledger Entry

Serviço:

Azure confidential ledger

Versão da API:

2022-05-13

Obtém a entrada do razão na ID de transação especificada. Opcionalmente, uma ID de coleção pode ser especificada para indicar a coleção da qual buscar o valor.
Para retornar entradas de razão mais antigas, as seções relevantes do razão devem ser lidas do disco e validadas. Para evitar o bloqueio dentro do enclave, a resposta indicará se a entrada está pronta e parte da resposta ou se o carregamento ainda está em andamento.

GET {ledgerEndpoint}/app/transactions/{transactionId}?api-version=2022-05-13

Com parâmetros opcionais:

GET {ledgerEndpoint}/app/transactions/{transactionId}?api-version=2022-05-13&collectionId={collectionId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ledgerEndpoint	path	True	string (url)	A URL do Razão Confidencial, por exemplo, https://contoso.confidentialledger.azure.com
transactionId	path	True	string	Identifica uma transação de gravação.
api-version	query	True	string	A versão da API a ser usada com a solicitação HTTP.
collectionId	query		string	A ID da coleção.

Respostas

Nome	Tipo	Description
200 OK	LedgerQueryResult	O resultado da consulta do Razão Confidencial.
Other Status Codes	ConfidentialLedgerError	Resposta de erro que descreve por que a operação falhou.

Exemplos

GetLedgerEntry

Solicitação de exemplo

HTTP

GET {ledgerEndpoint}/app/transactions/3.14?api-version=2022-05-13

Resposta de exemplo

Código de status:

200

{
  "state": "Ready",
  "entry": {
    "contents": "Ledger entry contents at transaction id 3.14.",
    "collectionId": "DEFAULT_SUBLEDGER",
    "transactionId": "3.14"
  }
}

Definições

Nome	Description
ConfidentialLedgerError	Uma resposta de erro do Razão Confidencial.
ConfidentialLedgerErrorBody	Uma resposta de erro do Razão Confidencial.
ConfidentialLedgerQueryState	Estado de uma consulta do razão.
LedgerEntry	Uma entrada no razão.
LedgerQueryResult	O resultado da consulta de uma entrada do razão de uma ID de transação mais antiga. A entrada do razão estará disponível na resposta somente se o estado retornado estiver pronto.

ConfidentialLedgerError

Objeto

Uma resposta de erro do Razão Confidencial.

Nome	Tipo	Description
error	ConfidentialLedgerErrorBody	Uma resposta de erro do Razão Confidencial.

ConfidentialLedgerErrorBody

Objeto

Uma resposta de erro do Razão Confidencial.

Nome	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.

ConfidentialLedgerQueryState

Enumeração

Estado de uma consulta do razão.

Valor	Description
Loading
Ready

LedgerEntry

Objeto

Uma entrada no razão.

Nome	Tipo	Description
collectionId	string
contents	string	Conteúdo da entrada do razão.
transactionId	string	Um identificador exclusivo para o estado do razão. Se retornado como parte de um LedgerEntry, ele indica o estado do qual a entrada foi lida.

LedgerQueryResult

Objeto

O resultado da consulta de uma entrada do razão de uma ID de transação mais antiga. A entrada do razão estará disponível na resposta somente se o estado retornado estiver pronto.

Nome	Tipo	Description
entry	LedgerEntry	A entrada do razão encontrada como resultado da consulta. Isso só estará disponível se a consulta estiver no estado Pronto.
state	ConfidentialLedgerQueryState	Estado de uma consulta do razão.