翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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",
"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"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、共通エラー を参照してください。
- ClusterNotFoundFault
-
HTTP ステータスコード：400
- InvalidParameterCombinationException
-
HTTP ステータスコード：400
- InvalidParameterValueException
-
HTTP ステータスコード：400
- ServiceLinkedRoleNotFoundFault
-
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
