NAS：CreateNASInstance
処理概要
NASを新規作成します。
リクエストパラメーター
| 要素名 | 説明 | 必須 | 値 | 最大値 | デフォルト値 | 備考 |
|---|---|---|---|---|---|---|
| AllocatedStorage | ディスク容量(GB)
|
○ | 数値 | − | − | |
| AvailabilityZone | NASが作成されるゾーン 指定可能なゾーンについては、ニフクラ ゾーン別機能対応表をご参照ください。 |
○※ | 文字列 | − | 自動割り当て | |
| NASInstanceIdentifier | NAS名
|
○ | 文字列 | − | − | |
| NASInstanceDescription | NASの説明
|
文字列 | − | − | ||
| NASSecurityGroups.member.N | NASファイアウォールグループのリスト | 文字配列 | − | プロトコルの DefaultSecu rityGroup |
||
| Protocol | プロトコル 値：nfs | cifs |
○ | 文字列 | − | − | |
| MasterUserPassword | マスターユーザーのパスワード
|
○(Protocol にcifsを指定している場合) | 文字列 | − | − | |
| MasterUsername | マスターユーザー名
|
○(Protocol にcifsを指定している場合) | 文字列 | − | − | |
| NetworkId | プライベートLANのネットワークユニークID | − | 文字列 | − | − | |
| MasterPrivateAddress | NAS用のプライベートIPアドレス | ○（プライベートLANを利用している場合） | 文字列 | − | − | |
| NASInstanceType | NASタイプ 0 : 標準タイプ 1 : 高速タイプ |
数値 | − | 1 |
レスポンス
XML
status
statusは共通の応答メッセージを返却します。
result
| 要素名 | 説明 | 値 | 備考 |
|---|---|---|---|
| CreateNASInstanceResponse | ルート | − | |
| CreateNASInstanceResult | 結果 | − | |
| 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 |
| NASInstanceType | NASタイプ | 数値 | 標準タイプ : 0 | 高速タイプ : 1 |
| NoRootSquash | root権限許可 | 真偽値 | false（root権限使用禁止）固定 |
| ResponseMetadata | 共通メタ情報 | − |
エラー
| コード | メッセージ | タイプ | HTTPステータスコード | 説明 |
|---|---|---|---|---|
| Client.InvalidParameter.Duplicate.NASInstanceIdentifier | NASInstance already exists | Sender | 400 | すでに存在するNASInstanceIdentifierを指定した場合 |
| Client.InvalidParameter.NotFound.NASSecurityGroupName | NASSecurityGroup aaaa not found. | Sender | 404 | 存在しないNASSecurityGroupを指定した場合 |
| Client.InvalidParameter.LimitExceeded.NASInstance | Request would result in user exceeding the allowed number of NASInstance. | Sender | 400 | 作成可能なNASの個数に達している場合 |
| Client.InvalidParameter.ZoneMisMatch.NASSecurityGroupName | NASSecurityGroup aaa cannot be used in east-11 zone. The availability zone of aaa is east12. | Sender | 400 | 指定されたゾーンと異なるゾーンに所属するNASファイアウォールグループを指定した場合 |
| Client.InvalidParameter.NotAllowed.MasterUserPassword | The parameter MasterUserPassword is not a valid password. Only printable ASCII characters besides '/', '@', '"', ' ', ''' may be used. | Sender | 400 | Protocol= cifs のときにMasterUserPasswordに無効な値（@など）を使用した値を指定した場合 |
| Client.InvalidParameter.Missing.MasterUserPassword | The parameter MasterUserPassword must be provided and must not be blank. | Sender | 400 | Protocol= cifs のときにMasterUserPasswordを空で値を指定した場合 |
| Client.InvalidParameter.TooLong.MasterUserPassword | The parameter MasterUserPassword is not a valid password because it is longer than 128characters. | Sender | 400 | Protocol= cifs のときにMasterUserPasswordに128文字以上値を指定した場合 |
| Client.InvalidParameter.Format.MasterUsername | Invalid master user name | Sender | 400 | Protocol= cifs のときにMasterUsernameに数字から始まる値を指定した場合 |
| Client.InvalidParameter.TooLong.MasterUsername | The parameter MasterUsername is not a valid name because it is longer than 32characters. | Sender | 400 | Protocol= cifs のときにMasterUsernameに最大文字数以上(32文字) 指定した場合 |
| Client.InvalidParameter.CannotSpecify.MasterUsername | MasterUsername ADD cannot be used as it is a reserved word used by the protocol | Sender | 400 | Protocol= cifs のときにMasterUsernameに予約語を指定した場合 |
| Client.InvalidParameter.Missing.AvailabilityZone | AvailabilityZone is required when using Private LAN. | Sender | 400 | プライベートLAN対象のNASでAvailabilityZoneを指定していない場合 |
| Client.InvalidParameter.Missing.MasterPrivateAddress | The parameter MasterPrivateAddress must be provided and must not be blank for PrivateLAN instance. | Sender | 400 | プライベートLAN対象のNASでMasterPrivateAddressを指定していない場合 |
| Client.InvalidParameter.Reqiured.AllocatedStorage | The parameter AllocatedStorage must be provided and must not be null. | Sender | 400 | 必須のAllocatedStorageを指定しなかった場合 |
| Client.InvalidParameter.Reqiured.NASInstanceIdentifier | The parameter NASInstanceIdentifier must be provided and must not be null. | Sender | 400 | 必須のNASInstanceIdentifierを指定しなかった場合 |
| Client.InvalidParameter.Required.Protocol | The parameter Protocol must be provided and must not be null. | Sender | 400 | 必須のProtocolを指定しなかった場合 |
| Client.InvalidParameter.Missing.MasterUsername | The parameter MasterUsername must be provided and must not be blank. | Sender | 400 | Protocol= cifs のときにMasterUsernameを空で値を指定した場合 |
| Client.InvalidParameter.NotFound.AvailabilityZone | aaa is not a valid availability zone. | Sender | 400 | 存在しないAvailabilityZoneを指定した場合 |
| 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文字以上指定した場合 |
| Client.InvalidParameter.TooLong.NASInstanceDescription | The parameter NASInstanceDescription is not a valid identifier because it is longer than 255 characters. | Sender | 400 | NASInstanceDescriptionに255文字以上指定した場合 |
| Client.InvalidParameter.OutOfRange.AllocatedStorage | Invalid storage size: 11000. The storage size must be between 1000 and 10000 GB. | Sender | 400 | ・NASInstanceType=0指定時、AllocatedStorageに100〜指定された最大値(デフォルトは1000)でない値を指定した場合 ・NASInstanceType=1指定時、AllocatedStorageに1000〜指定された最大値(デフォルトは10000)でない値を指定した場合 |
| Client.InvalidParameter.Format.AllocatedStorage | AllocatedStorage should specify the multiple of 1000. | Sender | 400 | ・NASInstanceType=0指定時、AllocatedStorageに100の倍数でない値を指定した場合 ・NASInstanceType=1指定時、AllocatedStorageに1000の倍数でない値を指定した場合 |
| Client.InvalidParameter.Format.MasterPrivateAddress | Invalid MasterPrivateAddress aaa.bbb.ccc.ddd. | Sender | 400 | MasterlPrivateAddressにIPアドレスとして無効な値を指定したとき |
| Client.InvalidParameter.Duplicate.MasterPrivateAddress | Private address is already in use: 192.168.98.160. | Sender | 400 | MasterPrivateAddressに重複しているIPアドレスを指定したとき |
| Client.InvalidParameter.PrivateAddressMismacth.CIDRprefix | Invalid MasterPrivateAddress: 192.168.128.1/27. Valid CIDR prefix is /20. | Sender | 400 | MasterPrivateAddressのプレフィックスにプライベートLAN作成時のプレフィックスと異なる値を指定したとき |
| Client.InvalidParameter.OutOfRange.MasterPrivateAddress | Invalid MasterPrivateAddress: 192.168.128.31. Valid range is 192.168.128.1-192.168.128.30. | Sender | 400 | MasterPrivateAddressにサブネットの範囲外のIPアドレスを指定したとき |
| Client.InvalidParameter.LimitExceeded.AllocatedStorage | The total storage capacity max limit of east-21 is 10,000GB. | Sender | 400 | AvailavilityZoneに指定されたゾーンに存在している全てのNASのストレージサイズ合計が、設定された上限値を超えてしまう場合 |
| Client.InvalidParameter.NotAllowed.AllocatedStorage | − | Sender | 404 | AllocatedStorageに数値でない値を指定した場合 |
| Client.InvalidParameter.NotFound.NetworkId | Private LAN net-1234abcd does not exist. | Sender | 404 | 存在しないNetWorkIdを指定した場合 |
| Client.InvalidParameter.NotFound.NetworkId | Private LAN net-1234abcd does not belong to availability zone east-11. | Sender | 400 | 指定されたゾーンと異なるゾーンに所属するNetworkIdを指定した場合 |
| Client.Resource.IncorrectState.ApplyNASSecurityGroup | NASSecurityGroup is not in available state. | Sender | 400 | 設定しようとしたNASファイアウォールグループのルールのうち、ステータスが、「authorizing」または「revoking」のルールが存在する場合 |
| Client.InvalidParameter.Format.NASInstanceType | - | Sender | 400 | NASInstanceTypeに有効でない値を指定した場合 |
| Client.InvalidParameter.CannotSpecify.NASInstanceType | Specified NASInstanceType is not available in the specified Availability Zone. | Sender | 400 | 指定されたNASInstanceTypeが適用できないゾーンが指定された場合 |
リクエストサンプル
https://jp-east-1.nas.api.nifcloud.com/
?Action=CreateNASInstance
&AllocatedStorage=1000
&AvailabilityZone=east-21
&NASInstanceIdentifier=example-nas-server
&Protocol=nfs
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2016-02-24T00%3A00%3A00.000Z
&AWSAccessKeyId=<Nifty Cloud Access Key ID>
&Signature=<Signature>
レスポンスサンプル
<CreateNASInstanceResponse>
<CreateNASInstanceResult>
<NASInstance>
<AllocatedStorage>1000</AllocatedStorage>
<AvailabilityZone>east-21</AvailabilityZone>
<NASInstanceIdentifier>example-nas-server</NASInstanceIdentifier>
<NASInstanceStatus>creating</NASInstanceStatus>
<NASInstanceErrorInfo/>
<NASSecurityGroups>
<NASSecurityGroup>
<NASSecurityGroupName>default.east-21</NASSecurityGroupName>
<Status>available</Status>
</NASSecurityGroup>
</NASSecurityGroups>
<Endpoint/>
<Protocol>nfs</Protocol>
<CreateTime>2016-02-02T09:07:34.326+09:00</CreateTime>
<StorageType>0</StorageType>
</NASInstance>
</CreateNASInstanceResult>
<ResponseMetadata>
<RequestId>1dabaebf-472d-4fe5-9f64-4486ca79abde</RequestId>
</ResponseMetadata>
</CreateNASInstanceResponse>
