DescribeDBClusters - Amazon DocumentDB

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

DescribeDBClusters

프로비저닝된 Amazon DocumentDB 클러스터에 대한 정보를 반환합니다. 이 API 작업은 페이지 매김을 지원합니다. 클러스터 및 인스턴스 수명 주기 관리와 같은 특정 관리 기능의 경우 Amazon DocumentDB는 Amazon RDS 및 Amazon Neptune과 공유되는 운영 기술을 활용합니다. filterName=engine,Values=docdb 필터 파라미터를 사용하면 Amazon DocumentDB 클러스터만 반환할 수 있습니다.

요청 파라미터

모든 작업에 공통으로 적용되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.

DBClusterIdentifier

사용자가 제공한 클러스터 식별자. 이 파라미터를 지정한 경우 바로 그 클러스터에서 온 정보만 반환됩니다. 이 파라미터는 대/소문자를 구분하지 않습니다.

제약 조건:

  • 제공된 경우 기존 DBClusterIdentifier과 일치해야 합니다.

타입: 문자열

필수사항: 아니요

Filters.Filter.N

설명할 클러스터를 하나 이상 지정하는 필터.

지원되는 필터:

  • db-cluster-id - 클러스터 식별자 및 클러스터의 Amazon 리소스 이름(ARN)을 사용할 수 있습니다. 결과 목록에는 이러한 ARN으로 식별된 클러스터에 대한 정보만 포함됩니다.

타입: Filter객체 배열

필수: 아니요

Marker

이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.

타입: 문자열

필수사항: 아니요

MaxRecords

응답에 포함되는 최대 레코드 수입니다. 지정된 MaxRecords 값보다 레코드 수가 많으면 마커라고 부르는 페이지 매김 토큰을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.

기본값: 100

제약: 최소 20, 최대 100입니다.

유형: 정수

필수 항목 여부: 아니요

Response Elements

서비스에서 반환되는 요소는 다음과 같습니다.

DBClusters.DBCluster.N

클러스터의 목록.

유형: DBCluster객체 어레이

Marker

이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.

타입: 문자열

Errors

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

DBClusterNotFoundFault

DBClusterIdentifier는 기존 클러스터를 참조하지 않습니다.

HTTP 상태 코드: 404

참고

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