本文へジャンプします。

ニフクラ ユーザーガイド

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

DescribeDBSecurityGroups

処理概要

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

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

指定するパラメーター

パラメーター 説明 必須
DBSecurityGroupName string DBファイアウォールグループ名
Filters.member.N string ※指定不可
Filter string ※指定不可
FilterName string ※指定不可
FilterValue string ※指定不可
Marker string

マーカー

  • ※ページネート用にDBファイアウォールグループ一覧の取得位置を表す文字列です
  • ※前回のDescribeDBSecurityGroupsリクエストで返却された値を指定します
  • ※この値が指定された場合、取得位置より後のDBファイアウォールグループが返却されます

MaxRecords integer レスポンスに含まれるレコードの最大値
Default: 100
使用可能文字: 5〜100

応答フィールド

フィールド (項目) 説明
DescribeDBSecurityGroupsResponse structure ルート
DescribeDBSecurityGroupsResult structure 結果
DBSecurityGroups list DBファイアウォールグループリスト
DBSecurityGroup structure DBファイアウォールグループ情報
備考: DBSecurityGroupの子要素はDescribeDBSecurityGroupsで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
DBSecurityGroupDescription string DBファイアウォールグループの説明
DBSecurityGroupName string DBファイアウォールグループ名
EC2SecurityGroups list ニフクラのファイアウォールグループ要素リスト
EC2SecurityGroup structure ニフクラのファイアウォールグループ要素
EC2SecurityGroupName string ニフクラのファイアウォールグループ名
EC2SecurityGroupOwnerId string ニフクラのファイアウォールグループを所有している ニフクラID
Status string

ニフクラのファイアウォールグループのステータス

  • 値:authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー)|not-exists(追加エラー(グループが存在しません))

IPRanges list IP帯リスト
IPRange structure IP帯
CIDRIP string CIDR
Status string

IP帯のステータス

値:authorized(有効)|authorizing(追加中)|revoking(削除中)|auth-failed(追加エラー)|revoke-failed(削除エラー)|not-exists(追加エラー(グループが存在しません))


OwnerId string DB ファイアウォールグループを所有している ニフクラID
NiftyAvailabilityZone string DB ファイアウォールグループのゾーン
備考: ニフクラ独自仕様
Marker string

前のリクエストで提供されるページを表す文字列(ページング用)

  • この値が指定された場合、レスポンスでマーカーを超えたレコードが最大MaxRecord個返される

ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameterCannotSpecify.DBSecurityGroupName

DBSecurityGroupName must not contain leading or trailing spaces.

Sender 400 DBSecurityGroupNameの最初または最後にスペースを入力した場合
Client.InvalidParameterFormat.DBSecurityGroupName

DBSecurityGroupName can contain only lowercase ASCII letters and digits, spaces, underscores, and hyphens.

Sender 400 DBSecurityGroupNameに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterIllegalInput.MaxRecords
Sender 400 MaxRecordsに数値でない値を指定した場合
Client.InvalidParameterNotFound.DBSecurityGroup

DBSecurityGroup not found: aaa

Sender 404 存在しないDBSecurityGroupNameを指定した場合
Client.InvalidParameterOutOfRange.MaxRecords

Invalid value for max records. Must be between 5 and 100

Sender 400 MaxRecordsに5-100でない値を指定した場合
Client.InvalidParameterTooLong.DBSecurityGroupName

DBSecurityGroupName can be no longer than 255 characters

Sender 400 DBSecurityGroupNameに255文字を超える値を指定した場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=DescribeDBSecurityGroups
  &DBSecurityGroupName=mydbsecuritygroup
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

  

応答サンプル

    <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>

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月13日時点の情報です。

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