創建CPFS文件系統的協議服務，創建協議服務過程大約需要5～10分鐘。
接口說明
-
該接口僅適用于中國站 CPFS 文件系統。
-
僅 CPFS 2.3.0 及以上版本支持協議服務。您可以通過調用 DescribeFileSystems 接口查詢目標文件系統的版本號。
-
協議服務規格
協議服務包括兩種協議類型：通用型和緩存型。緩存型相比通用型，提供熱點數據緩存能力。在命中緩存的情況下，緩存型協議服務的帶寬可超過 CPFS 文件系統的帶寬，達到協議服務設定的最大帶寬值。
-
通用型：為 CPFS 提供 NFS 協議訪問能力和目錄級掛載點，用戶無需配置 POSIX 客戶端管理集群。該功能免費。
-
緩存型：在通用型基礎上提供基于 LRU 策略的服務端內存緩存。當數據緩存于內存中時，CPFS 可提供更高的內網帶寬。緩存型協議服務分為緩存 1 型和緩存 2 型兩種協議服務規格，差異點為內網帶寬大小和內存緩存大小。
說明 緩存型協議服務為收費服務，正在邀測。有關緩存型協議服務的付費方式，請參見計費項。如果您有任何反饋或疑問，歡迎加入釘釘用戶群（釘釘群號：31045006299）與 CPFS 工程師進行交流討論。 -
-
協議類型
僅支持 NFSv3 協議。
-
其它
-
一個 CPFS 文件系統只能創建一個協議服務。
-
創建協議服務會消耗指定 vSwitch 上的 IP 地址（最多消耗 32 個 IP 地址），請確保目標 vSwitch IP 資源充足。
-
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| nas:CreateProtocolService | create | *FileSystem acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FileSystemId | string | 是 | 文件系統 ID。 | cpfs-099394bd928c**** |
| ProtocolSpec | string | 是 | 協議服務的規格。 取值： General（默認值）。 | General |
| Throughput | integer | 否 | 協議服務的帶寬。 單位：MB/s。 | 8000 |
| ProtocolType | string | 是 | 協議服務的協議類型。 取值：NFS（默認值），僅支持 NFSv3 協議訪問。 | NFS |
| Description | string | 否 | 協議服務的描述。控制臺中顯示為“協議服務名稱”。 限制：
| 此協議服務的描述。 |
| VpcId | string | 是 | 協議服務 VpcId，需與文件系統 VPC 保持一致。 | vpc-2vct297b8157bth9z**** |
| VSwitchId | string | 是 | 協議服務 VSwitchId。 | vsw-2vc3c2lybvdllxyq4**** |
| DryRun | boolean | 否 | 是否對此次創建請求執行預檢。 預檢操作會幫助您檢查參數有效性、依賴條件等，并不會實際創建實例，也不會產生費用。 取值：
| false |
| ClientToken | string | 否 | 保證請求冪等性，從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。 ClientToken 只支持 ASCII 字符，且不能超過 64 個字符。更多信息，請參見如何保證冪等性。 說明
若用戶未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 123e4567-e89b-12d3-a456-42665544**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
"ProtocolServiceId": "ptc-197ed6a00f2b****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | MissingFileSystemId | FileSystemId is mandatory for this action. | 未指定FileSystemId參數。 |
| 400 | MissingVpcId | VpcId is mandatory for this action. | 未指定VPC ID參數。 |
| 400 | MissingVSwitchId | VSwitchId is mandatory for this action. | 未指定vSwitch ID參數。 |
| 403 | InvalidProtocolSpec.NotSupported | The specified protocol spec does not supported. | 指定的ProtocolSpec不支持。 |
| 403 | InvalidNetworkType.NotSupported | The specified network type does not supported. | 指定的網絡類型不支持。 |
| 403 | Instance.IncorrectStatus | The specified instance is in an incorrect status. | 當前狀態不允許操作。 |
| 403 | OperationDenied.ProtocolServiceExceedLimit | The protocol service amount exceed file system limit. | 協議服務數量超過文件系統限制。 |
| 403 | PermissionDenied.CapacityTooLow | Capacity of file system too low to subscribe protocol service. | 容量低于10800GiB不允許開通協議服務。 |
| 403 | PermissionDenied.ThroughputInvalid | Standard protocol service should not specified throughput. | 通用型協議服務不允許指定服務帶寬。 |
| 403 | PermissionDenied.ThroughputTooSmall | Throughput of protocol service too small. | 協議服務帶寬太小，不滿足開通條件。 |
| 403 | PermissionDenied.ThroughputExceed | Throughput of protocol service must less than throughput of file system. | 協議服務的帶寬不允許超過文件系統的帶寬。 |
| 403 | InvalidProtocolType.NotSupported | The specified protocol type does not supported. | 指定的協議類型不支持。 |
| 403 | InvalidVSwitchId.IpShortage | The specified vswitch ip shortage. | 指定的vSwitch可用IP不足。 |
| 403 | InvalidFset.InUse | Fset already used by other export. | 指定的Fileset已被使用。 |
| 403 | InvalidFileSystemPath.InvalidCharacters | The specified filesystem path contains invalid characters. | 指定的文件系統路徑包含非法字符。 |
| 403 | MntPathConflict.InvalidParam | FilesetId and Path must and can only be specified one. | Fileset和Path只能且必須指定一個。 |
| 403 | OperationDenied.TooManyDepth | The operation is denied due to Fsets path too deep. | 文件系統路徑深度超過閾值。 |
| 403 | OperationDenied.InvalidState | The operation is denied due to invalid file system state. | 當前文件系統狀態不支持該操作。 |
| 403 | OperationDenied.NoProtocolServiceQuota | No protocol service quota. | 當前文件系統協議服務配額用盡。 |
| 403 | OperationDenied.NotSupported | The operation is denied due to not supported. | 文件系統不支持協議機服務。 |
| 403 | PermissionDenied.CLThroughputInvalid | Throughput of caching protocol service is invalid. | 緩存型協議服務帶寬無效。 |
| 403 | InvalidVpcId.CrossVpcNotSupport. | Cross VPC not support. | 不支持協議服務和文件系統跨VPC。 |
| 404 | InvalidParameter.VpcNotFound | The specified VPC does not exist. | 指定的VPC網絡不存在。 |
| 404 | InvalidParameter.VswNotFound | The specified VSwitch does not exist. | 指定的虛擬交換機不存在。 |
| 404 | InvalidFileSystem.NotFound | The specified file system does not exist. | 指定的文件系統不存在。 |
| 404 | InvalidDescription.InvalidFormat | Description format is invalid. | 指定的描述格式非法。 |
| 404 | InvalidVpcId.ConflictVpcCidr | Vpc cidr conflict with file system | 指定VPC與文件系統VPC網段重疊。 |
| 404 | InvalidAccessGroupName.NotFound | The specified access group does not exist. | 指定的權限組不存在。 |
| 404 | InvalidAccessGroupName.NotAccessRule | There has no rule in access group. | 指定的權限組中無規則。 |
| 404 | OperationDenied.NoStock | The operation is denied due to no stock. | 文件系統無庫存。 |
| 404 | PathNotExistInFileSystem.InvalidParam | Given path does not exist in file system. | 文件系統中不存在指定的路徑。 |
| 404 | InvalidFsetId.NotFound | The specified Fileset ID does not exist. | 指定的Fileset不存在。 |
| 404 | InvalidParameter.VpcVswitchMismatch | Given vSwitch mismatch with given VPC. | 指定的VPC和vSwitch不匹配。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-09-05 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |