本文へジャンプします。

ニフクラ APIリファレンス

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

NAS:ClearNASSession

処理概要

NASのセッションクリアを行います。
NASのセッションクリアを行うと瞬断が発生し、その間NASのステータスはclearing-session(セッションクリア中)となります。

リクエストパラメーター

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

NAS名

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

セッションクリアタイプ

  • セッションクリアのタイプを指定
  • 値:0(通常) | 1(強制)
  文字列 0  

レスポンス

XML

status

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

result
要素名 説明 備考
ClearNASSessionResponse ルート  
ClearNASSessionResult 結果  
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 のドメイン名 文字列 対象NASの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 指定したNASInstanceIdentifierが存在しない場合
Client.Resource.IncorrectState.ClearNASSession The specified NASInstance is not in the available state. Sender 400 指定したNASのステータスが以下ではない場合
  • available
  • storage-full
Client.InvalidParameter.CannotSpecify.SessionClearType Invalid SessionClearType: 9 Sender 400 SessionClearTypeに 0,1以外を指定した場合
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=ClearNASSession
    &NASInstanceIdentifier=example-nas-server
    &SessionClearType=0
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2018-08-28T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>

レスポンスサンプル

<ClearNASSessionResponse>
  <ClearNASSessionResult>
    <NASInstance>
      <AllocatedStorage>2000</AllocatedStorage>
      <AvailabilityZone>east-21</AvailabilityZone>
      <NASInstanceIdentifier>example-nas-server</NASInstanceIdentifier>
      <NASInstanceStatus>clearing-session</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>2018-08-28T00:00:00.000+09:00</CreateTime>
      <StorageType>0</StorageType>
    </NASInstance>
  </ClearNASSessionResult>
  <ResponseMetadata>
    <RequestId>51ecfde1-39f0-4aff-9b95-218f85650cbb</RequestId>
  </ResponseMetadata>
</ClearNASSessionResponse>

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