創建一個文件系統。
接口說明
-
創建文件系統實例需要通過實名認證。具體操作,請參見賬號實名認證。
-
調用此接口將自動創建操作所需的 NAS 服務關聯角色。更多信息,請參見管理 NAS 服務關聯角色。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
nas:CreateFileSystem | create | *FileSystem acs:nas:{#regionId}:{#accountId}:filesystem/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
FileSystemType | string | 否 | 文件系統類型。 取值:
說明
僅中國站支持 CPFS 文件系統。
| standard |
ChargeType | string | 否 | 計費類型。 取值:
| PayAsYouGo |
Duration | integer | 否 | 包年包月時長。 單位:月,當 ChargeType=Subscription 時必填且有效。 當包年包月實例到期時未進行續費,實例到期會自動釋放。 | 1 |
Capacity | long | 否 | 文件系統容量。單位:GiB。 當 FileSystemType=extreme 或 cpfs 時必填且有效。 可選值請參考購買頁面的實際規格: | 100 |
Bandwidth | long | 否 | 150 | |
StorageType | string | 是 | 存儲類型。
| Performance |
ZoneId | string | 否 | 可用區 ID。 可用區是指在同一地域內,電力和網絡互相獨立的物理區域。 當 FileSystemType=standard 時,該參數非必選,默認根據 ProtocolType 及 StorageType 配置隨機選擇一個符合條件的可用區。 當 FileSystemType=extreme 或 FileSystemType=cpfs 時,該參數必選。 說明
| cn-hangzhou-b |
ProtocolType | string | 是 | 文件傳輸協議類型。
| NFS |
EncryptType | integer | 否 | 文件系統是否加密。 使用 KMS 服務托管密鑰,對文件系統落盤數據進行加密存儲。在讀寫加密數據時,無需解密。 取值:
說明
| 1 |
SnapshotId | string | 否 | 快照 ID。 僅支持極速型 NAS。 說明
通過快照創建文件系統,創建的文件系統版本和快照源文件系統版本一致。例如:快照的源文件系統版本是 1,需要創建版本 2 的文件系統,可以先通過快照創建一個文件系統 A,然后再創建一個滿足版本 2 配置的文件系統 B,把文件系統 A 中的數據拷貝至文件系統 B,拷貝完成后把業務遷移到文件系統 B 即可。
| s-xxx |
VpcId | string | 否 | 專有網絡 ID。 當 FileSystemType=cpfs 時,必須配置此參數。 當 FileSystemType=standard 或 extreme 時,此參數為接口預留參數,暫未生效,您無需配置。 | 無 |
VSwitchId | string | 否 | 交換機 ID。 當 FileSystemType=cpfs 時,必須配置此參數。 當 FileSystemType=standard 或 extreme 時,此參數為接口預留參數,暫未生效,您無需配置。 | 無 |
Description | string | 否 | 文件系統描述。 限制:
| 此文件系統的描述。 |
ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符,且不能超過 64 個字符。更多信息,請參見如何保證冪等性。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 123e4567-e89b-12d3-a456-42665544**** |
KmsKeyId | string | 否 | KMS 密鑰 ID。 僅當 EncryptType=2 時該參數必填。 | 無 |
DryRun | boolean | 否 | 是否對此次創建請求執行預檢。 預檢操作會幫助您檢查參數有效性、校驗庫存等,并不會實際創建實例,也不會產生費用。 取值:
| true |
ResourceGroupId | string | 否 | 資源組 ID。 您可以通過資源管理控制臺查看資源組 ID。 | rg-acfmwavnfdf**** |
關于 API 冪等性,您需要注意以下事項:
由于 CreateFileSystem 接口涉及云資源的創建和費用,您在調用該 API 時,如果發生請求超時或服務端內部錯誤,客戶端可能會嘗試重發請求。建議您在請求中設置 ClientToken 參數以避免因多次重試導致的重復下單的問題。
ClientToken 參數的詳細信息如下所示:
- ClientToken 是一個由客戶端生成的唯一的、大小寫敏感、不超過 64 個 ASCII 字符的字符串。例如:
ClientToken=123e4567-e89b-12d3-a456-42665544****
- 如果您提供了一個已經使用過的 ClientToken,但其他請求參數有變化,則 NAS 會返回 IdempotentParameterMismatch 的錯誤代碼。
-
添加了 ClientToken 參數后:
- 返回結果是 200 HTTPCode 時,重試后客戶端可以得到與上次相同的結果,但對您的服務端狀態沒有影響。
- 返回結果是 4xx HTTPCode 時,如果錯誤信息沒有表明 try it later 類似的信息,重試永遠不會成功,您需要根據錯誤信息排查問題后修改請求參數后再重試請求。
- 返回結果是 5xx HTTPCode 時,表明請求可能是發生網絡超時或服務端內部錯誤,您可以重新發送同一個請求(必須包含相同 ClientToken 和業務請求參數)以確認請求結果。
-
ClientToken 有效期為 30 天。
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
"FileSystemId": "1ca404****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
202 | RequestAccepted | The request has been accepted by the server. | 請求已被后端接受。 |
400 | IdempotentParameterMismatch | The same client token was passed in to different parameters. | 相同的ClientToken傳入了不同的參數。 |
400 | InvalidParameter.KmsServiceNotEnabled | Key Management Service is not enabled. | 未啟用KMS服務。 |
400 | InvalidParameter.KmsKeyIdNotFound | The KMS key ID does not exist. | - |
400 | InvalidParameter.InvalidKmsKeyId | The KMS key ID is invalid. | - |
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. | 當前RAM用戶沒有權限創建AliyunServiceRoleForNasExtreme SLR角色,請授權RAM用戶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. | 當前RAM用戶沒有權限創建AliyunServiceRoleForNasStandard SLR角色,請授權RAM用戶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. | 當前RAM用戶沒有權限創建AliyunServiceRoleForNasEncryption SLR角色,請授權RAM用戶ram:CreateServiceLinkedRole權限。 |
400 | InvalidParam.NotSupportBYOK | The specified file system type does not support the BYOK encryption function. | 指定文件系統類型不支持用戶管理密鑰(KMS)加密。 |
400 | MissingParameter.KmsKeyId | When parameter EncryptType equals 2, the parameter KmsKeyId is mandatory for your request. | 當加密類型為用戶管理密鑰(KMS)時,KmsKeyId參數必填。 |
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. | 指定的可用區庫存不足。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-12 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-01-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-26 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |