本文へジャンプします。

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

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

RDB:DescribeDBSecurityGroups

処理概要

DBファイアウォールグループの情報を取得します。

DBSecurityGroupName(DBファイアウォールグループ名)が指定された場合は該当するDBファイアウォールグループの情報のみが返却されます。

リクエストパラメーター

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

マーカー

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

レスポンス

XML

status

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

result
要素名 説明 備考
DescribeDBSecurityGroupsResponse ルート  
DescribeDBSecurityGroupsResult 結果  
DBSecurityGroups DBファイアウォールグループリスト リスト  
DBSecurityGroup DBファイアウォールグループ情報  
DBSecurityGroupDescription DBファイアウォールグループの説明 文字列  
DBSecurityGroupName DBファイアウォールグループ名 文字列  
EC2SecurityGroups ニフティクラウドのファイアウォールグループ要素リスト リスト  
EC2SecurityGroups ニフティクラウドのファイアウォールグループ要素  
EC2SecurityGroupName ニフティクラウドのファイアウォールグループ名 文字列  
EC2SecurityGroupOwnerId ニフティクラウドのファイアウォールグループを所有している @nifty ID 文字列  
Status ニフティクラウドのファイアウォールグループのステータス
値:authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー)|not-exists(追加エラー(グループが存在しません))
文字列  
IPRanges IP帯リスト リスト  
IPRange IP帯  
CIDRIP CIDR 文字列  
Status IP帯のステータス
値:authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー)|not-exists(追加エラー(グループが存在しません))
文字列  
OwnerId DB ファイアウォールグループを所有している @nifty ID 文字列  
NiftyAvailabilityZone DB ファイアウォールグループのゾーン 文字列 ニフティクラウド独自仕様
Marker 前のリクエストで提供されるページを表す文字列(ページング用)
この値が指定された場合、レスポンスでマーカーを超えたレコードが最大MaxRecord個返される
文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
DBSecurityGroupNotFound DBSecurityGroup not found: aaaa Sender 404 DBSecurityGroupNameに存在しないDBファイアウォールグループ名を指定した場合
InvalidParameterValue DBSecurityGroupName can contain only ASCII letters and digits, spaces, underscores, and hyphens Sender 400 DBSecurityGroupNameに無効な文字(全角文字など)を指定した場合
DBSecurityGroupName can be no longer than 255 characters Sender 400 DBSecurityGroupNameに255文字以上指定した場合
  Invalid value for max records. Must be between 5 and 100 Sender 400 MaxRecordsに5-100でない値を指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DescribeDBSecurityGroups
    &DBSecurityGroupName=mydbsecuritygroup
    &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"?>
<DescribeDBSecurityGroupsResponse>
  <DescribeDBSecurityGroupsResult>
  <DBSecurityGroups>
    <DBSecurityGroup>
      <DBSecurityGroupDescription>My new db security group</DBSecurityGroupDescription>
      <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>
      <EC2SecurityGroups/>
      <IPRanges>
        <IPRange>
          <CIDRIP>0.0.0.0/0</CIDRIP>
          <Status>authorized</Status>
        </IPRange>
      </IPRanges>
      <OwnerId>abc01234</OwnerId>
      <NiftyAvailabilityZone>east-13</NiftyAvailabilityZone>
    </DBSecurityGroup>
  </DBSecurityGroups>
</DescribeDBSecurityGroupsResult>
  <ResponseMetadata>
  <RequestId>da6caf8d-090d-4c04-b4a0-4f823658e3f0</RequestId>
</ResponseMetadata>
</DescribeDBSecurityGroupsResponse>

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