DescribeSnapshots - Amazon MemoryDB
구문 요청요청 파라미터응답 구문Response ElementsErrors참고

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

DescribeSnapshots

클러스터 스냅샷에 대한 정보를 반환합니다. 기본적으로 는 모든 스냅샷을 DescribeSnapshots 나열합니다. 선택적으로 단일 스냅샷을 설명하거나 특정 클러스터와 연결된 스냅샷만 설명할 수 있습니다.

구문 요청

{
   "ClusterName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ShowDetail": boolean,
   "SnapshotName": "string",
   "Source": "string"
}

요청 파라미터

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

요청은 JSON 형식의 다음 데이터를 수락합니다.

ClusterName

사용자가 제공한 클러스터 식별자입니다. 이 파라미터를 지정하면 해당 특정 클러스터와 관련된 스냅샷만 설명됩니다.

유형: 문자열

필수 항목 여부: 아니요

MaxResults

응답에 포함되는 최대 레코드 수입니다. 지정된 MaxResults 값보다 많은 레코드가 있는 경우 나머지 결과를 검색할 수 있도록 응답에 토큰이 포함됩니다.

유형: 정수

필수 항목 여부: 아니요

NextToken

총 레코드 수가 값을 초과하는 경우 전달할 선택적 인수입니다 MaxResults. nextToken 가 반환되면 더 많은 결과를 사용할 수 있습니다. 의 값은 각 페이지의 고유한 페이지 매김 토큰 nextToken 입니다. 반환된 토큰을 사용하여 다시 호출하여 다음 페이지를 검색합니다. 다른 모든 인수는 변경하지 않고 유지합니다.

유형: 문자열

필수 항목 여부: 아니요

ShowDetail

true인 경우 샤드 구성이 스냅샷 설명에 포함되는 부울 값입니다.

타입: 부울

필수 항목 여부: 아니요

SnapshotName

스냅샷의 사용자 제공 이름입니다. 이 파라미터를 지정하면 이름이 지정된 이 스냅샷만 설명됩니다.

유형: 문자열

필수 항목 여부: 아니요

Source

system으로 설정하면 MemoryDB에서 자동으로 만든 스냅샷이 출력에 표시됩니다. user로 설정하면 출력에 수동으로 만든 스냅샷이 표시됩니다. 생략하면 출력에 자동 및 수동으로 생성된 스냅샷이 모두 표시됩니다.

유형: 문자열

필수사항: 아니요

응답 구문

{
   "NextToken": "string",
   "Snapshots": [ 
      { 
         "ARN": "string",
         "ClusterConfiguration": { 
            "Description": "string",
            "Engine": "string",
            "EngineVersion": "string",
            "MaintenanceWindow": "string",
            "Name": "string",
            "NodeType": "string",
            "NumShards": number,
            "ParameterGroupName": "string",
            "Port": number,
            "Shards": [ 
               { 
                  "Configuration": { 
                     "ReplicaCount": number,
                     "Slots": "string"
                  },
                  "Name": "string",
                  "Size": "string",
                  "SnapshotCreationTime": number
               }
            ],
            "SnapshotRetentionLimit": number,
            "SnapshotWindow": "string",
            "SubnetGroupName": "string",
            "TopicArn": "string",
            "VpcId": "string"
         },
         "DataTiering": "string",
         "KmsKeyId": "string",
         "Name": "string",
         "Source": "string",
         "Status": "string"
      }
   ]
}

Response Elements

작업이 성공하면 서비스가 HTTP 200개의 응답을 다시 보냅니다.

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

NextToken

총 레코드 수가 값을 초과하는 경우 전달할 선택적 인수입니다 MaxResults. nextToken 가 반환되면 더 많은 결과를 사용할 수 있습니다. 의 값은 각 페이지의 고유한 페이지 매김 토큰 nextToken 입니다. 반환된 토큰을 사용하여 다시 호출하여 다음 페이지를 검색합니다. 다른 모든 인수는 변경하지 않고 유지합니다.

유형: 문자열

Snapshots

스냅샷 목록입니다. 목록의 각 항목에는 하나의 스냅샷에 대한 세부 정보가 포함되어 있습니다.

타입: Snapshot 객체 배열

Errors

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

InvalidParameterCombinationException

HTTP 상태 코드: 400

InvalidParameterValueException

HTTP 상태 코드: 400

ServiceLinkedRoleNotFoundFault

HTTP 상태 코드: 400

SnapshotNotFoundFault

HTTP 상태 코드: 400

참고

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