CreateProtocolService - Cloud Parallel File Storage

建立CPFS檔案系統的協議服務，建立協議服務過程大約需要5～10分鐘。

介面說明

該介面僅適用於 CPFS 檔案系統。
僅 CPFS 2.3.0 及以上版本支援協議服務。您可以透過呼叫 DescribeFileSystems 介面查詢目標檔案系統的版本號。
協議服務規格

協議服務包括兩種協議類型：通用型和快取型。快取型相比通用型，提供熱點資料快取能力。在命中快取的情況下，快取型協議服務的頻寬可超過 CPFS 檔案系統的頻寬，達到協議服務設定的最大頻寬值。
- 通用型：為 CPFS 提供 NFS 協議存取能力和目錄級掛載點，使用者無需設定 POSIX 用戶端管理叢集。該功能免費。
- 快取型：在通用型基礎上提供基於 LRU 策略的服務端記憶體快取。當資料快取於記憶體中時，CPFS 可提供更高的內網頻寬。快取型協議服務分為快取 1 型和快取 2 型兩種協議服務規格，差異點為內網頻寬大小和記憶體快取大小。
說明
快取型協議服務為收費服務，正在邀測。有關快取型協議服務的付費方式，請參見計費項。如果您有任何回饋或疑問，歡迎加入釘釘使用者群（釘釘群號：31045006299）與 CPFS 工程師進行交流討論。
協議類型

僅支援 NFSv3 協議。
前置條件

目標 CPFS 檔案系統必須建立成功處於 Running 狀態。
其它
- 一個 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（預設值）。枚舉值： CL2 : 快取 2 型 General : 通用型 CL1 : 快取 1 型	General
Throughput	integer	否	協議服務的頻寬。單位：MB/s。	8000
ProtocolType	string	是	協議服務的協議類型。取值：NFS（預設值），僅支援 NFSv3 協議存取。	NFS
Description	string	否	協議服務的描述。控制台中顯示為「協議服務名稱」。限制：長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭，不能以`http://`和`https://`開頭。可以包含數字、半形冒號（:）、底線（_）或者短橫線（-）。	此协议服务的描述。
VpcId	string	否	協議服務 VpcId，需與檔案系統 VPC 保持一致。當檔案系統的儲存冗餘類型為同城冗餘（ZRS）時禁止設定該欄位。其他情況，該欄位必填	vpc-2vct297b8157bth9z****
VSwitchId	string	否	協議服務 VSwitchId。當檔案系統的儲存冗餘類型為同城冗餘（ZRS）時禁止設定該欄位。其他情況，該欄位必填。	vsw-2vc3c2lybvdllxyq4****
DryRun	boolean	否	是否對此次建立請求執行預檢。預檢操作會幫助您檢查參數有效性、依賴條件等，並不會實際建立執行個體，也不會產生費用。取值： true：傳送檢查請求，不會建立協議服務。檢查項包括是否填寫了必需參數、請求格式、業務限制依賴條件。如果檢查不通過，則傳回對應錯誤。如果檢查通過，則傳回 200 HttpCode，但 ProtocolServiceId 為空。 false（預設）：傳送正常請求，通過檢查後直接建立執行個體。	false
ClientToken	string	否	保證請求冪等性，從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。 ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證冪等性。說明若使用者未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。	123e4567-e89b-12d3-a456-42665544****

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	98696EF0-1607-4E9D-B01D-F20930B6****
ProtocolServiceId	string	協議機叢集 ID。	ptc-197ed6a00f2b****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "ProtocolServiceId": "ptc-197ed6a00f2b****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	MissingVpcId	VpcId is mandatory for this action.
400	MissingVSwitchId	VSwitchId is mandatory for this action.
403	InvalidProtocolSpec.NotSupported	The specified protocol spec does not supported.
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.
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.
403	InvalidFset.InUse	Fset already used by other export.
403	InvalidFileSystemPath.InvalidCharacters	The specified filesystem path contains invalid characters.
403	MntPathConflict.InvalidParam	FilesetId and Path must and can only be specified one.
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.
404	InvalidParameter.VpcNotFound	The specified VPC does not exist.
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
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.
404	InvalidParameter.VpcVswitchMismatch	Given vSwitch mismatch with given VPC.

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

變更歷史

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