翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeGlobalClusters
Amazon DocumentDB グローバルクラスターに関する情報を返します。この API はページ分割をサポートします。
注記
このアクションは Amazon DocumentDB クラスターにのみ適用されます。
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
- Filters.Filter.N
-
記述する 1 つ以上の DB クラスターを指定するフィルター。
対応するフィルター:
db-cluster-idは、クラスター識別子とクラスター Amazon リソースネーム (ARN) を受け入れます。結果リストには、これらの ARN で識別されるクラスターに関連付けられたインスタンスに関する情報のみが含まれます。型: Filter オブジェクトの配列
必須：いいえ
- GlobalClusterIdentifier
-
ユーザーが指定した DB クラスター識別子。このパラメータを指定した場合、特定のクラスターからの情報のみを返します。このパラメータでは大文字と小文字は区別されません。
型: 文字列
長さの制限：最小長は 1 です。最大長は 255 です。
パターン:
[A-Za-z][0-9A-Za-z-:._]*必須: いいえ
- Marker
-
以前の
DescribeGlobalClustersリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスにはMaxRecordsで指定された値まで、マーカーを超えるレコードのみが含まれます。型: 文字列
必須: いいえ
- MaxRecords
-
レスポンスに含めるレコードの最大数。指定された
MaxRecordsの値よりも多くのレコードが存在する場合、残りの結果を取得できるように、マーカーと呼ばれるページ割りトークンがレスポンスに含まれます。型: 整数
必須：いいえ
レスポンス要素
以下の要素がサービスによって返されます。
- GlobalClusters.GlobalClusterMember.N
-
型: GlobalCluster オブジェクトの配列
- Marker
-
型: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- GlobalClusterNotFoundFault
-
GlobalClusterIdentifierは既存のグローバルクラスターを参照していません。HTTP ステータスコード: 404
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
