本文へジャンプします。

ニフクラ APIリファレンス

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

NAS:UpgradeNASInstance

処理概要

NASの基盤アップグレードを行います。

NASの基盤アップグレード中はNASに接続できない状態となり、その間のNASのステータスはupgrading(アップグレード中)となります。

リクエストパラメーター

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

NAS名

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

レスポンス

XML

status

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

result
要素名 説明 備考
UpgradeNASInstanceResponse ルート -  
UpgradeNASInstanceResult 結果 -  
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の作成日時 日時  
InstanceCreateTime 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
UpgradeRequired NAS領域の基盤アップグレード要否 真偽値 基盤アップグレードが必要 : true | 基盤アップグレードは不要 : false
ResponseMetadata 共通メタ情報 -  

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameter.NotFound.NASInstanceIdentifier NASInstance aaaa not found. Sender 404 指定したNASInstanceIdentifierが存在しない場合
Client.Resource.IncorrectState.UpgradeNASInstance The specified NASInstance is not in the available state. Sender 400 指定したNASのステータスが以下ではない場合
  • available
Client.InvalidParameter.CannotSpecify.UpgradeNASInstance The specified NASInstance is already up to date Sender 400 アップグレードが必要ない場合
Client.InvalidParameter.CannotSpecify.NASInstanceIdentifier Cannot upgrade NASInstance for AuthenticationType '1' Sender 400 CIFS (Directory Service 認証) のNASを指定した場合
Client.InvalidParameter.Required.NASInstanceIdentifier The parameter NASInstanceIdentifier must be provided and must not be blank. Sender 400 必須のNASInstanceIdentifierを指定しなかった場合
Client.InvalidParameter.TooLong.NASInstanceIdentifier The parameter NASInstanceIdentifier is not a valid identifier because it is longer than 63 characters. Sender 400 NASInstanceIdentifierに63文字以上指定した場合
Client.InvalidParameter.Format.NASInstanceIdentifier The parameter NASInstanceIdentifier is not a valid identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. Sender 400 ・NASInstanceIdentifierに数字から始まる値を指定した場合
・NASInstanceIdentifierに@を使用した値を指定した場合

リクエストサンプル

https://jp-east-1.nas.api.nifcloud.com/
    ?Action=UpgradeNASInstance
    &NASInstanceIdentifier=example-nas-server
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2019-02-24T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>

レスポンスサンプル

<UpgradeNASInstanceResponse>
  <UpgradeNASInstanceResult>
    <NASInstance>
      <AllocatedStorage>1000</AllocatedStorage>
      <AvailabilityZone>east-21</AvailabilityZone>
      <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>
      <CreateTime>2016-02-02T09:07:34.000+09:00</CreateTime>
      <InstanceCreateTime>2016-02-02T09:07:40.000+09:00</InstanceCreateTime>
      <StorageType>0</StorageType>
      <UpgradeRequired>true</UpgradeRequired>
    </NASInstance>
  </UpgradeNASInstanceResult>
  <ResponseMetadata>
    <RequestId>906c5b0c-7aa0-40fc-a725-3ded0aa3e7bd</RequestId>
  </ResponseMetadata>
</UpgradeNASInstanceResponse>

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