本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>API>NAS>AuthorizeNASSecurityGroupIngress

NAS:AuthorizeNASSecurityGroupIngress

処理概要

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

  • ニフクラのサーバーからのプライベートネットワーク経由でNASへアクセスしたい場合、ニフクラのファイアウォールグループからの接続を許可できます。
  • インターネット経由でNASへアクセスしたい場合、特定のIP帯からの接続を許可できます。

あるゾーンのニフクラのファイアウォールグループから別ゾーンのDBサーバーへの許可を行うことはできません。
このAPIアクションではCIDRIP(IP範囲)またはSecurityGroupName(ニフクラのファイアウォールグループ名)を必ず指定する必要があります。

リクエストパラメーター

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

レスポンス

XML

status

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

result
要素名 説明 備考
AuthorizeNASSecurityGroupIngressResponse ルート  
AuthorizeNASSecurityGroupIngressResult 結果  
NASSecurityGroup NASファイアウォールグループ  
NASSecurityGroupDescription NASファイアウォールグループの説明 文字列  
NASSecurityGroupName NASファイアウォールグループ名 文字列  
SecurityGroups ニフクラファイアウォールグループ要素リスト リスト  
SecurityGroup ニフクラファイアウォールグループ要素  
SecurityGroupName ニフクラファイアウォールグループ名 文字列  
SecurityGroupOwnerId ニフクラのファイアウォールグループを所有している @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(削除エラー))
文字列  
OwnerId NASファイアウォールグループを所有している @nifty ID 文字列  
AvailabilityZone NASファイアウォールグループのゾーン 文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameter.NotFound.NASSecurityGroupName NASSecurityGroup aaaa not found. Sender 404 NASSecurityGroupNameに存在しない名前を指定した場合
Client.InvalidParameter.Duplicate.SecurityGroupName Authorization already exists: SecurityGroupName Sender 400 すでに設定されているCIDRIPやニフクラファイアウォールグループが指定された場合
Client.InvalidParameter.Duplicate.CIDRIP Authorization already exists: xxx.xxx.xxx.xxx/xx Sender 400 すでに設定されているCIDRIPが指定された場合
Client.InvalidParameter.LimitExceeded.AuthorizeNASSecurityGroup NASSecurityGroup authorization quota has been reached. Sender 400 作成できるファイアウォールグループの上限に達している場合
Client.Resource.IncorrectState.NASSecurityGroup The state of the NAS Security Group does not allow deletion. Sender 400 指定したファイアウォールグループのステータスが有効でない場合
Client.InvalidParameter.MisMatch.SecurityGroupName If CIDRIP is specified, SecurityGroupName must be omitted. Sender 400 このAPIを使うための条件を満たすパラメータを指定していない場合
Client.InvalidParameterNotAllowed.NASSecurityGroupName Invalid security group: @test Sender 400 NASSecurityGroupNameに無効な値(@、全角文字)を指定した場合
Client.InvalidParameter.TooLong.NASSecurityGroupName NASSecurityGroupName can be no longer than 255 characters Sender 400 NASSecurityGroupNameに255文字
以上指定した場合
Client.InvalidParameter.Format.NASSecurityGroupName NASSecurityGroupName must not contain leading or trailing spaces
Client.InvalidParameter.Format.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 {0} as the CIDRIP parameter. Sender 400 NASSecurityGroupNameの最初か最後
に " " を入力した場合
Client.InvalidParameter.NotFound.SecurityGroupName Invalid security group , groupId=, groupName= {0} Sender 400 存在しないニフクラファイアウォールグループを指定した場合
Client.InvalidParameter.Required.NASSecurityGroupName The parameter NASSecurityGroupName must be provided and must not be blank. Sender 400 必須のNASSecurityGroupNameを指定しなかった場合
Client.InvalidParameter.TooLong.SecurityGroupName SecurityGroupName can be no longer than 15 characters. Sender 400 SecurityGroupNameに15文字を超える値を入力した場合
Client.Resource.IncorrectState.AuthorizeNASSecurityGroup Cannot authorize the NASSecurityGroup because NASInstance using the NASSecurityGroup is modifying. Sender 400 指定されたNASファイアウォールグループを使用しているNASのステータスが「modifyng」のとき

リクエストサンプル

https://nas.jp-east-2.api.cloud.nifty.com/
    ?Action=AuthorizeNASSecurityGroupIngress
    &NASSecurityGroupName=exsample-securitygroup
    &CIDRIP=xxx.xxx.xxx.xxx/xx
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2016-02-24T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID> 
    &Signature=<Signature>

レスポンスサンプル

<AuthorizeNASSecurityGroupIngressResponse>
  <AuthorizeNASSecurityGroupIngressResult>
    <NASSecurityGroup>
      <NASSecurityGroupName>exsample-securitygroup</NASSecurityGroupName>
      <SecurityGroups/>
      <IPRanges>
        <IPRange>
          <CIDRIP>xxx.xxx.xxx.xxx/xx</CIDRIP>
          <Status>authorizing</Status>
        </IPRange>
      </IPRanges>
      <OwnerId>ABC01234</OwnerId>
      <AvailabilityZone>east-21</AvailabilityZone>
    </NASSecurityGroup>
  </AuthorizeNASSecurityGroupIngressResult>
  <ResponseMetadata>
    <RequestId>8cf2476b-b90d-444e-a9be-027ae0a5e468</RequestId>
  </ResponseMetadata>
</AuthorizeNASSecurityGroupIngressResponse>

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