本文へジャンプします。

ニフクラ APIリファレンス

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

NAS:ModifyNASInstance

処理概要

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

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

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
AllocatedStorage

ディスク容量(GB)
※容量を減らすことはできません

  • 高速タイプの場合
  • 値:1000 | 2000 | 3000 | 4000 | 5000 | 6000 | 7000 | 8000 | 9000 | 10000
  • 標準タイプの場合
  • 値:100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900 | 1000
  数値 既存の設定  
NASInstanceIdentifier 変更対象のNAS名 文字列  
NASSecurityGroups.member.N

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

  • ※1つのみ指定可能です。複数指定した場合、2つ目以降は無視されます
  文字配列  
MasterUserPassword

マスターユーザーの新パスワード

  • ※「/」、「@」、「"」、「 」、「'」を除く、印字可能なASCII文字が使用できます。1〜128文字。
  文字列 既存の設定 Protocol = cifs時のみ指定可能
NewNASInstanceIdentifier

新しいNAS名

  • ※1〜63字のアルファベット・数字・ハイフン('-')が使用できます
  • ※最初の文字はアルファベットである必要があります
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません
  文字列    
NASInstanceDescription

NASの説明

  • ※1〜255文字の印字可能なASCII文字が使用できます。
  文字列  
MasterPrivateAddress NAS用のプライベートIPアドレス   文字列  
NetworkId 変更先のプライベートLANのネットワークID
値:net-COMMON_PRIVATE(共通プライベートにする場合) | プライベートLANのネットワークユニークID(プライベートLANにする場合)
文字列    
AuthenticationType 認証タイプ
0 : ローカル認証
1 : Directory Service 認証
  数値 既存の設定 NAS作成時は0
DirectoryServiceDomainName Directory Service のドメイン名
※下記を除く、印字可能なASCII文字が使用できます。1〜256文字。
「;」、「|」、「&」、「`」、「(」、「)」、「$」、「<」、「>」、「*」、「?」、「{」、「}」、「[」、「]」、「!」、「/」、「'」、「"」
※○ 文字列 以下の場合必須
・ローカル認証からDirectory Service 認証へ変更する場合
・ステータスが認証エラー時に再度認証設定変更する場合
DirectoryServiceAdministratorName Directory Service の管理者ユーザー名
※下記を除く、印字可能なASCII文字が使用できます。1〜128文字。
「;」、「|」、「&」、「`」、「(」、「)」、「$」、「<」、「>」、「*」、「?」、「{」、「}」、「[」、「]」、「!」、「/」、「'」、「"」
※○ 文字列 以下の場合必須
・ローカル認証からDirectory Service 認証へ変更する場合
・ドメイン変更する場合
・Directory Service 認証からローカル認証へ変更する場合
・ステータスが認証エラー時に再度認証設定変更する場合
DirectoryServiceAdministratorPassword Directory Service の管理者ユーザーパスワード
※下記を除く、印字可能なASCII文字が使用できます。1〜128文字。
「;」、「|」、「&」、「`」、「(」、「)」、「$」、「<」、「>」、「*」、「?」、「{」、「}」、「[」、「]」、「!」、「/」、「'」、「"」
※○ 文字列 以下の場合必須
・ローカル認証からDirectory Service 認証へ変更する場合
・ドメイン変更する場合
・Directory Service 認証からローカル認証へ変更する場合
・ステータスが認証エラー時に再度認証設定変更する場合
DomainControllers.member.N.Hostname ドメインコントローラのホスト名
※下記を除く、印字可能なASCII文字が使用できます。1〜256文字。
「;」、「|」、「&」、「`」、「(」、「)」、「$」、「<」、「>」、「*」、「?」、「{」、「}」、「[」、「]」、「!」、「/」、「'」、「"」

DomainController.member.N.IPAddressとセットで指定します。
例:&DomainControllers.member.1.Hostname=nasaddc&DomainController.member.1.IPAddress=192.168.100.2
※○ 文字列 Nの部分は連番
以下の場合必須
・ローカル認証からDirectory Service 認証へ変更する場合
・ドメイン変更する場合
・ドメインコントローラ情報を変更する場合
・ステータスが認証エラー時に再度認証設定変更する場合
DomainControllers.member.N.IPAddress ドメインコントローラのIPアドレス
DomainControllers.member.N.Hostnameとセットでを指定します。
例:&DomainControllers.member.1.Hostname=nasaddc&DomainController.member.1.IPAddress=192.168.100.2
※○ 文字列 Nの部分は連番
以下の場合必須
・ローカル認証からDirectory Service 認証へ変更する場合
・ドメイン変更する場合
・ドメインコントローラ情報を変更する場合
・ステータスが認証エラー時に再度認証設定変更する場合
NoRootSquash nfsのroot権限使用許可の指定
true : root権限での使用を許可(no_root_squash)
false : root権限での使用を拒否(root_squash)
真偽値 文字列 既存の設定 プロトコルがnfsの場合のみ有効cifsの場合は入力値を無視する。

