本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> NAS> ModifyNASInstance
本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/へ移行しました。 今後は新ページをご参照ください。

ModifyNASInstance

処理概要

NASの設定を変更します。
一度に複数のNAS設定を変更することができます。

NASに接続した状態でプライベートIPアドレスを変更すると、NASにアクセスできなくなる場合があります。
NASのプライベートIPアドレスを変更する場合は、NASへの接続がないことをご確認ください。
NASにアクセスできなくなった場合は、クライアント側のOS強制再起動を行ってください。

指定するパラメーター

パラメーター 型 説明 必須
AllocatedStorage integer ディスク容量 ※容量を減らすことはできません
単位: GB
値:
NASInstanceType=0 の場合
  • 100
  • 200
  • 300
  • 400
  • 500
  • 600
  • 700
  • 800
  • 900
  • 1000
NASInstanceType=1 の場合
  • 1000
  • 2000
  • 3000
  • 4000
  • 5000
  • 6000
  • 7000
  • 8000
  • 9000
  • 10000
Default: 既存の設定
NASInstanceIdentifier string 変更対象のNAS名
 ○
NASSecurityGroups.member.N string

NASファイアウォールグループのリスト

  • ※1つのみ指定可能です。複数指定した場合、2つ目以降は無視されます
MasterUserPassword string マスターユーザーの新パスワード
Default: 既存の設定
使用可能文字: 「/」、「@」、「"」、「 」、「'」を除く、1〜128文字の印字可能なASCII文字
備考: Protocol = cifs時のみ指定可能
NewNASInstanceIdentifier string

新しいNAS名

  • ※最初の文字はアルファベットである必要があります
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません

使用可能文字: 1〜63字のアルファベット(小文字)・数字・ハイフン('-')
NASInstanceDescription string

NASの説明

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

使用可能文字: 1〜255文字の印字可能なASCII文字
MasterPrivateAddress string NAS用のプライベートIPアドレス
NetworkId string 変更先のプライベートLANのネットワークID
値:
共通プライベートにする の場合
  

net-COMMON_PRIVATE


プライベートLANにする の場合
  

プライベートLANのネットワークユニークID
AuthenticationType integer 認証タイプ
値:
  • 0 (ローカル認証)
Default: 既存の設定
備考: NAS作成時は0
NoRootSquash boolean nfsのroot権限使用許可の指定
値:
  • true (root権限での使用を許可（no_root_squash）)
  • false (root権限での使用を拒否（root_squash）)
Default: 既存の設定
備考: プロトコルがnfsの場合のみ有効、cifsの場合は入力値を無視する。

応答フィールド

フィールド (項目) 型 説明
ModifyNASInstanceResponse structure ルート
␣ModifyNASInstanceResult structure 結果
␣␣NASInstance structure NAS
備考: NASInstanceの子要素はDescribeNASInstancesで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
␣␣␣AllocatedStorage integer 割り当てるディスク容量
単位: GB
␣␣␣AvailabilityZone string NASのゾーン
␣␣␣NASInstanceClass string NASのタイプ
␣␣␣NASInstanceIdentifier string NAS名
␣␣␣NASInstanceDescription string NASの説明
␣␣␣NASInstanceStatus string NASのステータス
␣␣␣NASInstanceErrorInfo string NASのエラー情報
␣␣␣␣NASInstanceErrorCode string 発生中のエラーコード
␣␣␣␣NASInstanceErrorMessage string 発生中のエラーメッセージ
␣␣␣NASSecurityGroups list NASファイアウォールグループ情報リスト
␣␣␣␣NASSecurityGroup structure NASファイアウォールグループ
␣␣␣␣␣NASSecurityGroupName string NASファイアウォールグループ名
␣␣␣␣␣Status string

NASファイアウォールグループのステータス

  • 値：active(有効) | adding(適用中) | removing(取り外し中) | failed(変更失敗)
