ニフクラAPI (NAS: DescribeNASInstances)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

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

DescribeNASInstances

処理概要

NASの情報を取得します。

指定するパラメーター

パラメーター	型	説明	必須
NASInstanceIdentifier	string	NAS名 ※最初の文字はアルファベットである必要があります ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません使用可能文字: 1〜63字のアルファベット(小文字)・数字・ハイフン('-')

パラメーター

型

説明

必須

NASInstanceIdentifier

string

NAS名

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

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

応答フィールド

フィールド (項目)	型	説明
DescribeNASInstancesResponse	structure	ルート
␣DescribeNASInstancesResult	structure	結果
␣␣NASInstances	list	NASリスト
␣␣␣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	存在しないNASInstanceIdentifierを指定した場合
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	NASInstanceIdentifierに無効な値（数字から始まる、@を使用した値など）を指定した場合
Client.InvalidParameter.TooLong.NASInstanceIdentifier	The parameter NASInstanceIdentifier is not a valid identifier because it is longer than 63 characters.	Sender	400	NASInstanceIdentifierに63文字以上の値を指定した場合

リクエストサンプル

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

応答サンプル

    <DescribeNASInstancesResponse>
  <DescribeNASInstancesResult>
    <NASInstances>
      <NASInstance>
        <AllocatedStorage>1000</AllocatedStorage>
        <AvailabilityZone>east-21</AvailabilityZone>
        <NASInstanceClass>small</NASInstanceClass>
        <NASInstanceIdentifier>example-nas-server</NASInstanceIdentifier>
        <NASInstanceStatus>available</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>
    </NASInstances>
  </DescribeNASInstancesResult>
  <ResponseMetadata>
    <RequestId>745047b7-7c39-4d24-8eeb-f85df1b381d7</RequestId>
  </ResponseMetadata>
</DescribeNASInstancesResponse>