DescribeTables - Amazon DynamoDB
DescriptionRequêtesRéponsesErreurs spécialesExemplesActions connexes

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

DescribeTables

Important

Cette section fait référence à l'API version 2011-12-05 qui est obsolète et ne doit pas être utilisée pour de nouvelles applications.

Pour une documentation sur l'API de bas niveau actuelle, consultez la Référence d'API Amazon DynamoDB.

Description

Renvoie des informations sur la table, dont son état actuel, son schéma de clé primaire et sa date de création. Les résultats de l'opération DescribeTable sont éventuellement cohérents. Si vous utilisez l'opération DescribeTable trop tôt dans le processus de création d'une table, DynamoDB renvoie une erreur ResourceNotFoundException. Si vous utilisez l'opération DescribeTable trop tôt dans le processus de mise à jour d'une table, il se peut que les nouvelles valeurs ne soient pas immédiatement disponibles.

Requêtes

Syntaxe

// This header is abbreviated. 
// For a sample of a complete header, see API de bas niveau de DynamoDB.
POST / HTTP/1.1 
x-amz-target: DynamoDB_20111205.DescribeTable
content-type: application/x-amz-json-1.0

{"TableName":"Table1"}
Name (Nom) Description Obligatoire
TableName

Nom de la table à décrire.

Type : String

Oui

Réponses

Syntaxe

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"
    }
}
Name (Nom) Description
Table

Conteneur pour la table décrite.

Type : String
CreationDateTime Date à laquelle la table a été créée au format d'heure UNIX.
ItemCount

Nombre d'éléments de la table spécifiée. DynamoDB met à jour cette valeur environ toutes les six heures. Il se peut que cette valeur ne reflète pas des modifications récentes.

Type : nombre
KeySchema Structure (simple ou composite) de la clé primaire pour la table. Une paire nom-valeur pour l'élément HashKeyElement est obligatoire, et une paire nom-valeur pour l'élément RangeKeyElement est facultatif (obligatoire uniquement pour les clés primaires composites). La taille maximum de clé de hachage est de 2 048 octets. La taille maximum de clé de plage est de 1 024 octets. Les deux limites sont appliquées séparément (c'est-à-dire que vous pouvez avoir une taille de clé combinée de hachage et de plage égale à 2 048 + 1 024 octets). Pour plus d'informations sur les clés primaires, consultez Clé primaire.
ProvisionedThroughput Débit de la table spécifiée, composé de valeurs pour LastIncreaseDateTime (le cas échéant), LastDecreaseDateTime (le cas échéant), ReadCapacityUnits et WriteCapacityUnits. Si le débit de la table n'a jamais été augmenté ou diminué, DynamoDB ne renvoie pas de valeurs pour ces éléments. Consultez Mode de capacité provisionnée DynamoDB.

Type : Array

TableName

Le nom de la table demandée.

Type : String
TableSizeBytes

Taille totale de la table spécifiée, en octets. DynamoDB met à jour cette valeur environ toutes les six heures. Il se peut que cette valeur ne reflète pas des modifications récentes.

Type : nombre
TableStatus État actuel de la table (CREATING, ACTIVE, DELETING ou UPDATING). Une fois la table dans l'état ACTIVE, vous pouvez ajouter des données.

Erreurs spéciales

Il n'existe pas d'erreur spécifique de cette opération.

Exemples

Les exemples suivants montrent une requête et une réponse HTTP POST utilisant l'opération DescribeTable pour une table nommée « comp-table ». La table a une clé primaire composite.

Exemple de demande

// This header is abbreviated. 
// For a sample of a complete header, see API de bas niveau de DynamoDB.
POST / HTTP/1.1 
x-amz-target: DynamoDB_20111205.DescribeTable
content-type: application/x-amz-json-1.0

{"TableName":"users"}

Exemple de réponse

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"
    }
}