DescribeTables - Amazon DynamoDB
DescripciónSolicitudesRespuestasErrores especialesEjemplosAcciones relacionadas

DescribeTables

importante

Esta sección se refiere a la versión 2011-12-05 del API, que está obsoleta y no debe utilizarse para nuevas aplicaciones.

Para consultar la documentación sobre la API de bajo nivel actual, consulte la Referencia de la API de Amazon DynamoDB.

Descripción

Devuelve información sobre la tabla, incluyendo su estado actual, el esquema de clave principal y el momento de creación. Los resultados de DescribeTable son eventualmente consistentes. Si utiliza DescribeTable demasiado pronto en el proceso de creación de una tabla, DynamoDB devuelve una ResourceNotFoundException. Si utiliza DescribeTable demasiado pronto en el proceso de actualización de una tabla, los nuevos valores podrían no estar disponibles inmediatamente.

Solicitudes

Sintaxis

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

{"TableName":"Table1"}
Nombre Descripción Obligatorio
TableName

Nombre de la tabla que se describe.

Tipo: cadena

Sí

Respuestas

Sintaxis

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"
    }
}
Nombre Descripción
Table

Contenedor de la tabla que se describe.

Tipo: cadena
CreationDateTime Fecha en que se creó la tabla en formato de tiempo UNIX.
ItemCount

Cantidad de elementos de la tabla especificada. DynamoDB actualiza este valor aproximadamente cada seis horas. Los cambios recientes podrían no reflejarse en este valor.

Tipo: Number
KeySchema Estructura de la clave principal (simple o compuesta) de la tabla. Se requiere un par de nombre-valor de HashKeyElement, pero el par de nombre-valor de RangeKeyElement es opcional (solo es obligatorio para las claves principales compuestas). El tamaño máximo de la clave hash es de 2048 bytes. El tamaño máximo de la clave de rango es de 1024 bytes. Ambos límites se aplican por separado (es decir, puede disponer de una clave combinada de rango y hash de 2048+1024). Para obtener más información sobre claves principales, consulte Clave principal.
ProvisionedThroughput Rendimiento de la tabla especificada, que consta de los valores de LastIncreaseDateTime (si procede), LastDecreaseDateTime (si procede), ReadCapacityUnits y WriteCapacityUnits. Si el rendimiento de la tabla no se ha aumentado ni disminuido, DynamoDB no devuelve valores para estos elementos. Consulte Modo de capacidad aprovisionada de DynamoDB.

Tipo: matriz

TableName

Nombre de la tabla solicitada.

Tipo: cadena
TableSizeBytes

Tamaño total de la tabla especificada, en bytes. DynamoDB actualiza este valor aproximadamente cada seis horas. Los cambios recientes podrían no reflejarse en este valor.

Tipo: Number
TableStatus Estado actual de la tabla (CREATING, ACTIVE, DELETING o UPDATING). Una vez que la tabla adquiere el estado ACTIVE, puede agregarle datos.

Errores especiales

No hay errores específicos de esta operación.

Ejemplos

En los siguientes ejemplos se muestran una solicitud y una respuesta HTTP POST aplicando la operación DescribeTable a una tabla denominada "comp-table". La tabla tiene una clave principal compuesta.

Solicitud de muestra

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

{"TableName":"users"}

Respuesta de ejemplo

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