DescribeDBClusterParameters - Amazon DocumentDB

DescribeDBClusterParameters

特定のクラスターパラメータグループの詳細なパラメータリストを返します。

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

DBClusterParameterGroupName

パラメータの詳細を返す特定のクラスターパラメータグループ名。

制約:

  • 指定した場合、既存の DBClusterParameterGroup の名前と一致する必要があります。

型: 文字列

必須: はい

Filters.Filter.N

このパラメータは、現在サポートされていません。

型: Filter オブジェクトの配列

必須:いいえ

Marker

以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには MaxRecords で指定された値まで、マーカーを超えるレコードのみが含まれます。

型: 文字列

必須: いいえ

MaxRecords

レスポンスに含めるレコードの最大数。指定された MaxRecords の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。

デフォルト: 100

制約: 最小 20、最大 100。

型: 整数

必須:いいえ

Source

特定のソースのパラメータのみを返すことを示す値。パラメータのソースは engineservice、または customer のいずれかとすることができます。

型: 文字列

必須: いいえ

レスポンス要素

以下の要素がサービスによって返されます。

Marker

以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには MaxRecords で指定された値まで、マーカーを超えるレコードのみが含まれます。

型: 文字列

Parameters.Parameter.N

クラスターパラメータグループのパラメータのリストを提供します。

型: Parameter オブジェクトの配列

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

DBParameterGroupNotFound

DBParameterGroupName は既存のパラメータグループを参照していません。

HTTP ステータスコード: 404

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。