DescribeDBInstances
프로비저닝된 Amazon DocumentDB 인스턴스에 대한 정보를 반환합니다. 이 API는 페이지 매김을 지원합니다.
요청 파라미터
모든 작업에 공통되는 파라미터에 대한 내용은 공통 파라미터를 참조하십시오.
- DBInstanceIdentifier
-
사용자가 제공한 인스턴스 식별자. 이 파라미터를 지정한 경우, 바로 그 인스턴스에서 온 정보만 반환됩니다. 이 파라미터는 대/소문자를 구분하지 않습니다.
제약 조건:
-
제공된 경우 기존
DBInstance의 식별자와 일치해야 합니다.
유형: 문자열
필수 항목 여부: 아니요
-
- Filters.Filter.N
-
설명할 인스턴스를 하나 이상 지정하는 필터입니다.
지원되는 필터:
-
db-cluster-id- 클러스터 식별자 및 클러스터 Amazon 리소스 이름(ARN)을 허용합니다. 결과 목록에는 이러한 ARN으로 식별된 클러스터와 연결되어 있는 인스턴스에 관한 정보만 포함됩니다. -
db-instance-id- 인스턴스 식별자 및 인스턴스 ARN을 허용합니다. 결과 목록에는 이러한 ARN으로 식별된 인스턴스에 대한 정보만 포함됩니다.
유형: Filter 객체 배열
필수 항목 여부: 아니요
-
- Marker
-
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터
MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.유형: 문자열
필수 항목 여부: 아니요
- MaxRecords
-
응답에 포함되는 최대 레코드 수입니다. 지정된
MaxRecords값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.기본값: 100
제약: 최소 20, 최대 100입니다.
유형: 정수
필수 항목 여부: 아니요
응답 요소
서비스에서 반환되는 요소는 다음과 같습니다.
- DBInstances.DBInstance.N
-
하나 이상의 인스턴스 세부 정보.
유형: DBInstance 객체 배열
- Marker
-
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터
MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.유형: 문자열
오류
모든 작업에 공동되는 오류에 대한 자세한 내용은 일반적인 오류을 참조하십시오.
- DBInstanceNotFound
-
DBInstanceIdentifier는 기존 인스턴스를 참조하지 않습니다.HTTP 상태 코드: 404
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
