NAS：DescribeNASInstances
処理概要
NASの情報を取得します。
リクエストパラメーター
| 要素名 | 説明 | 必須 | 値 | 最大値 | デフォルト値 | 備考 |
|---|---|---|---|---|---|---|
| NASInstanceIdentifier | NAS名
|
− | 文字列 | − | − |
レスポンス
XML
status
statusは共通の応答メッセージを返却します。
result
| 要素名 | 説明 | 値 | 備考 |
|---|---|---|---|
| DescribeNASInstancesResponse | ルート | − | |
| DescribeNASInstancesResult | 結果 | − | |
| NASInstances | NASリスト | − | |
| 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.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に無効な値（数字から始まる、-で終わるなど）を指定した場合 |
| 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=<Nifty Cloud Access Key ID>
&Signature=<Signature>
レスポンスサンプル
<DescribeNASInstancesResponse>
<DescribeNASInstancesResult>
<NASInstances>
<NASInstance>
<AllocatedStorage>1000</AllocatedStorage>
<AvailabilityZone>east-21</AvailabilityZone>
<NASInstanceIdentifier>example-nas-server</NASInstanceIdentifier>
<NASInstanceStatus>available</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>
</NASInstances>
</DescribeNASInstancesResult>
<ResponseMetadata>
<RequestId>745047b7-7c39-4d24-8eeb-f85df1b381d7</RequestId>
</ResponseMetadata>
</DescribeNASInstancesResponse>
