DescribeDBClusterSnapshots
클러스터 스냅샷에 대한 정보를 반환합니다. API 작업은 페이지 매김을 지원합니다.
요청 파라미터
모든 작업에 공통되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.
- DBClusterIdentifier
-
클러스터 스냅샷의 목록을 검색할 클러스터의 ID. 이 파라미터는
DBClusterSnapshotIdentifier파라미터와 함께 사용할 수 없습니다. 이 파라미터는 대소문자를 구분하지 않습니다.제약 조건:
-
제공된 경우 기존
DBCluster의 식별자와 일치해야 합니다.
유형: 문자열
필수 여부: 아니요
-
- DBClusterSnapshotIdentifier
-
설명할 특정 클러스터 스냅샷 식별자. 이 파라미터는
DBClusterIdentifier파라미터와 함께 사용할 수 없습니다. 이 값은 소문자 문자열로 저장됩니다.제약 조건:
-
제공된 경우 기존
DBClusterSnapshot의 식별자와 일치해야 합니다. -
이 식별자가 자동화된 스냅샷의 식별자인 경우,
SnapshotType파라미터도 지정해야 합니다.
유형: 문자열
필수 여부: 아니요
-
- Filters.Filter.N
-
현재 지원되지 않는 파라미터입니다.
타입: Filter객체 배열
필수 여부: 아니요
- IncludePublic
-
퍼블릭이고 임의의 AWS 계정에 의해 복사 또는 복원될 수 있는 수동 클러스터 스냅샷을 포함하려면
true로 설정하고, 그렇지 않으면false으로 설정합니다. 기본값은false입니다.유형: 부울
필수 여부: 아니요
- IncludeShared
-
이 AWS 계정이 복사 또는 복원 권한을 부여하는 다른 AWS 계정의 공유 수동 클러스터 스냅샷을 포함하려면
true로 설정하고, 그렇지 않으면false로 설정합니다. 기본값은false입니다.유형: 부울
필수 여부: 아니요
- Marker
-
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터
MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.유형: 문자열
필수 여부: 아니요
- MaxRecords
-
응답에 포함되는 최대 레코드 수입니다. 지정된
MaxRecords값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.기본값: 100
제약: 최소 20, 최대 100입니다.
유형: Integer
필수 여부: 아니요
- SnapshotType
-
반환되는 클러스터 스냅샷의 유형. 다음 값 중 하나를 지정할 수 있습니다.
-
automated- Amazon DocumentDB가 AWS 계정를 위해 자동으로 생성한 모든 클러스터 스냅샷을 반환합니다. -
manual- AWS 계정를 위해 수동으로 생성한 모든 클러스터 스냅샷을 반환합니다. -
shared- AWS 계정에 공유된 모든 수동 클러스터 스냅샷을 반환합니다. -
public- 퍼블릭으로 표시된 클러스터 스냅샷을 모두 반환합니다.
SnapshotType값을 지정하지 않으면 자동 및 수동 클러스터 스냅샷이 모두 반환됩니다.IncludeShared파라미터를true로 설정하여 이러한 결과에 공유 클러스터 스냅샷을 포함시킬 수 있습니다.IncludePublic파라미터를true로 설정하여 이러한 결과에 퍼블릭 클러스터 스냅샷을 포함시킬 수 있습니다.IncludeShared값이IncludePublic또는SnapshotType인 경우manual및automated파라미터는 적용되지 않습니다.IncludePublic이SnapshotType로 설정된 경우shared파라미터는 적용되지 않습니다.IncludeShared이SnapshotType로 설정된 경우public파라미터는 적용되지 않습니다.유형: 문자열
필수 여부: 아니요
-
응답 요소
서비스에서 반환되는 요소는 다음과 같습니다.
- DBClusterSnapshots.DBClusterSnapshot.N
-
클러스터 스냅샷의 목록을 제공합니다.
타입: DBClusterSnapshot객체 배열
- Marker
-
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터
MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.유형: 문자열
오류
모든 작업에 공통되는 오류에 대한 내용은 일반적인 오류 섹션을 참조하십시오.
- DBClusterSnapshotNotFoundFault
-
DBClusterSnapshotIdentifier은 기존 클러스터 스냅샷을 참조하지 않습니다.HTTP 상태 코드: 404
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