レスポンス

XML

status

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

result
要素名 説明 備考
ModifyNASInstanceResponse ルート  
ModifyNASInstanceResult 結果  
NASInstance NAS  
AllocatedStorage 割り当てるディスク容量(GB) 数値  
AvailabilityZone NASのゾーン 文字列  
NASInstanceIdentifier NAS名 文字列  
NASInstanceDescription NASの説明 文字列  
NASInstanceStatus NASのステータス 文字列  
NASInstanceErrorInfo NASのエラー情報 文字列  
NASInstanceErrorCode 発生中のエラーコード 文字列  
NASInstanceErrorMessage 発生中のエラーメッセージ 文字列  
NASSecurityGroups NASファイアウォールグループ情報リスト リスト  
NASSecurityGroup NASファイアウォールグループ  
NASSecurityGroupName NASファイアウォールグループ名 文字列  
Status NASファイアウォールグループのステータス
値:active(有効) | adding(適用中) | removing(取り外し中) | failed(変更失敗)
文字列  
Endpoint エンドポイント  
Address グローバルIPアドレス 文字列  
PrivateAddress プライベートIPアドレス 文字列  
Protocol プロトコル 文字列  
CreateTime NASの作成日時 日時  
MasterUsername NASのユーザー名 文字列  
StorageType ディスクタイプ 数値  
NetworkId プライベートLANのネットワークユニークID 文字列  
AuthenticationType 認証タイプ 数値 CIFS(ローカル認証) or NFS : 0
CIFS(Directory Service 認証) : 1
DirectoryServiceDomainName Directory Service のドメイン名 文字列 AuthenticationType=1のときのみ表示
DomainControllers ドメインコントローラ情報リスト リスト 変更前NASのAuthenticationType=1の場合のみ表示
※ステータスが認証エラーの場合は変更前の情報が表示される
DomainController ドメインコントローラ -  
Hostname ドメインコントローラのホスト名 文字列  
IPAddress ドメインコントローラのIPアドレス 文字列  
NASInstanceType NASタイプ 数値 標準タイプ : 0 | 高速タイプ : 1
NoRootSquash root権限許可 真偽値 許可 : true | 禁止 : false
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ 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.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 '/', '@', '&quot;', ' ', '&apos;' may be used. Sender 400 Protocol= cifs のときにMasterUserPasswordに無効な値(@など)を指定した場合
Client.InvalidParameter.NotAllowed.MasterUserPassword The parameter MasterUserPassword is not a valid password because it is longer than 128 characters. Sender 400 Protocol= cifs のときにMasterUserPasswordに128文字以上指定した場合
Client.InvalidParameter.TooLong.MasterUserPassword Cannot modify MasterPrivateAddress for NASInstance is not PrivateLAN. Sender 400 プライベートLANを使用していないNASでMasterPrivateAddressを指定したとき
Client.InvalidParameter.CannotSpecify.MasterPrivateAddress Requested storage size (1) cannot be less then the current storage size (5) Sender 400 AllocatedStorageに現在より小さい値を指定した場合
Client.InvalidParameter.TooSmall.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 MasterlPrivateAddressに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 CIDR prefix 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.Required.NetworkId The parameter NetworkId must be provided and must not be blank. Sender 400 NetworkIdを指定しなかった場合
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.Missing.DirectoryServiceDomainName The parameter DirectoryServiceDomainName must be provided and must not be blank. Sender 400 以下の認証設定変更時にDirectoryServiceAdministratorNameを指定しなかった場合
・ローカル認証からDirectory Service 認証へ変更
・ステータスが認証エラー時に再度認証設定変更
Client.InvalidParameter.Missing.DirectoryServiceAdministratorName The parameter DirectoryServiceAdministratorName must be provided and must not be blank. Sender 400 以下の認証設定変更時にDirectoryServiceAdministratorNameを指定しなかった場合
・ローカル認証からDirectory Service 認証へ変更
・ドメイン変更
・Directory Service 認証からローカル認証へ変更
・ステータスが認証エラー時に再度認証設定変更
Client.InvalidParameter.Missing.DirectoryServiceAdministratorPassword The parameter DirectoryServiceAdministratorPassword must be provided and must not be blank. Sender 400 以下の認証設定変更時にDirectoryServiceAdministratorPasswordを指定しなかった場合
・ローカル認証からDirectory Service 認証へ変更
・ドメイン変更
・Directory Service 認証からローカル認証へ変更
・ステータスが認証エラー時に再度認証設定変更
Client.InvalidParameter.Missing.DomainControllers.member.Hostname The parameter DomainControllers.member.Hostname must be provided and must not be blank. Sender 400 以下の認証設定変更時DomainControllers.member.Hostnameを指定しなかった場合
・ローカル認証からDirectory Service 認証へ変更
・ドメイン変更
・ドメインコントローラ情報を変更
・ステータスが認証エラー時に再度認証設定変更
Client.InvalidParameter.Missing.DomainControllers.member.IPAddress The parameter DomainControllers.member.IPAddress must be provided and must not be blank. Sender 400 以下の認証設定変更時にDomainControllers.member.IPAddressを指定しなかった場合
・ローカル認証からDirectory Service 認証へ変更
・ドメイン変更
・ドメインコントローラ情報を変更
・ステータスが認証エラー時に再度認証設定変更
Client.InvalidParameter.Format.DomainControllers.member.IPAddress Invalid IPAddress : DomainControllers.member.N.IPAddress Sender 400 無効なIPアドレスの形式を指定した場合
Client.InvalidParameter.CannotSpecify.AuthenticationType Cannot modify AuthenticationType for NASInstance Protocol 'NFS'. Sender 400 Protocol がnfsのNASでAuthenticationType=1指定した場合
Client.InvalidParameter.Unavailable.MasterUserPassword Unavailable MasterUserPassword for AuthenticationType '1' Sender 400 AuthenticationType=1のNASでMasterUserPasswordを変更しようとした場合
Client.InvalidParameter.TooLong.DirectoryServiceDomainName The parameter DirectoryServiceDomainName is not a valid parameter because it is longer than 256 characters. Sender 400 DirectoryServiceDomainNameに256文字以上指定した場合
Client.InvalidParameter.TooLong.DirectoryServiceAdministratorName The parameter DirectoryServiceAdministratorName is not a valid parameter because
it is longer than 128 characters.
Sender 400 DirectoryServiceAdministratorNameに128文字以上指定した場合
Client.InvalidParameter.TooLong.DirectoryServiceAdministratorPassword The parameter DirectoryServiceAdministratorPassword is not a valid parameter because
it is longer than 128 characters.
Sender 400 DirectoryServiceAdministratorPasswordに128文字以上指定した場合
Client.InvalidParameter.TooLong.DomainControllers.member.Hostname The parameter DomainControllers.member.Hostname is not a valid parameter because
it is longer than 256 characters.
Sender 400 DomainControllers.member.Hostnameに128文字以上指定した場合
Client.InvalidParameter.NotAllowed.DirectoryServiceDomainName The parameter DirectoryServiceDomainName is not a valid parameter because It contains the banned characters in the parameter. Sender 400 DirectoryServiceDomainNameに使用禁止文字を指定した場合
Client.InvalidParameter.NotAllowed.DirectoryServiceAdministratorName The parameter DirectoryServiceAdministratorName is not a valid parameter because It contains the banned characters in the parameter. Sender 400 DirectoryServiceAdministratorNameに使用禁止文字を指定した場合
Client.InvalidParameter.NotAllowed.DirectoryServiceAdministratorPassword The parameter DirectoryServiceAdministratorPassword is not a valid parameter because It contains the banned characters in the parameter. Sender 400 DirectoryServiceAdministratorPasswordに使用禁止文字を指定した場合
Client.InvalidParameter.NotAllowed.DomainControllers.member.Hostname The parameter MasterUserPassword is not a valid parameter because It contains the banned characters in the parameter. Sender 400 DomainControllers.member.Hostnameに使用禁止文字を指定した場合
Client.InvalidParameter.Format.NoRootSquash Sender 400 NoRootSquashにtrueまたはfalse以外の値を指定した場合