␣␣␣Endpoint structure エンドポイント
␣␣␣␣Address string グローバルIPアドレス
␣␣␣␣PrivateAddress string プライベートIPアドレス
␣␣␣Protocol string プロトコル
␣␣␣MasterUsername string NASのマスターユーザ名
␣␣␣StorageType integer ディスクタイプ
␣␣␣NetworkId string プライベートLANのネットワークユニークID
␣␣␣AuthenticationType integer 認証タイプ
備考: CIFS(ローカル認証) or NFS : 0
␣␣␣NASInstanceType integer NASタイプ
備考: 標準タイプ : 0 | 高速タイプ : 1
␣␣␣NoRootSquash boolean root権限許可
備考: false（root権限使用禁止）固定
␣␣␣UpgradeRequired boolean NAS領域の基盤アップグレード要否
備考: 基盤アップグレードが必要 : true | 基盤アップグレードは不要 : false
␣ResponseMetadata structure 共通メタ情報
␣␣RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameter.NotFound.NASInstanceIdentifier

NASInstance aaaa not found.

 Sender 404 存在しないIDをNASInstanceIdentifierに指定した場合
Client.InvalidParameter.NotFound.NASSecurityGroupName

NASSecurityGroup aaaa not found.

 Sender 404 存在しないファイアウォールグループをNASSecurityGroups.member.Nに指定した場合
Client.InvalidParameter.Duplicate.NASInstanceIdentifier

NASInstance already exists.

 Sender 400 すでに存在するIDをNewNASInstanceIdentifierに指定した場合
Client.InvalidParameter.Format.NASInstanceIdentifier

The parameter NASInstanceIdentifier is not a valid identifier. Identifiers must begin with a letter; must contain only lowercase ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

 Sender 400 NewNASInstanceIdentifierに無効な値（数字から始まる、@を使用した値など）を指定した場合
Client.InvalidParameter.IllegalInput.NASInstanceDescription

NASInstanceDescription (4バイト文字) is not a valid parameter.

 Sender 400 NASInstanceDescriptionに4バイト文字を含む値を指定した場合
Client.Resource.IncorrectState.ModifyNASInstance

The specified NASInstance is not in the modifiable state.

 Sender 400 指定したNASのステータスが以下でない場合
available
incompatible-authentication
Client.Resource.IncorrectState.StorageFullNASInstance

The specified NASInstance is currently in the storage-full state. The only modification permitted on a NASInstance in this state is an increase in allocated storage.

 Sender 400 NASのステータスが「storage-full」の場合に、ディスクサイズの増加以外の指定をした場合
Client.InvalidParameter.CannotSpecify.MasterUserPassword

Cannot modify MasterUserPassword for NASInstance Protocol ‘nfs’.

 Sender 400 Protocol = nfsの場合MasterUserPasswordを変更しようとしたとき
Client.InvalidParameter.NotAllowed.MasterUserPassword

The parameter MasterUserPassword is not a valid password. Only printable ASCII characters besides ‘/’, ‘@’, ‘"’, ’ ‘,’'’ may be used.

 Sender 400 Protocol= cifs のときにMasterUserPasswordに無効な値（@など）を指定した場合
Client.InvalidParameter.TooLong.MasterUserPassword

The parameter MasterUserPassword is not a valid password because it is longer than 128 characters.

 Sender 400 Protocol= cifs のときにMasterUserPasswordに128文字以上指定した場合
Client.InvalidParameter.CannotSpecify.MasterPrivateAddress

Cannot modify MasterPrivateAddress for NASInstance is not PrivateLAN.

 Sender 400 プライベートLANを使用していないNASでMasterPrivateAddressを指定したとき
Client.InvalidParameter.TooSmall.AllocatedStorage

Requested storage size (1) cannot be less then the current storage size (5)

 Sender 400 AllocatedStorageに現在より小さい値を指定した場合
Client.InvalidParameter.OutOfRange.AllocatedStorage

Invalid storage size: 11000. The storage size must be between 1000 and 10000 GB.

 Sender 400 AllocatedStorageに1000〜指定された最大値（デフォルトは10000）でない値を指定した場合
Client.InvalidParameter.Format.NASSecurityGroupName

NASSecurityGroupName must not contain leading or trailing spaces

 Sender 400 NASSecurityGroups.member.Nの最初または最後にスペースを入力した場合
Client.InvalidParameter.Format.AllocatedStorage

AllocatedStorage should specify the multiple of 1000.

 Sender 400 AllocatedStorageに1000の倍数でない値を指定した場合
Client.InvalidParameter.Format.MasterPrivateAddress

