중요
이 단원에서 언급되는 API 버전 2011-12-05는 사용 중단되었으며 새 애플리케이션에 사용해서는 안 됩니다.
현재 하위 수준 API에 대한 설명서는 Amazon DynamoDB API 참조 섹션을 참조하세요.
설명
현재 테이블 상태, 기본 키 스키마, 그리고 테이블 생성 날짜 등 테이블 관련 정보를 반환합니다. DescribeTable 결과는 최종 일관성을 따릅니다. 테이블 생성 프로세스에서 너무 일찍 DescribeTable을 사용하면 DynamoDB가 ResourceNotFoundException을 반환합니다. 그리고, 테이블 업데이트 프로세스에서 너무 일찍 DescribeTable을 사용할 때도 새로운 값이 바로 적용되지 않을 수도 있습니다.
요청
구문
// This header is abbreviated. // For a sample of a complete header, see DynamoDB 하위 수준 API. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.DescribeTable content-type: application/x-amz-json-1.0 {"TableName":"Table1"}
| 명칭 | 설명 | 필수 |
|---|---|---|
TableName
|
설명할 테이블 이름 유형: 문자열 |
예 |
응답
구문
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"
}
}| 명칭 | 설명 |
|---|---|
Table
|
설명할 테이블이 저장되는 컨테이너 유형: 문자열 |
CreationDateTime |
UNIX epoch 시간 |
ItemCount
|
지정된 테이블의 항목 수. DynamoDB는 약 6시간마다 이 값을 업데이트합니다. 최근 변경 사항이 이 값에 반영되지 않기도 합니다. 형식: 숫자 |
KeySchema
|
테이블의 기본 키(단순 또는 복합) 구조. HashKeyElement에서는 이름-값 페어가 필수이지만 RangeKeyElement에서는 선택 사항입니다(복합 기본 키의 경우에만 필요함). 최대 해시 키 크기는 2,048byte입니다. 최대 범위 키 크기는 1,024byte입니다. 두 키의 크기 제한은 별도로 적용됩니다(해시 + 범위 키 2,048 + 1,024 합산). 기본 키에 대한 자세한 내용은 프라이머리 키 단원을 참조하세요. |
ProvisionedThroughput
|
지정 테이블의 처리량으로 LastIncreaseDateTime 값(있는 경우), LastDecreaseDateTime 값(있는 경우), ReadCapacityUnits 값 및 WriteCapacityUnits 값으로 구성됩니다. 테이블의 처리량이 늘거나 줄지 않으면 DynamoDB도 해당 요소의 값을 반환하지 않습니다. DynamoDB 프로비저닝된 용량 모드 섹션을 참조하세요.유형: 배열 |
TableName
|
요청한 테이블 이름 유형: 문자열 |
TableSizeBytes
|
지정된 테이블의 총 크기(바이트). DynamoDB는 약 6시간마다 이 값을 업데이트합니다. 최근 변경 사항이 이 값에 반영되지 않기도 합니다. 형식: 숫자 |
TableStatus
|
현재 테이블 상태(CREATING, ACTIVE, DELETING 또는 UPDATING). 테이블이 ACTIVE 상태일 때만 데이터를 추가할 수 있습니다. |
특수 오류
이 작업에는 특정 오류가 없습니다.
예시
다음은 "comp-table"이라는 이름의 테이블에 대해 DescribeTable 작업을 사용해 HTTP POST 요청 및 응답을 나타낸 예제입니다. 테이블은 복합 기본 키를 갖고 있습니다.
샘플 요청
// This header is abbreviated. // For a sample of a complete header, see DynamoDB 하위 수준 API. POST / HTTP/1.1 x-amz-target: DynamoDB_20111205.DescribeTable content-type: application/x-amz-json-1.0 {"TableName":"users"}
샘플 응답
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"
}
}관련 작업
