本文へジャンプします。

ニフティクラウド APIリファレンス

クラウド トップ>API>RDB>DescribeDBParameterGroups

RDB:DescribeDBParameterGroups

処理概要

DBパラメーターグループの情報を取得します。

DBParameterGroupName(DBパラメーターグループ名)を指定した場合には、該当するDBパラメーターグループの情報のみが返却されます。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBParameterGroupName DBパラメーターグループ名   文字列  
Filters.member.N
  • ※指定不可
  リスト  
Filter
  • ※指定不可
   
FilterName
  • ※指定不可
  文字列  
FilterValue
  • ※指定不可
  文字配列  
Marker

マーカー

  • ※ページネート用にDBパラメーターグループ一覧の取得位置を表す文字列です
  • ※前回のDescribeDBParameterGroupsリクエストで返却された値を指定します
  • ※この値が指定された場合、取得位置より後のDBパラメーターグループが返却されます
  文字列  
MaxRecords レスポンスに含まれるレコードの最大値
値:20〜100
  数値 20-100 100  

レスポンス

XML

status

statusは共通の応答メッセージを返却します。

result
要素名 説明 備考
DescribeDBParameterGroupsResponse ルート  
DescribeDBParameterGroupsResult 結果  
DBParameterGroups DBパラメーターグループリスト リスト  
DBParameterGroup DBパラメーターグループ  
DBParameterGroupFamily DBパラメーターグループファミリー名 文字列  
DBParameterGroupName DBパラメーターグループ名 文字列  
Description DBパラメーターグループの説明 文字列  
Marker マーカー 文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
DBParameterGroupNotFound DBParameterGroup not found:aaaa Sender 404 DBParameterGroupNameに存在しない名前を指定した場合
InvalidParameterValue The parameter DBParameterGroupName is not a valid identifier.
Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
Sender 400 DBParameterGroupNameに無効な(数字から始まるなど)値を指定した場合
The parameter DBParameterGroupName is not a valid identifier because it is longer than 255 characters. Sender 400 DBParameterGroupNameに255文字以上指定した場合
Invalid value for max records. Must be between 20 and 100 Sender 400 MaxRecordsに20-100でない値を指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DescribeDBParameterGroups
    &DBParameterGroupName=mydbparametergroup
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>
レスポンスサンプル
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<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>

推奨画面サイズ 1024×768 以上