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

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

DescribeClusters

클러스터 식별자가 지정되지 않은 경우 프로비저닝된 모든 클러스터에 대한 정보를 반환하고, 클러스터 이름이 제공된 경우 특정 클러스터에 대한 정보를 반환합니다.

구문 요청

{
   "ClusterName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ShowShardDetails": boolean
}

요청 파라미터

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

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

ClusterName

클러스터의 이름입니다

유형: 문자열

필수 항목 여부: 아니요

MaxResults

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

유형: 정수

필수 항목 여부: 아니요

NextToken

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

유형: 문자열

필수 항목 여부: 아니요

ShowShardDetails

개별 샤드에 대한 정보를 검색하기 위한 요청에 포함할 수 있는 선택적 플래그입니다.

타입: 부울

필수 항목 여부: 아니요

응답 구문

{
   "Clusters": [ 
      { 
         "ACLName": "string",
         "ARN": "string",
         "AutoMinorVersionUpgrade": boolean,
         "AvailabilityMode": "string",
         "ClusterEndpoint": { 
            "Address": "string",
            "Port": number
         },
         "DataTiering": "string",
         "Description": "string",
         "Engine": "string",
         "EnginePatchVersion": "string",
         "EngineVersion": "string",
         "KmsKeyId": "string",
         "MaintenanceWindow": "string",
         "Name": "string",
         "NodeType": "string",
         "NumberOfShards": number,
         "ParameterGroupName": "string",
         "ParameterGroupStatus": "string",
         "PendingUpdates": { 
            "ACLs": { 
               "ACLToApply": "string"
            },
            "Resharding": { 
               "SlotMigration": { 
                  "ProgressPercentage": number
               }
            },
            "ServiceUpdates": [ 
               { 
                  "ServiceUpdateName": "string",
                  "Status": "string"
               }
            ]
         },
         "SecurityGroups": [ 
            { 
               "SecurityGroupId": "string",
               "Status": "string"
            }
         ],
         "Shards": [ 
            { 
               "Name": "string",
               "Nodes": [ 
                  { 
                     "AvailabilityZone": "string",
                     "CreateTime": number,
                     "Endpoint": { 
                        "Address": "string",
                        "Port": number
                     },
                     "Name": "string",
                     "Status": "string"
                  }
               ],
               "NumberOfNodes": number,
               "Slots": "string",
               "Status": "string"
            }
         ],
         "SnapshotRetentionLimit": number,
         "SnapshotWindow": "string",
         "SnsTopicArn": "string",
         "SnsTopicStatus": "string",
         "Status": "string",
         "SubnetGroupName": "string",
         "TLSEnabled": boolean
      }
   ],
   "NextToken": "string"
}

Response Elements

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

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

Clusters

클러스터 목록입니다

유형: Cluster객체 어레이

NextToken

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

유형: 문자열

Errors

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

ClusterNotFoundFault

HTTP 상태 코드: 400

InvalidParameterCombinationException

HTTP 상태 코드: 400

InvalidParameterValueException

HTTP 상태 코드: 400

ServiceLinkedRoleNotFoundFault

HTTP 상태 코드: 400

참고

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