Invalid MasterPrivateAddress aaa.bbb.ccc.ddd.

 Sender 400 MasterPrivateAddressにIPアドレスとして無効な値を指定したとき
Client.InvalidParameter.Duplicate.MasterPrivateAddress

Private address is already in use: 192.168.98.160.

 Sender 400 MasterPrivateAddressに重複しているIPアドレスを指定したとき
Client.InvalidParameter.PrivateAddressMismacth.CIDRprefix

Invalid MasterPrivateAddress: 192.168.128.1/27. Valid value is /20.

 Sender 400 MasterPrivateAddressのプレフィックスにプライベートLAN作成時のプレフィックスと異なる値を指定したとき
Client.InvalidParameter.OutOfRange.MasterPrivateAddress

Invalid MasterPrivateAddress: 192.168.128.31. Valid range is 192.168.128.1-192.168.128.30.

 Sender 400 MasterPrivateAddressにサブネットの範囲外のIPアドレスを指定したとき
Client.InvalidParameter.LimitExceeded.AllocatedStorage

The total storage capacity max limit of east-21 is 10,000GB.

 Sender 400 AvailavilityZoneに指定されたゾーンに存在している全てのNASのストレージサイズ合計が、設定された上限値を超えてしまう場合
Client.InvalidParameter.NotAllowed.AllocatedStorage

−

 Sender 400 AllocatedStorageに数値でない値を指定した場合
Client.InvalidParameter.NotFound.NetworkId

Private LAN net-1234abcd does not exist.

 Sender 404 存在しないNetWorkIdを指定した場合
Client.InvalidParameter.NotFound.NetworkId

Private LAN net-1234abcd does not belong to availability zone east-11.

 Sender 400 指定されたゾーンと異なるゾーンに所属するNetworkIdを指定した場合
Client.Resource.IncorrectState.ApplyNASSecurityGroup

NASSecurityGroup is not in available state.

 Sender 400 変更しようとしたNASファイアウォールグループのルールのうち、ステータスが、「authorizing」または「revoking」のルールが存在する場合
Client.InvalidParameter.Missing.MasterPrivateAddress

The parameter MasterPrivateAddress must be provided and must not be blank.

 Sender 400 NetworkIdを指定したが、MasterPrivateAddressを指定しなかった場合
Client.InvalidParameter.Format.AuthenticationType
Sender 400 AuthenticationTypeに有効でない値を指定した場合
Client.InvalidParameter.Format.NoRootSquash

−

 Sender 400 NoRootSquashにtrueまたはfalse以外の値を指定した場合

リクエストサンプル

    https://jp-east-1.nas.api.nifcloud.com/
  ?Action=ModifyNASInstance
  &AllocatedStorage=2000
  &NASInstanceIdentifier=example-nas-server
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2016-02-24T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

応答サンプル

    <ModifyNASInstanceResponse>
  <ModifyNASInstanceResult>
    <NASInstance>
      <AllocatedStorage>1000</AllocatedStorage>
      <AvailabilityZone>east-21</AvailabilityZone>
      <NASInstanceClass>small</NASInstanceClass>
      <NASInstanceIdentifier>example-nas-server</NASInstanceIdentifier>
      <NASInstanceStatus>modifying</NASInstanceStatus>
      <NASSecurityGroups>
        <NASSecurityGroup>
          <NASSecurityGroupName>default.east-21</NASSecurityGroupName>
          <Status>active</Status>
        </NASSecurityGroup>
      </NASSecurityGroups>
      <Endpoint>
        <Address>xxx.xxx.xxx.xxx</Address>
        <PrivateAddress>yyy.yyy.yyy.yyy</PrivateAddress>
      </Endpoint>
      <Protocol>nfs</Protocol>
      <InstanceCreateTime>2016-02-02T09:07:40.000+09:00</InstanceCreateTime>
      <StorageType>0</StorageType>
      <UpgradeRequired>true</UpgradeRequired>
    </NASInstance>
  </ModifyNASInstanceResult>
  <ResponseMetadata>
    <RequestId>9b66595c-de6e-416a-886f-0104105e2339</RequestId>
  </ResponseMetadata>
</ModifyNASInstanceResponse>
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

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

ページの先頭へ