本文へジャンプします。

ニフクラ ユーザーガイド

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

ClearNASSession

処理概要

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

指定するパラメーター

パラメーター 説明 必須
NASInstanceIdentifier string

NAS名

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

使用可能文字: 1〜63字のアルファベット・数字・ハイフン('-')
SessionClearType string セッションクリアタイプ
値:
  • 0 (通常)
  • 1 (強制)
Default: 0

応答フィールド

フィールド (項目) 説明
ClearNASSessionResponse structure ルート
ClearNASSessionResult structure 結果
NASInstance structure NAS
備考: NASInstanceの子要素はDescribeNASInstancesで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
AllocatedStorage integer 割り当てるディスク容量
単位: GB
AvailabilityZone 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
CIFS(Directory Service 認証) : 1
DirectoryServiceDomainName string Directory Service のドメイン名
備考: 対象NASのAuthenticationType=1の場合のみ表示
※ステータスが認証エラーの場合は認証タイプ変更前の情報が表示される
DomainControllers list ドメインコントローラ情報リスト
備考: 対象NASのAuthenticationType=1の場合のみ表示
※ステータスが認証エラーの場合は認証タイプ変更前の情報が表示される
DomainController structure ドメインコントローラ
Hostname string ドメインコントローラのホスト名
IPAddress string ドメインコントローラのIPアドレス
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 指定した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:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD 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>active</Status>
        </NASSecurityGroup>
      </NASSecurityGroups>
      <Endpoint>
        <Address>xxx.xxx.xxx.xxx</Address>
        <PrivateAddress>yyy.yyy.yyy.yyy</PrivateAddress>
      </Endpoint>
      <Protocol>nfs</Protocol>
      <InstanceCreateTime>2018-08-28T00:05:00.000+09:00</InstanceCreateTime>
      <StorageType>0</StorageType>
      <UpgradeRequired>true</UpgradeRequired>
    </NASInstance>
  </ClearNASSessionResult>
  <ResponseMetadata>
    <RequestId>51ecfde1-39f0-4aff-9b95-218f85650cbb</RequestId>
  </ResponseMetadata>
</ClearNASSessionResponse>

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年7月27日時点の情報です。

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