Consulta todas as informações armazenadas sobre uma conta na rede. Os detalhes da conta retornados podem variar entre as chamadas, porque um endpoint pode encaminhar solicitações para diferentes validadores na rede e na região, e os validadores podem não estar no mesmo ID de rodada a qualquer momento.
Solicitação HTTP
GET https://universalledger.googleapis.com/v1/{endpoint=projects/*/locations/*/endpoints/*}:queryAccount Os URLs usam a sintaxe de Transcodificação gRPC.
Parâmetros de caminho
| Parâmetros | |
|---|---|
endpoint |
Obrigatório. O endpoint para atender à solicitação. Formato: |
Parâmetros de consulta
| Parâmetros | |
|---|---|
accountId |
Obrigatório. O ID da conta para receber informações. O valor é limitado a 60 caracteres. |
roundId |
Opcional. O ID da rodada de execução (semelhante à "altura" do bloco) em que os dados serão solicitados. As informações da conta retornadas serão precisas para o estado do mundo nessa rodada de execução. Se não for especificado, usará a última rodada finalizada conhecida pelo validador de serviço. O estado em um determinado ID de rodada é sempre consistente e canônico. |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Mensagem de resposta para "endpoints.queryAccount".
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
|---|
{
"account": {
object ( |
| Campos | |
|---|---|
account |
As informações da conta e a altura em que foram obtidas. |
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/cloud-platform
Para mais informações, consulte Authentication Overview.
Conta
Representa o estado de uma conta no livro razão.
| Representação JSON |
|---|
{ "sequenceNumber": string, "publicKey": string, "roundId": string, "comment": string, // Union field |
| Campos | |
|---|---|
sequenceNumber |
Apenas saída. O número de sequência desta conta. Esse número aumenta a cada transação enviada por essa conta. |
publicKey |
Apenas saída. A chave pública principal associada a esta conta, usada para verificação de assinatura. Uma string codificada em base64. |
roundId |
Apenas saída. O ID da rodada de execução (semelhante à "altura" do bloco) em que as informações da conta fornecidas estão corretas. |
comment |
Apenas saída. O comentário da conta armazenado quando ela foi criada. |
Campo de união account_details. Detalhes específicos com base no tipo de conta. account_details pode ser apenas de um dos tipos a seguir: |
|
userDetails |
Apenas saída. Detalhes de uma conta de usuário padrão. |
accountManagerDetails |
Apenas saída. Detalhes de uma conta de gerente de contas. |
tokenManagerDetails |
Apenas saída. Detalhes de uma conta de administrador de tokens. |
contractTokenManagerDetails |
Apenas saída. Detalhes de uma conta de administrador de token de contrato. |
contractDetails |
Apenas saída. Detalhes de uma conta de contrato inteligente. |
clearinghouseDetails |
Apenas saída. Detalhes de uma conta de compensação. |
currencyOperatorDetails |
Apenas saída. Detalhes de uma conta de operador de moeda. |
platformOperatorDetails |
Apenas saída. Detalhes de uma conta de operador da plataforma. |
UserDetails
Detalhes específicos de uma conta de usuário.
| Representação JSON |
|---|
{ "accountManager": { object ( |
| Campos | |
|---|---|
accountManager |
Apenas saída. Descontinuado: use |
accountManagerId |
Apenas saída. O ID do gerente de contas desse usuário. |
tokenManager |
Apenas saída. Descontinuado: use |
tokenManagerId |
Apenas saída. O ID do gerenciador de tokens para esse usuário. |
roles[] |
Apenas saída. A lista de papéis concedidos a essa conta. |
accountStatus |
Apenas saída. O status desta conta. |
balance |
Apenas saída. O saldo de tokens desta conta de usuário. |
accountFields |
Apenas saída. Descontinuado: use Um objeto com uma lista de pares |
contractAccountFields |
Apenas saída. Os campos da conta de contrato (ID do contrato -> campos) para este usuário. Um objeto com uma lista de pares |
Entidade
Uma entidade na rede do Universal Ledger. Todas as contas estão vinculadas a uma entidade. O ID da entidade, também chamado de ID da conta, é exclusivo e imutável em toda a rede.
| Representação JSON |
|---|
{ "id": string } |
| Campos | |
|---|---|
id |
Apenas saída. O ID atribuído à entidade. Ele é atribuído pela rede na criação da conta. |
Papel
O conjunto regular de papéis.
| Tipos enumerados | |
|---|---|
ROLE_UNSPECIFIED |
Função inválida. |
ROLE_PAYER |
A função que permite que uma conta inicie uma transação de pagamento. |
ROLE_RECEIVER |
A função que permite que uma conta receba pagamentos. |
ROLE_CONTRACT_CREATOR |
O papel que permite que uma conta implante contratos. |
ROLE_CONTRACT_PARTICIPANT |
A função que permite que uma conta interaja com contratos implantados. |
AccountStatus
O status de uma conta.
| Tipos enumerados | |
|---|---|
ACCOUNT_STATUS_UNSPECIFIED |
Status inválido. |
ACCOUNT_STATUS_ACTIVE |
Estado ativo em que a conta pode realizar as operações permitidas pelas funções dela. |
ACCOUNT_STATUS_INACTIVE |
Estado inativo em que todas as transações na conta são proibidas. O gerente da conta ainda pode enviar transações de gerenciamento de conta. |
CurrencyValue
Representa um valor monetário (ou seja, dinheiro). A moeda denominada não está incluída nesta mensagem. A moeda relevante é decidida pela conta que envia a transação. Cada conta tem uma moeda imutável exclusiva associada a ela.
| Representação JSON |
|---|
{ "value": string } |
| Campos | |
|---|---|
value |
Obrigatório. O número de unidades menores da moeda. Essa menor denominação válida é chamada de "unidades secundárias" e é especificada na ISO 4217. Por exemplo, para USD, o valor será o número de centavos, e para GBP, o número de pence. Para o iene japonês, que não tem uma unidade menor, será o número de ienes. |
Campos
Um mapa de campos (nome do campo -> valor) de um contrato usado para representar campos de contrato ou de conta.
| Representação JSON |
|---|
{
"fields": {
string: {
object ( |
| Campos | |
|---|---|
fields |
Apenas saída. O mapa de nomes de campos para os respectivos valores. Um objeto com uma lista de pares |
Valor
Um valor concreto de algum tipo.
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união value. O valor real. value pode ser apenas de um dos tipos a seguir: |
|
noneValue |
Opcional. Representa um valor "None". |
boolValue |
Opcional. Um valor booleano. |
int64Value |
Opcional. Um valor int64. |
stringValue |
Opcional. Um valor de string. |
accountId |
Opcional. Um ID da conta. |
dictValue |
Opcional. Um valor de dicionário. |
qualifiedCurrencyValue |
Opcional. Um valor de moeda qualificado. |
amountValue |
Opcional. Um valor de quantia. |
NoneValue
Uma enumeração singleton para representar o valor None.
| Tipos enumerados | |
|---|---|
NONE_VALUE_UNSPECIFIED |
O valor "None". |
DictValue
Os índices mapeiam a chave para o valor. Por exemplo, a chave keys[0] é mapeada para values[0].
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união keys. Cada chave pode ser de apenas um tipo. keys pode ser apenas de um dos tipos a seguir: |
|
boolKeys |
Opcional. Uma lista de chaves booleanas. |
stringKeys |
Opcional. Uma lista de chaves de string. |
int64Keys |
Opcional. Uma lista de chaves int64. |
accountIdKeys |
Opcional. Uma lista de chaves de ID da conta. |
Campo de união values. Cada valor pode ser de um tipo. values pode ser apenas de um dos tipos a seguir: |
|
boolValues |
Opcional. Uma lista de valores booleanos. |
stringValues |
Opcional. Uma lista de valores de string. |
int64Values |
Opcional. Uma lista de valores int64. |
dictValues |
Opcional. Os valores são uma lista de dicionários aninhados. |
BoolList
Uma lista de booleanos.
| Representação JSON |
|---|
{ "values": [ boolean ] } |
| Campos | |
|---|---|
values[] |
Opcional. Os valores booleanos. |
StringList
Uma lista de strings.
| Representação JSON |
|---|
{ "values": [ string ] } |
| Campos | |
|---|---|
values[] |
Opcional. Os valores de string. |
Int64List
Uma lista de int64s.
| Representação JSON |
|---|
{ "values": [ string ] } |
| Campos | |
|---|---|
values[] |
Opcional. Os valores int64. |
AccountIdList
Uma lista de IDs de contas.
| Representação JSON |
|---|
{ "values": [ string ] } |
| Campos | |
|---|---|
values[] |
Opcional. Os valores de ID da conta. |
DictList
Uma lista de dicionários.
| Representação JSON |
|---|
{
"values": [
{
object ( |
| Campos | |
|---|---|
values[] |
Opcional. Os valores DictValue. Todos os dicionários aninhados precisam ter o mesmo tipo concreto. |
QualifiedCurrencyValue
Representa uma moeda no livro razão, qualificada pelo operador de moeda.
| Representação JSON |
|---|
{ "operatorId": string } |
| Campos | |
|---|---|
operatorId |
Obrigatório. O ID do operador de moeda que administra a moeda. |
AmountValue
Representa um valor denominado em uma moeda.
| Representação JSON |
|---|
{
"currency": {
object ( |
| Campos | |
|---|---|
currency |
Obrigatório. A moeda do valor. |
amountValue |
Obrigatório. O número de unidades menores da moeda. |
AccountManagerDetails
Detalhes específicos de um gerente de contas.
| Representação JSON |
|---|
{
"tokenManager": {
object ( |
| Campos | |
|---|---|
tokenManager |
Apenas saída. Descontinuado: use |
numAccounts |
Apenas saída. O número de contas criadas por esse gerente de contas. |
tokenManagerId |
Apenas saída. O ID do gerenciador de tokens padrão para contas criadas por este gerente de contas. |
TokenManagerDetails
Detalhes específicos de um gerenciador de tokens.
| Representação JSON |
|---|
{ "issuanceLimit": { object ( |
| Campos | |
|---|---|
issuanceLimit |
Apenas saída. A quantidade de tokens que este gerenciador de tokens pode criar. |
issuedTokens |
Apenas saída. A quantidade de tokens gerados por este gerenciador de tokens. Esse número aumenta quando a cunhagem é feita e diminui quando a queima é realizada. |
ContractTokenManagerDetails
Detalhes específicos de um gerenciador de tokens de contrato.
| Representação JSON |
|---|
{ "issuanceLimit": { object ( |
| Campos | |
|---|---|
issuanceLimit |
Apenas saída. A quantidade de tokens que este gerenciador de tokens de contrato pode oferecer suporte. Como os gerentes de tokens de contrato não podem aumentar ou diminuir o limite de emissão, ele precisa ser igual a |
issuedTokens |
Apenas saída. A quantidade de tokens que este gerenciador de tokens de contrato está oferecendo suporte (ou seja, sua responsabilidade total). Isso equivale à soma de todos os saldos mantidos em contratos para a moeda, mais a posição líquida na matriz de liquidação. |
previousContractTokenManagerId |
Apenas saída. O ID da conta do gerenciador de tokens de contrato anterior para essa moeda. Isso forma uma trilha de auditoria que pode ser percorrida para descobrir todos os gerentes anteriores. Se este for o primeiro gerenciador de tokens de contrato para a moeda, ele vai estar vazio. |
accountStatus |
Apenas saída. O status desta conta. |
ContractDetails
Detalhes específicos de um contrato inteligente.
| Representação JSON |
|---|
{ "owner": { object ( |
| Campos | |
|---|---|
owner |
Apenas saída. Descontinuado: use |
ownerId |
Apenas saída. O ID do proprietário do contrato. |
code |
Apenas saída. O código do contrato serializado. Uma string codificada em base64. |
contractFields |
Apenas saída. Os campos do contrato (nome do campo -> valor). |
currencyBalances |
Apenas saída. Os saldos de moeda mantidos pelo contrato (operador de moeda -> saldo). Um objeto com uma lista de pares |
ClearingHouseDetails
Detalhes específicos de uma Clearinghouse.
| Representação JSON |
|---|
{ "accountStatus": enum ( |
| Campos | |
|---|---|
accountStatus |
Apenas saída. O status desta conta. |
balances[] |
Apenas saída. Os saldos que essa câmara de compensação está rastreando para liquidação. |
settlementMode |
Apenas saída. O modo de liquidação dessa câmara de compensação. |
BalanceToSettle
Um saldo a ser liquidado entre dois gerenciadores de tokens.
| Representação JSON |
|---|
{ "balancePayer": { object ( |
| Campos | |
|---|---|
balancePayer |
Apenas saída. Descontinuado: use |
balancePayerId |
Apenas saída. O ID da conta que deve o saldo a ser liquidado. |
balanceReceiver |
Apenas saída. Descontinuado: use |
balanceReceiverId |
Apenas saída. O ID da conta que deve receber o saldo a ser liquidado. |
balance |
Apenas saída. O saldo a ser liquidado. Precisa ser positivo. |
SettlementMode
O modo de liquidação de uma câmara de compensação.
| Tipos enumerados | |
|---|---|
SETTLEMENT_MODE_UNSPECIFIED |
O modo de liquidação não foi especificado. Esse valor é inválido e não deve ser usado. |
SETTLEMENT_MODE_DEFERRED |
A câmara de compensação é responsável por rastrear a propriedade dos fundos fora do livro-razão e emitir periodicamente transações SettlementRequest para manter os saldos correspondentes no livro-razão sincronizados. |
SETTLEMENT_MODE_INSTANT |
A câmara de compensação mantém um único pool de fundos, e o razão atua como a fonte principal para a alocação desses fundos entre os gerenciadores de tokens. Esse modo de liquidação também pode ser descrito como "liquidação bruta instantânea". |
CurrencyOperatorDetails
Detalhes específicos de um operador de moeda.
| Representação JSON |
|---|
{ "currency": string, "currencyCode": string, "accountStatus": enum ( |
| Campos | |
|---|---|
currency |
Apenas saída. Descontinuado: use |
currencyCode |
Apenas saída. O ID da moeda associada a esta conta, representado pelo código ISO 4217 de três letras. |
accountStatus |
Apenas saída. O status desta conta. |
previousEntityId |
Apenas saída. Descontinuado: use |
previousCurrencyOperatorId |
Apenas saída. O ID do operador de moeda anterior que transferiu a propriedade da função de operador de moeda para esta conta. Se for o primeiro operador de moeda para a moeda, esse campo vai estar vazio. |
platformOperatorEntityId |
Apenas saída. Descontinuado: use |
platformOperatorId |
Apenas saída. O ID do operador da plataforma que criou esse operador de moeda. |
contractTokenManager |
Apenas saída. Descontinuado: use |
contractTokenManagerId |
Apenas saída. O ID do gerenciador de tokens de contrato associado a esse operador de moeda. |
clearinghouseId |
Apenas saída. O ID da câmara de compensação associada a esse operador de moeda. |
PlatformOperatorDetails
Detalhes específicos de um operador de plataforma.
| Representação JSON |
|---|
{ "accountStatus": enum ( |
| Campos | |
|---|---|
accountStatus |
Apenas saída. O status desta conta. |
previousEntityId |
Apenas saída. Descontinuado: use |
previousPlatformOperatorId |
Apenas saída. O ID do operador da plataforma anterior que transferiu a propriedade da função de operador da plataforma para esta conta. Se for o primeiro operador de plataforma, esse campo vai estar vazio. |