本文へジャンプします。

ニフクラ APIリファレンス

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

RDB:AuthorizeDBSecurityGroupIngress

処理概要

下記どちらかの方法でDBファイアウォールグループへの接続を許可します。

  • ニフクラのサーバーからのプライベートネットワーク経由でDBサーバーへアクセスしたい場合、ニフクラのファイアウォールグループからの接続を許可できます。
  • インターネット経由でDBサーバーへアクセスしたい場合、特定のIP帯からの接続を許可できます。
あるゾーンのニフクラのファイアウォールグループから別ゾーンのDBサーバーへの許可を行うことはできません。
このAPIアクションではCIDRIP(IP範囲)またはEC2SecurityGroupName(ニフクラのファイアウォールグループ名)を必ず指定する必要があります。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
CIDRIP 許可するIP帯 ○(EC2SecurityGroupNameを指定しない場合) 文字列  
DBSecurityGroupName DBファイアウォールグループ名 文字列  
EC2SecurityGroupId
  • ※指定不可
  文字列  
EC2SecurityGroupName 許可するニフクラのファイアウォールグループ名 ○(CIDRIPを指定しない場合) 文字列  
EC2SecurityGroupOwnerId
  • ※指定不可
  文字列  

レスポンス

XML

status

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

result
要素名 説明 備考
AuthorizeDBSecurityGroupIngressResponse ルート  
AuthorizeDBSecurityGroupIngressResult 結果  
DBSecurityGroup DBファイアウォールグループ  
DBSecurityGroupDescription DBファイアウォールグループの説明 文字列  
DBSecurityGroupName DBファイアウォールグループ名 文字列  
EC2SecurityGroups ニフクラのファイアウォールグループ要素リスト リスト  
EC2SecurityGroup ニフクラのファイアウォールグループ要素  
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ファイアウォールグループのゾーン 文字列 ニフクラ独自仕様
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
Client.InvalidParameterCannotSpecify.DBSecurityGroupName DBSecurityGroupName must not contain leading or trailing spaces Sender 400 DBSecurityGroupNameの最初または最後にスペースを入力した場合
Client.InvalidParameterCombination.CidrIp.and.SecurityGroupName If CIDRIP is specified, EC2SecurityGroupName must be omitted. Sender 400
  • CIDRIPとEC2SecurityGroupNameの両方に値を指定した場合
  • CIDRIPとEC2SecurityGroupNameの両方に値を指定しなかった場合
Client.InvalidParameterDuplicate.CidrIp.or.SecurityGroupName Authorization already exists: 192.168.1.1/32 Sender 400
  • すでに設定されているCIDRIPを指定した場合
  • EC2SecurityGroupNameにすでに設定されているニフクラのファイアウォールグループを指定した場合
Client.InvalidParameterFormat.CidrIp Invalid CIDR format. Format must be B. B. B. B/M, where B is a number between 0 and 255, and M is a number between 0 and 32. For example: To authorize only the source address of this request (and no other address), pass 192.168.1.2 as the CIDRIP parameter. Sender 400 CIDRIPの形式が無効な場合
Client.InvalidParameterFormat.DBSecurityGroupName DBSecurityGroupName can contain only ASCII letters and digits, spaces, underscores, and hyphens Sender 400 DBSecurityGroupNameに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterNotFound.DBSecurityGroup DBSecurityGroup not found: aaa Sender 404 存在しないDBSecurityGroupNameを指定した場合
Client.InvalidParameterRequired.DBSecurityGroupName DBSecurityGroupName is required Sender 400 必須のDBSecurityGroupNameを指定しなかった場合
Client.InvalidParameterTooLong.DBSecurityGroupName DBSecurityGroupName can be no longer than 255 characters Sender 400 DBSecurityGroupNameに255文字を超える値を指定した場合
Client.InvalidParameterTooLong.SecurityGroupName SecurityGroupName can not be greater than 15 characters. Sender 400 SecurityGroupNameに15文字を超える値を指定した場合
Client.InvalidParameterTooLong.SecurityGroupName EC2SecurityGroupName can not be greater than 15 characters. Sender 400 EC2SecurityGroupNameに15文字を超える値を指定した場合
Client.LimitExceeded.NumberOfDBSecurityGroupRule Database security group authorization quota has been reached Sender 400 作成可能なDBファイアウォールグループの上限に達している場合
Client.ResourceIncorrectState.DBInstance.Creating Cannot authorize the DBSecurityGroup because DBInstance using the DBSecurityGroup is creating. Sender 400 DBファイアウォールグループを使用しているDBサーバーのステータスが「creating」の場合
Client.ResourceIncorrectState.DBInstance.Processing Cannot authorize the DBSecurityGroup because DBInstance using the DBSecurityGroup is modifying. Sender 400 DBファイアウォールグループを使用しているDBサーバーのステータスが「modifyng」の場合
Client.ResourceIncorrectState.DBSecurityGroup.Unavailable The state of the DB Security Group does not allow deletion. Sender 400 DBファイアウォールグループのステータスが有効な状態でない場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=AuthorizeDBSecurityGroupIngress
    &DBSecurityGroupName=mydbsecuritygroup
    &CIDRIP=0.0.0.0%2F0
    &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"?>
  <AuthorizeDBSecurityGroupIngressResponse>
  <AuthorizeDBSecurityGroupIngressResult>
    <DBSecurityGroup>
    <DBSecurityGroupDescription>My new db security group</DBSecurityGroupDescription>
    <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>
    <EC2SecurityGroups/>
    <IPRanges>
      <IPRange>
        <CIDRIP>0.0.0.0/0</CIDRIP>
        <Status>authorizing</Status>
      </IPRange>
    </IPRanges>
    <OwnerId>abc01234</OwnerId>
    <NiftyAvailabilityZone>east-13</NiftyAvailabilityZone>
  </DBSecurityGroup>
</AuthorizeDBSecurityGroupIngressResult>
    <ResponseMetadata>
    <RequestId>d8abe8c0-2f82-4ed8-a050-2b1ddab9407e</RequestId>
</ResponseMetadata>
</AuthorizeDBSecurityGroupIngressResponse>

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