ニフクラAPI (NAS: AuthorizeNASSecurityGroupIngress)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

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

AuthorizeNASSecurityGroupIngress

処理概要

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

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

NASファイアウォールグループに対して、同一ゾーンのニフクラのファイアウォールグループからの接続許可は可能ですが、別ゾーンのニフクラのファイアウォールグループからの接続許可はできません。
このAPIアクションではCIDRIP（IP範囲）またはSecurityGroupName（ニフクラのファイアウォールグループ名）を必ず指定する必要があります。

指定するパラメーター

パラメーター	型	説明	必須
NASSecurityGroupName	string	NASファイアウォールグループ名	○
SecurityGroupName	string	許可するニフクラのファイアウォールグループ名 ※4バイト文字（絵文字や一部の漢字など）は使用できません	○ (CIDRIPを指定しない場合)
CIDRIP	string	許可するIP帯	○ (SecurityGroupNameを指定しない場合)

パラメーター

型

説明

必須

NASSecurityGroupName

string

NASファイアウォールグループ名

○

SecurityGroupName

string

許可するニフクラのファイアウォールグループ名

※4バイト文字（絵文字や一部の漢字など）は使用できません

○ (CIDRIPを指定しない場合)

CIDRIP

string

許可するIP帯

○ (SecurityGroupNameを指定しない場合)

応答フィールド

フィールド (項目)	型	説明
AuthorizeNASSecurityGroupIngressResponse	structure	ルート
␣AuthorizeNASSecurityGroupIngressResult	structure	結果
␣␣NASSecurityGroup	structure	NASファイアウォールグループ備考: NASSecurityGroupの子要素はDescribeNASSecurityGroupsで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
␣␣␣NASSecurityGroupDescription	string	NASファイアウォールグループの説明
␣␣␣NASSecurityGroupName	string	NASファイアウォールグループ名
␣␣␣SecurityGroups	list	ニフクラファイアウォールグループ要素リスト
␣␣␣␣SecurityGroup	structure	ニフクラファイアウォールグループ要素
␣␣␣␣␣SecurityGroupName	string	ニフクラファイアウォールグループ名
␣␣␣␣␣SecurityGroupOwnerId	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(削除エラー))
␣␣␣OwnerId	string	NASファイアウォールグループを所有しているニフクラID
␣␣␣AvailabilityZone	string	NASファイアウォールグループのゾーン
␣ResponseMetadata	structure	共通メタ情報
␣␣RequestId	string	リクエスト識別子

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
Client.InvalidParameter.NotFound.NASSecurityGroupName	NASSecurityGroup aaaa not found.	Sender	404	NASSecurityGroupNameに存在しない名前を指定した場合
Client.InvalidParameter.Duplicate.SecurityGroupName	Authorization already exists: SecurityGroupName	Sender	400	すでに設定されているニフクラファイアウォールグループが指定された場合
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.InvalidParameter.NotAllowed.NASSecurityGroupName	NASSecurityGroupName can contain only lowercase ASCII letters and digits, spaces, underscores, and hyphens	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	Sender	400	NASSecurityGroupNameの最初か最後に " " を入力した場合
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	CIDRIPにフォーマット以外のデータを適用した場合
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.IllegalInput.SecurityGroupName	SecurityGroupName (4バイト文字) is not a valid parameter.	Sender	400	SecurityGroupNameに4バイト文字を含む値を指定した場合
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のステータスが「modifying」のとき

リクエストサンプル

    https://jp-east-1.nas.api.nifcloud.com/
  ?Action=AuthorizeNASSecurityGroupIngress
  &NASSecurityGroupName=exsample-securitygroup
  &CIDRIP=xxx.xxx.xxx.xxx/xx
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2016-02-24T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD 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>