ニフクラAPI (NAS: ModifyNASSecurityGroup)

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

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

ニフクラユーザーガイド

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

ModifyNASSecurityGroup

処理概要

NASファイアウォールグループの設定を変更します。
一度に複数のNASファイアウォールグループの設定を変更することができます。

指定するパラメーター

パラメーター	型	説明	必須
NASSecurityGroupName	string	変更対象のNASファイアウォールグループ名	○
NewNASSecurityGroupName	string	新しいNASファイアウォールグループ名 ※最初の文字はアルファベットである必要があります ※すでに存在するNASファイアウォールグループの名前は指定できません ※デフォルトのNASファイアウォールグループは変更できません使用可能文字: 1〜255字のアルファベット(小文字)・数字・ハイフン('-')・アンダースコア('_')・スペース(' ')
NASSecurityGroupDescription	string	NASファイアウォールグループの説明使用可能文字: 1〜255文字の印字可能なASCII文字

パラメーター

型

説明

必須

NASSecurityGroupName

string

変更対象のNASファイアウォールグループ名

○

NewNASSecurityGroupName

string

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

※最初の文字はアルファベットである必要があります
※すでに存在するNASファイアウォールグループの名前は指定できません
※デフォルトのNASファイアウォールグループは変更できません

使用可能文字: 1〜255字のアルファベット(小文字)・数字・ハイフン('-')・アンダースコア('_')・スペース(' ')

NASSecurityGroupDescription

string

NASファイアウォールグループの説明
使用可能文字: 1〜255文字の印字可能なASCII文字

応答フィールド

フィールド (項目)	型	説明
ModifyNASSecurityGroupResponse	structure	ルート
␣ModifyNASSecurityGroupResult	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.Resource.IncorrectState.NASSecurityGroup	The state of the NAS Security Group does not allow deletion.	Sender	400	指定したファイアウォールグループのステータスが有効な状態でない場合
Client.InvalidParameter.Required.NASSecurityGroupName	The parameter NASSecurityGroupName must be provided and must not be blank.	Sender	400	必須のNASSecurityGroupNameを指定しなかった場合
Client.InvalidParameter.TooLong.NASSecurityGroupName	NewNASSecurityGroupName can be no longer than 255 characters	Sender	400	NewNASSecurityGroupNameに255文字以上指定した場合
Client.InvalidParameter.Format.NASSecurityGroupName	NewNASSecurityGroupName must not contain leading or trailing spaces	Sender	400	NewNASSecurityGroupNameの最初か最後に " "（半角スペース）を入力した場合
Client.InvalidParameter.NotAllowed.NASSecurityGroupName	NASSecurityGroupName can contain only lowercase ASCII letters and digits, spaces, underscores, and hyphens	Sender	400	NewNASSecurityGroupNameに無効な値（全角文字、@など）を指定した場合
Client.InvalidParameter.TooLong.NASSecurityGroupDescription	NASSecurityGroupDescription can be no longer than 255 characters	Sender	400	NASSecurityGroupDescriptionに255文字以上指定した場合
Client.InvalidParameter.CannotSpecify.NASSecurityGroupName	You cannot modify the default NAS security group.	Sender	400	defaultファイアウォールグループを変更しようとした場合

リクエストサンプル

    https://jp-east-1.nas.api.nifcloud.com/
  ?Action=ModifyNASSecurityGroup
  &NASSecurityGroupName=exsample-securitygroup
  &NewNASSecurityGroupName=sample-securitygroup
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2016-02-24T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

応答サンプル

    <ModifyNASSecurityGroupResponse>
  <ModifyNASSecurityGroupResult>
    <NASSecurityGroup>
      <NASSecurityGroupName>sample-securitygroup</NASSecurityGroupName>
      <SecurityGroups/>
      <IPRanges/>
      <OwnerId>ABC01234</OwnerId>
      <AvailabilityZone>east-21</AvailabilityZone>
    </NASSecurityGroup>
  </ModifyNASSecurityGroupResult>
  <ResponseMetadata>
    <RequestId>34f5f93c-529b-4230-96e6-9324e07394ed</RequestId>
  </ResponseMetadata>
</ModifyNASSecurityGroupResponse>