リクエストサンプル

https://nas.jp-east-2.api.cloud.nifty.com/
    ?Action=ModifyNASInstance
    &AllocatedStorage=2000
    &NASInstanceIdentifier=example-nas-server
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2016-02-24T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>

レスポンスサンプル

<ModifyNASInstanceResponse>
  <ModifyNASInstanceResult>
    <NASInstance>
      <AllocatedStorage>1000</AllocatedStorage>
      <AvailabilityZone>east-21</AvailabilityZone>
      <NASInstanceIdentifier>example-nas-server</NASInstanceIdentifier>
      <NASInstanceStatus>modifying</NASInstanceStatus>
      <NASSecurityGroups>
        <NASSecurityGroup>
          <NASSecurityGroupName>default.east-21</NASSecurityGroupName>
          <Status>available</Status>
        </NASSecurityGroup>
      </NASSecurityGroups>
      <Endpoint>
        <Address>xxx.xxx.xxx.xxx</Address>
        <PrivateAddress>yyy.yyy.yyy.yyy</PrivateAddress>
      </Endpoint>
      <Protocol>nfs</Protocol>
      <CreateTime>2016-02-02T09:07:34.000+09:00</CreateTime>
      <StorageType>0</StorageType>
    </NASInstance>
  </ModifyNASInstanceResult>
  <ResponseMetadata>
    <RequestId>9b66595c-de6e-416a-886f-0104105e2339</RequestId>
  </ResponseMetadata>
</ModifyNASInstanceResponse>

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