Importante
Esta seção refere-se à versão de API 2011-12-05, que está obsoleta e não deve ser usada para novos aplicativos.
Para obter a documentação da API de baixo nível atual, consulte a Referência da API do Amazon DynamoDB.
Descrição
Retorna informações sobre a tabela, incluindo seu status atual, o esquema de chave primária e quando a tabela foi criada. Os resultados de DescribeTable são finais consistentes. Se você usar DescribeTable muito cedo no processo de criação de uma tabela, o DynamoDB retornará um ResourceNotFoundException. Se você usar DescribeTable muito cedo no processo de atualizar uma tabela, os novos valores talvez não estejam imediatamente disponíveis.
Solicitações
Sintaxe
// This header is abbreviated. // For a sample of a complete header, see API de baixo nível do DynamoDB. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.DescribeTable content-type: application/x-amz-json-1.0 {"TableName":"Table1"}
| Nome | Descrição | Obrigatório |
|---|---|---|
TableName
|
O nome da tabela a ser descrita. Tipo: string |
Sim |
Respostas
Sintaxe
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
Content-Length: 543
{"Table":
{"CreationDateTime":1.309988345372E9,
ItemCount:1,
"KeySchema":
{"HashKeyElement":{"AttributeName":"AttributeName1","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"AttributeName2","AttributeType":"N"}},
"ProvisionedThroughput":{"LastIncreaseDateTime": Date, "LastDecreaseDateTime": Date, "ReadCapacityUnits":10,"WriteCapacityUnits":10},
"TableName":"Table1",
"TableSizeBytes":1,
"TableStatus":"ACTIVE"
}
}| Nome | Descrição |
|---|---|
Table
|
O contêiner da tabela que está sendo descrita. Tipo: string |
CreationDateTime |
Data em que a tabela foi criada, no formato de tempo epoch UNIX |
ItemCount
|
Número de itens na tabela especificada. O DynamoDB atualiza esse valor aproximadamente a cada seis horas. Alterações recentes podem não ser refletidas nesse valor. Tipo: número |
KeySchema
|
A estrutura da chave primária (simples ou composta) da tabela. O par de nome-valor de HashKeyElement é obrigatório, e um par de nome-valor de RangeKeyElement é opcional (obrigatório apenas para chaves primárias compostas). O tamanho máximo da chave de hash é 2048 bytes. O tamanho máximo da chave de intervalo é 1024 bytes. Ambos os limites são aplicados separadamente (ou seja, você pode ter uma chave combinada de hash + intervalo 2048 + 1024). Para obter mais informações sobre chaves primárias, consulte Chave primária. |
ProvisionedThroughput
|
O throughput da tabela especificada, consistindo em valores para LastIncreaseDateTime (se aplicável), LastDecreaseDateTime (se aplicável), ReadCapacityUnits e WriteCapacityUnits. Se o throughput da tabela nunca tiver sido aumentada ou diminuída, o DynamoDB não retornará valores para esses elementos. Consulte Modo de capacidade provisionada do DynamoDB.Tipo: matriz |
TableName
|
O nome da tabela solicitada. Tipo: string |
TableSizeBytes
|
O tamanho total da tabela especificada, em bytes. O DynamoDB atualiza esse valor aproximadamente a cada seis horas. Alterações recentes podem não ser refletidas nesse valor. Tipo: número |
TableStatus
|
O estado atual da tabela (CREATING, ACTIVE, DELETING ou UPDATING). Quando a tabela estiver no estado ACTIVE, você poderá adicionar dados. |
Erros especiais
Nenhum erro é específico dessa operação.
Exemplos
Os exemplos a seguir mostram uma solicitação HTTP POST e uma resposta usando a operação DescribeTable para uma tabela chamada "comp-table". A tabela tem uma chave primária composta.
Exemplo de solicitação
// This header is abbreviated. // For a sample of a complete header, see API de baixo nível do DynamoDB. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.DescribeTable content-type: application/x-amz-json-1.0 {"TableName":"users"}
Exemplo de resposta
HTTP/1.1 200
x-amzn-RequestId: 8966d095-71e9-11e0-a498-71d736f27375
content-type: application/x-amz-json-1.0
content-length: 543
{"Table":
{"CreationDateTime":1.309988345372E9,
"ItemCount":23,
"KeySchema":
{"HashKeyElement":{"AttributeName":"user","AttributeType":"S"},
"RangeKeyElement":{"AttributeName":"time","AttributeType":"N"}},
"ProvisionedThroughput":{"LastIncreaseDateTime": 1.309988345384E9, "ReadCapacityUnits":10,"WriteCapacityUnits":10},
"TableName":"users",
"TableSizeBytes":949,
"TableStatus":"ACTIVE"
}
}Ações relacionadas
