DescribeDBParameterGroups
処理概要
DBパラメーターグループの情報を取得します。
DBParameterGroupName(DBパラメーターグループ名)を指定した場合には、該当するDBパラメーターグループの情報のみが返却されます。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
DBParameterGroupName | string |
DBパラメーターグループ名 |
|
Filters.member.N | string |
※指定不可 |
|
Filter | string |
※指定不可 |
|
FilterName | string |
※指定不可 |
|
FilterValue | string |
※指定不可 |
|
Marker | string |
マーカー
|
|
MaxRecords | integer |
レスポンスに含まれるレコードの最大値 Default: 100 使用可能文字: 20〜100 |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
DescribeDBParameterGroupsResponse | structure |
ルート |
␣DescribeDBParameterGroupsResult | structure |
結果 |
␣␣DBParameterGroups | list |
DBパラメーターグループリスト |
␣␣␣DBParameterGroup | structure |
DBパラメーターグループ 備考: DBParameterGroupの子要素はDescribeDBParameterGroupsで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。 |
␣␣␣␣DBParameterGroupFamily | string |
DBパラメーターグループファミリー名 |
␣␣␣␣DBParameterGroupName | string |
DBパラメーターグループ名 |
␣␣␣␣Description | string |
DBパラメーターグループの説明 |
␣␣Marker | string |
前のリクエストで提供されるページを表す文字列(ページング用)
|
␣ResponseMetadata | structure |
共通メタ情報 |
␣␣RequestId | string |
リクエスト識別子 |
エラー
コード | メッセージ | タイプ | HTTPステータスコード | 説明 |
---|---|---|---|---|
Client.InvalidParameterFormat.DBParameterGroupName | The parameter DBParameterGroupName is not a valid identifier.Identifiers must begin with a letter; must contain only lowercase ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. |
Sender | 400 | DBParameterGroupNameに無効な値(ハイフンから始まる 等)を指定した場合 |
Client.InvalidParameterIllegalInput.MaxRecords | Sender | 400 | MaxRecordsに数値でない値を指定した場合 | |
Client.InvalidParameterNotFound.DBParameterGroup | DBParameterGroup not found: aaa |
Sender | 404 | 存在しないDBParameterGroupNameを指定した場合 |
Client.InvalidParameterOutOfRange.MaxRecords | Invalid value for max records. Must be between 20 and 100 |
Sender | 400 | MaxRecordsに20-100でない値を指定した場合 |
Client.InvalidParameterTooLong.DBParameterGroupName | The parameter DBParameterGroupName is not a valid identifier because it is longer than 255 characters. |
Sender | 400 | DBParameterGroupNameに255文字を超える値を指定した場合 |
リクエストサンプル
https://jp-east-1.rdb.api.nifcloud.com/
?Action=DescribeDBParameterGroups
&DBParameterGroupName=mydbparametergroup
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2013-12-09T00:00:00.000Z
&AWSAccessKeyId=<NIFCLOUD Access Key ID>
&Signature=<Signature>
応答サンプル
<DescribeDBParameterGroupsResponse>
<DescribeDBParameterGroupsResult>
<DBParameterGroups>
<DBParameterGroup>
<DBParameterGroupFamily>mysql5.6</DBParameterGroupFamily>
<DBParameterGroupName>mydbparametergroup</DBParameterGroupName>
<Description>My new parameter group</Description>
</DBParameterGroup>
</DBParameterGroups>
</DescribeDBParameterGroupsResult>
<ResponseMetadata>
<RequestId>3da8213a-73f2-4202-a107-cd4adeba59c4</RequestId>
</ResponseMetadata>
</DescribeDBParameterGroupsResponse>