ListClusterSnapshots - Amazon DocumentDB

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

ListClusterSnapshots

지정된 탄력적 클러스터의 스냅샷에 대한 정보를 반환합니다.

Request Syntax

GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1

URI 요청 파라미터

요청은 다음 URI 파라미터를 사용합니다.

clusterArn

탄력적 클러스터의 ARN 식별자.

maxResults

응답에 수신될 최대 탄력적 클러스터 스냅샷 결과의 수.

유효한 범위: 최소값은 20입니다. 최댓값은 100입니다.

nextToken

이전의 요청에서 제공된 페이지 매김 토큰. 이 파라미터가 지정된 경우 응답에는 이 토큰을 넘어 max-results에 의해 지정된 값까지의 레코드만 포함됩니다.

응답에 더 이상 데이터가 없는 경우 nextToken은 반환되지 않습니다.

snapshotType

반환되는 클러스터 스냅샷의 유형. 다음 값 중 하나를 지정할 수 있습니다.

  • automated- Amazon DocumentDB가 사용자 계정에 대해 자동으로 생성한 모든 클러스터 스냅샷을 반환합니다. AWS

  • manual- 계정용으로 수동으로 생성한 모든 클러스터 스냅샷을 반환합니다. AWS

Request Body

해당 요청에는 본문이 없습니다.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "snapshots": [ { "clusterArn": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "status": "string" } ] }

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

nextToken

이전의 요청에서 제공된 페이지 매김 토큰. 이 파라미터가 지정된 경우 응답에는 이 토큰을 넘어 max-results에 의해 지정된 값까지의 레코드만 포함됩니다.

응답에 더 이상 데이터가 없는 경우 nextToken은 반환되지 않습니다.

타입: 문자열

snapshots

지정된 탄력적 클러스터의 스냅샷 목록.

타입: ClusterSnapshotInList 객체 배열

Errors

모든 작업에 공통되는 오류에 대한 내용은 일반적인 오류 단원을 참조하십시오.

AccessDeniedException

작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.

HTTP 상태 코드: 403

InternalServerException

내부 서버 오류가 발생했습니다.

HTTP 상태 코드: 500

ThrottlingException

ThrottlingException 요청 제한으로 인해 요청이 거부되면 발생합니다.

HTTP 상태 코드: 429

ValidationException

유효성 검사 예외를 정의하는 구조.

HTTP 상태 코드: 400

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.