全部產品
Search

搜尋本產品

    File Storage NAS：CreateFileSystem

    文件中心

    File Storage NAS：CreateFileSystem

    更新時間：Jul 03, 2026

    建立一個檔案系統。

    介面說明

    • 請確保在使用該介面前，已充分了解 NAS 產品的計費說明和價格。更多資訊，請參見計費說明和價格。

    • 建立檔案系統執行個體需要通過實名認證。具體操作，請參見帳號實名認證。

    • 呼叫此介面將自動建立操作所需的 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/*
    • nas:EncryptedType
    • nas:FileSystemType
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    FileSystemType

    string

    否

    檔案系統類型。

    取值：

    • standard（預設值）：通用型 NAS。

    • extreme：極速型 NAS。

    • cpfs：檔案儲存 CPFS（本地冗餘版本）。

    • cpfsse: 檔案儲存 CPFS SE（同城冗餘版本）。

    枚舉值：

    • standard :

      通用型 NAS。

    • cpfs :

      檔案儲存 CPFS（本地冗餘版本）

    • cpfsse :

      檔案儲存 CPFS SE（同城冗餘版本）

    • extreme :

      極速型 NAS。

    standard
    ChargeType

    string

    否

    計費類型。

    取值：

    • PayAsYouGo（預設值）：按量付費。

    • Subscription：包年包月。

    枚舉值：

    • PayAsYouGo :

      按量付費。

    • Subscription :

      包年包月。

    PayAsYouGo
    Duration

    integer

    否

    包年包月時長。

    單位：月，當 ChargeType=Subscription 時必填且有效。

    當包年包月執行個體到期時未進行續費，執行個體到期會自動釋放。

    1
    Capacity

    integer

    否

    檔案系統容量。單位：GiB。 當 FileSystemType=extreme、cpfs 或 cpfsse 時必填且有效。

    可選值請參考購買頁面的實際規格：

    100
    Bandwidth

    integer

    否

    檔案系統輸送量上限。

    單位：MB/s

    具體可選規格值請參考購買頁面的實際規格。

    並行檔案系統 CPFS 按量付費購買頁面

    150
    StorageType

    string

    是

    儲存類型。

    • 當 FileSystemType=standard 時，取值：Performance（性能型）、Capacity（容量型）、Premium（高級型）。

    • 當 FileSystemType=extreme 時，取值：standard（標準型）、advance（高級型）。

    • 當 FileSystemType=cpfs 時，取值：advance_100（100 MB/s/TiB 基線）、advance_200（200 MB/s/TiB 基線）、economic（經濟型）。

    • 當 FileSystemType=cpfsse 時，取值：advance_100（100 MB/s/TiB 基線）。

    枚舉值：

    • standard :

      極速型 NAS 標準型。

    • Capacity :

      通用型 NAS 容量型。

    • advance_200 :

      檔案儲存 CPFS 200 MB/s/TiB 基線。

    • advance_100 :

      檔案儲存 CPFS 100 MB/s/TiB 基線。

    • Premium :

      通用型 NAS 高級型。

    • Performance :

      通用型 NAS 性能型。

    • economic :

      檔案儲存 CPFS 經濟型。

    • advance :

      極速型 NAS 高級型。

    Performance
    ZoneId

    string

    否

    可用區 ID。

    可用區是指在同一地域內，電力和網路互相獨立的物理區域。

    當 FileSystemType=standard 時，該參數非必選，預設根據 ProtocolType 及 StorageType 配置隨機選擇一個符合條件的可用區。

    當 FileSystemType=extreme 或 FileSystemType=cpfs 時，該參數必選。

    說明

    • 同一地域不同可用區之間的檔案系統與 ECS 雲端伺服器互通。

    • 建議檔案系統與雲端伺服器 ECS 屬於同一可用區，避免跨可用區產生的時延。

    cn-hangzhou-b
    ProtocolType

    string

    是

    檔案傳輸協定類型。

    • 當 FileSystemType=standard 時，取值：NFS、SMB。

    • 當 FileSystemType=extreme 時，取值：NFS。

    • 當 FileSystemType=cpfs 時，取值：cpfs。

    • 當 FileSystemType=cpfsse 時，取值：cpfs。

    枚舉值：

    • cpfs :

      cpfs 協定。

    • SMB :

      SMB 協定。

    • NFS :

      NFS 協定。

    NFS
    EncryptType

    integer

    否

    檔案系統是否加密。

    使用 KMS 服務託管金鑰，對檔案系統落碟資料進行加密儲存。在讀寫加密資料時，無需解密。

    取值：

    • 0（預設值）：不加密。

    • 1：NAS 託管金鑰。當 FileSystemType=standard 或 extreme 時，支援 NAS 託管金鑰。

    • 2：使用者管理金鑰。當 FileSystemType=standard 或 extreme 時，支援使用者管理金鑰。

    說明

    • 極速型 NAS：除華東 1 金融雲外的所有地域支援使用者管理金鑰（KMS）功能。

    • 通用型 NAS：所有地域支援使用者管理金鑰（KMS）功能。

    枚舉值：

    • 0 :

      不加密。

    • 1 :

      NAS 託管金鑰。

    • 2 :

      使用者管理金鑰。

    1
    SnapshotId

    string

    否

    快照 ID。

    僅支援儲存規格為高級型的極速型 NAS。

    說明

    透過快照建立檔案系統，建立的檔案系統版本和快照來源檔案系統版本一致。例如：快照的來源檔案系統版本是 1，需要建立版本 2 的檔案系統，可以先透過快照建立一個檔案系統 A，然後再建立一個滿足版本 2 配置的檔案系統 B，把檔案系統 A 中的資料複製至檔案系統 B，複製完成後把業務遷移到檔案系統 B 即可。

    s-extreme-snapsho****
    VpcId

    string

    否

    專有網路 ID。

    • 當 FileSystemType=cpfs 或 cpfsse 時，必須配置此參數。

    • 當 FileSystemType=standard 或 extreme 時，此參數為介面預留參數，暫未生效，您無需配置。

    vpc-bp18cx9a7zoh0h9b4****
    VSwitchId

    string

    否

    交換機 ID。

    • 當 FileSystemType=cpfs 時，必須配置此參數。

    • 當 FileSystemType 不為 cpfs 時，此參數為介面預留參數，暫未生效，您無需配置。

    vsw-bp131dkqilvw5pnlt****
    Description

    string

    否

    檔案系統描述。

    限制：

    • 長度為 2~128 個英文或中文字元。

    • 必須以大小寫字母或中文開頭，不能以http://和https://開頭。

    • 可以包含數字、半形冒號（:）、底線（_）或者短劃線（-）。

    此文件系统的描述。
    ClientToken

    string

    否

    保證請求冪等性。從您的用戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證冪等性。

    說明

    若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。

    123e4567-e89b-12d3-a456-42665544****
    KmsKeyId

    string

    否

    KMS 金鑰 ID。

    僅當 EncryptType=2 時該參數必填。

    fcbd****-62**-4a**-b605-c58cc1d5****
    DryRun

    boolean

    否

    是否對此次建立請求執行預檢。

    預檢操作會幫助您檢查參數有效性、校驗庫存等，並不會實際建立執行個體，也不會產生費用。

    取值：

    • true：傳送檢查請求，不會建立執行個體。檢查項包括是否填寫了必需參數、請求格式、業務限制和 NAS 庫存。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回 200 HttpCode，但 FileSystemId 為空。

    • false（預設值）：傳送正常請求，通過檢查後直接建立執行個體。

    true
    ResourceGroupId

    string

    否

    資源群組 ID。

    您可以透過資源管理控制台查看資源群組 ID。

    rg-acfmwavnfdf****

    Tag

    array<object>

    否

    標籤陣列。

    陣列長度：1~20。如果陣列中有多個標籤物件，標籤鍵 Key 不允許重複。

    object

    否

    標籤物件。

    Key

    string

    否

    標籤鍵。

    限制：

    • 不允許為空和空字串。

    • 最多支援 128 個字元。

    • 不能以aliyun或acs:開頭。

    • 不能包含http://和https://。

    nastest
    Value

    string

    否

    標籤值。

    限制：

    • 不允許為空和空字串。

    • 最多支援 128 個字元。

    • 不能包含http://和https://。

    testValue
    RedundancyType

    string

    否

    儲存冗餘類型。僅 CPFS SE 生效。 可選：ZRS

    枚舉值：

    • ZRS :

      同城冗餘。

    ZRS
    RedundancyVSwitchIds

    array

    否

    同城冗餘虛擬交換機 ID 列表。 當設定 RedundancyType 為 ZRS 時，必須設定該欄位。且必須填入 3 個交換機 ID，且滿足來自三個不同的可用區。

    string

    否

    同城冗餘虛擬交換機 ID 列表。

    vsw-123xxx

    關於 API 冪等性，您需要注意以下事項：
    由於 CreateFileSystem 介面涉及雲端資源的建立和費用，您在呼叫該 API 時，如果發生請求逾時或服務端內部錯誤，用戶端可能會嘗試重發請求。建議您在請求中設定 ClientToken 參數以避免因多次重試導致的重複下單的問題。

    說明

    當前只有 FileSystemType 參數為 extreme、cpfs 時，該 API 支援冪等；當 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 參數後：

      • 返回結果是 200 HTTPCode 時，重試後用戶端可以得到與上次相同的結果，但對您的服務端狀態沒有影響。

      • 返回結果是 4xx HTTPCode 時，如果錯誤資訊沒有表明 try it later 類似的資訊，重試永遠不會成功，您需要根據錯誤資訊排查問題後修改請求參數後再重試請求。

      • 返回結果是 5xx HTTPCode 時，表明請求可能是發生網路逾時或服務端內部錯誤，您可以重新傳送同一個請求（必須包含相同 ClientToken 和業務請求參數）以確認請求結果。

    • ClientToken 有效期為 30 天。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    結構，不參與評審，不顯示。

    RequestId

    string

    請求 ID。

    98696EF0-1607-4E9D-B01D-F20930B6****
    FileSystemId

    string

    完成建立的檔案系統 ID。

    1ca404****

    樣本

    正常返回樣本

    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.
    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.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。