ファイルシステムを作成します。
操作説明
-
この API を使用する前に、NAS プロダクトの課金に関する説明と価格を十分に理解していることを確認してください。詳細については、「課金」および「価格」をご参照ください。
-
ファイルシステムインスタンスを作成するには、実名認証が必要です。具体的な操作については、「アカウントの実名認証」をご参照ください。
-
この API を呼び出すと、操作に必要な NAS サービスにリンクされたロールが自動的に作成されます。詳細については、「NAS サービスにリンクされたロールの管理」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
nas:CreateFileSystem |
create |
*FileSystem
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| FileSystemType |
string |
任意 |
ファイルシステムのタイプ。 有効値:
|
standard |
| ChargeType |
string |
任意 |
課金方法。 有効値:
|
PayAsYouGo |
| Duration |
integer |
任意 |
サブスクリプション期間。 このパラメーターは、`ChargeType` が `Subscription` に設定されている場合に有効かつ必須です。単位:月。 サブスクリプションのファイルシステムが有効期限切れになったときに更新しない場合、ファイルシステムは自動的にリリースされます。 |
1 |
| Capacity |
integer |
任意 |
ファイルシステムの容量を指定します。単位:GiB。このパラメーターは、`FileSystemType` が `extreme`、`cpfs`、または `cpfsse` に設定されている場合に必須かつ有効です。 以下の購入ページの仕様に基づいて値を指定してください: |
100 |
| Bandwidth |
integer |
任意 |
ファイルシステムの最大スループット。 単位:MB/s。 購入ページの仕様に基づいて値を指定してください。 |
150 |
| StorageType |
string |
必須 |
ストレージタイプ。
|
Performance |
| ZoneId |
string |
任意 |
ゾーン ID。 各リージョンには、ゾーンとして知られる複数の独立した場所があります。各ゾーンには、独自の独立した電源とネットワークがあります。 `FileSystemType` が `standard` に設定されている場合、このパラメーターは必須ではありません。デフォルトでは、プロトコルタイプとストレージタイプに基づいてランダムなゾーンが選択されます。 `FileSystemType` が `extreme` または `cpfs` に設定されている場合、このパラメーターは必須です。 説明
|
cn-hangzhou-b |
| ProtocolType |
string |
必須 |
プロトコルタイプを指定します。
|
NFS |
| EncryptType |
integer |
任意 |
ファイルシステム内のデータを暗号化するかどうかを指定します。 Key Management Service (KMS) によって管理されるキーを使用して、ファイルシステム内のデータを暗号化できます。暗号化されたデータを読み書きする際、データは自動的に復号されます。 有効値:
説明
|
1 |
| SnapshotId |
string |
任意 |
スナップショット ID。 このパラメーターは、アドバンスドエクストリーム NAS ファイルシステムでのみ利用可能です。 説明
スナップショットからファイルシステムを作成できます。ファイルシステムのバージョンは、ソースファイルシステムのバージョンと同じです。たとえば、スナップショットのソースファイルシステムがバージョン 1 を使用している場合、バージョン 2 のファイルシステムを作成するには、スナップショットからファイルシステム A を作成し、バージョン 2 のファイルシステム B を作成します。その後、データをコピーし、ビジネスをファイルシステム A からファイルシステム B に移行します。 |
s-extreme-snapsho**** |
| VpcId |
string |
任意 |
VPC ID。
|
vpc-bp18cx9a7zoh0h9b4**** |
| VSwitchId |
string |
任意 |
vSwitch ID。
|
vsw-bp131dkqilvw5pnlt**** |
| Description |
string |
任意 |
ファイルシステムの説明。 制限事項:
|
此文件系统的描述。 |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。ClientToken は ASCII 文字のみをサポートし、64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。 説明
このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。 |
123e4567-e89b-12d3-a456-42665544**** |
| KmsKeyId |
string |
任意 |
KMS キーの ID。 このパラメーターは、`EncryptType` が 2 に設定されている場合に必須です。 |
fcbd****-62**-4a**-b605-c58cc1d5**** |
| DryRun |
boolean |
任意 |
作成リクエストを事前にチェックするかどうか。 事前チェック操作は、パラメーターの有効性を確認し、在庫を検証するのに役立ちます。実際にはインスタンスを作成せず、料金も発生しません。 有効値:
|
true |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。 Resource Management コンソールにログインして、リソースグループ ID を表示できます。 |
rg-acfmwavnfdf**** |
| Tag |
array<object> |
任意 |
タグの配列。 最大 20 個のタグを指定できます。複数のタグを指定する場合、各タグキーは一意である必要があります。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
タグキー。 制限事項:
|
nastest |
| Value |
string |
任意 |
タグ値。 制限事項:
|
testValue |
| RedundancyType |
string |
任意 |
ストレージの冗長タイプ。CPFS SE でのみ利用可能です。 有効値:
列挙値:
|
ZRS |
| RedundancyVSwitchIds |
array |
任意 |
ゾーン冗長 vSwitch の ID のリスト。このパラメーターは、`RedundancyType` が `ZRS` に設定されている場合に必須です。3 つの異なるゾーンから 3 つの vSwitch ID を入力する必要があります。 |
|
|
string |
任意 |
ゾーン冗長 vSwitch の ID のリスト。 |
vsw-123xxx |
API のべき等性に関する注意事項:
`CreateFileSystem` API はクラウド資源の作成と費用に関わるため、この API を呼び出す際にリクエストのタイムアウトやサーバー内部エラーが発生した場合、クライアントはリクエストを再試行することがあります。複数回のリトライによる重複注文の問題を避けるため、リクエストに `ClientToken` パラメーターを設定することを推奨します。
現在、この API がべき等性をサポートするのは、`FileSystemType` パラメーターが `extreme` または `cpfs` の場合のみです。`FileSystemType` パラメーターが `standard` の場合、この API はべき等性をサポートしません。
`ClientToken` パラメーターの詳細は以下の通りです:
`ClientToken` は、クライアントによって生成される、大文字と小文字を区別する一意の文字列で、64 ASCII 文字を超えてはなりません。例:
ClientToken=123e4567-e89b-12d3-a456-42665544****使用済みの `ClientToken` を指定し、かつ他のリクエストパラメーターが変更されている場合、NAS は `IdempotentParameterMismatch` のエラーコードを返します。
`SignatureNonce`、`Timestamp`、`Signature` パラメーターはリトライ時に変更する必要があります。これは、NAS がリプレイ攻撃を防ぐために `SignatureNonce` を使用し、各リクエストの時間をマークするために `Timestamp` を使用するためです。したがって、再リクエスト時には異なる `SignatureNonce` と `Timestamp` の値を指定する必要があり、それに伴い `Signature` の値も変更されます。
-
`ClientToken` パラメーターを追加した場合:
レスポンス結果が HTTP ステータスコード 200 の場合、リトライ後にクライアントは前回と同じ結果を得ることができ、サーバー側の状態には影響しません。
レスポンス結果が HTTP ステータスコード 4xx の場合、エラーメッセージに「try it later」のような情報が含まれていなければ、リトライは成功しません。エラーメッセージに基づいて問題を調査し、リクエストパラメーターを修正してからリクエストを再試行する必要があります。
レスポンス結果が HTTP ステータスコード 5xx の場合、リクエストがネットワークタイムアウトまたはサーバー内部エラーである可能性があります。同じリクエスト (同じ `ClientToken` とビジネスリクエストパラメーターを含む必要があります) を再送信して、リクエストの結果を確認できます。
-
`ClientToken` の有効期間は 30 日間です。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
98696EF0-1607-4E9D-B01D-F20930B6**** |
| FileSystemId |
string |
作成されたファイルシステムの ID。 |
1ca404**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
"FileSystemId": "1ca404****"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 202 | RequestAccepted | The request has been accepted by the server. | |
| 400 | IdempotentParameterMismatch | The same client token was passed in to different parameters. | |
| 400 | InvalidParameter.KmsServiceNotEnabled | Key Management Service is not enabled. | |
| 400 | DryRunOperation | The request is validated with DryRun flag set. | |
| 400 | SubAccount.NoExtremeSLRPermission | The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasExtreme. Please authorize the RAM user the permission ram:CreateServiceLinkedRole. | |
| 400 | SubAccount.NoStandardSLRPermission | The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasStandard. Please authorize the RAM user the permission ram:CreateServiceLinkedRole. | |
| 400 | SubAccount.NoEncryptionSLRPermission | The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasEncryption. Please authorize the RAM user the permission ram:CreateServiceLinkedRole. | |
| 400 | InvalidParam.NotSupportBYOK | The specified file system type does not support the BYOK encryption function. | |
| 400 | MissingParameter.KmsKeyId | When parameter EncryptType equals 2, the parameter KmsKeyId is mandatory for your request. | |
| 400 | InvalidParameter.InvalidKmsKeyId | The specified KMS key ID is invalid. | |
| 400 | InvalidParameter.KmsKeyIdNotFound | The specified KMS key ID does not exist. | |
| 403 | OperationDenied.InvalidState | The operation is not permitted when the status is processing. | |
| 403 | InvalidFileSystem.AlreadyExisted | The specified file system already exists. | |
| 403 | Resource.OutOfStock | The inventory of the specified zone is insufficient. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。