DescribeProtocolService - 查詢協議服務資訊 - Cloud Parallel File Storage

查詢協議服務資訊。

介面說明

該介面僅適用於 CPFS 檔案系統。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

nas:DescribeProtocolService

list

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

無

請求參數

名稱	類型	必填	描述	樣本值
ProtocolServiceIds	string	否	協議服務 ID。格式：CSV 限制：協議服務 ID 最多可設定 10 個。	ptc-197ed6a00f2b**,ptc-196ed6a00f2b**
Status	string	否	按照協議服務的狀態作匹配。格式：CSV 取值： Creating：建立中 Starting：啟動中 Running：可用 Updating：更新中 Deleting：刪除中 Stopping：停止中 Stopped：停止	Running,Updating
NextToken	string	否	當請求的返回結果被截斷時，您可以使用 NextToken 再次發起請求，擷取從當前截斷位置之後的內容。	aBcdg==
MaxResults	integer	否	每次查詢結果的個數限制。最大值：100。最小值：10。預設值：20。	20
FileSystemId	string	是	檔案系統 ID。	cpfs-099394bd928c****
Description	string	否	協議服務的描述或描述的一部分作匹配。限制：長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭，不能以`http://`和`https://`開頭。可以包含數字、半形冒號（:）、底線（_）或者短劃線（-）。	此協議服務的描述
ClientToken	string	否	保證請求等冪性。從您的用戶端產生一個參數值，確保不同的請求間該參數值唯一。ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證等冪性。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NextToken	string	使用者繼續查詢剩餘協議服務的 Marker。	aBcdeg==
ProtocolServices	array<object>	協議機服務資訊列表。
	object	協議服務資訊。
FileSystemId	string	檔案系統 ID。	cpfs-099394bd928c****
ProtocolServiceId	string	協議服務 ID。	ptc-197ed6a00f2b****
ProtocolSpec	string	協議機叢集的規格。取值範圍：General 預設值：General	General
ProtocolThroughput	integer	協議服務的吞吐。單位：MB/s。	500
InstanceRAM	integer	協議節點的記憶體緩衝大小。單位：GiB。	0
InstanceBaseThroughput	integer	協議節點的 Base 吞吐。單位：MB/s。	100
InstanceBurstThroughput	integer	協議節點的 Burst 吞吐。單位：MB/s。	100
MountTargetCount	integer	此協議服務中匯出的 CPFS 目錄和 Fileset 總數。	5
ProtocolType	string	協議服務支援的協議類型。取值範圍： NFS：協議服務支援 NFS 協議訪問。	NFS
Status	string	協議服務狀態。取值： Creating：建立中 Starting：啟動中 Running：可用 Updating：更新中 Deleting：刪除中 Stopping：停止中 Stopped：停止	Running
Description	string	協議服務的描述。限制：長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭，不能以`http://`和`https://`開頭。可以包含數字、半形冒號（:）、底線（_）或者短劃線（-）。	此協議服務的描述
CreateTime	string	協議機服務建立時間，UTC 時間。	2018-12-12T07:28:38Z
ModifyTime	string	協議機服務修改時間，UTC 時間。	2018-12-12T07:28:38Z
VpcId	string	協議服務關聯的 VPC ID	vpc-123xxx
VSwitchId	string	協議服務關聯的 VSW ID	vsw-123xxx

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "NextToken": "aBcdeg==",
  "ProtocolServices": [
    {
      "FileSystemId": "cpfs-099394bd928c****",
      "ProtocolServiceId": "ptc-197ed6a00f2b****",
      "ProtocolSpec": "General",
      "ProtocolThroughput": 500,
      "InstanceRAM": 0,
      "InstanceBaseThroughput": 100,
      "InstanceBurstThroughput": 100,
      "MountTargetCount": 5,
      "ProtocolType": "NFS",
      "Status": "Running",
      "Description": "此協議服務的描述",
      "CreateTime": "2018-12-12T07:28:38Z",
      "ModifyTime": "2018-12-12T07:28:38Z",
      "VpcId": "vpc-123xxx",
      "VSwitchId": "vsw-123xxx"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	MissingFileSystemId	FileSystemId is mandatory for this action.	未指定FileSystemId參數。
400	InvalidParam.TooManyProtocolServiceIds	Too many protocol service ids given.	一次查詢指定的協議服務ID過多。
403	InvalidStatus.NotSupported	The specified protocol service status does not support.	指定的協議機叢集狀態不支援。
404	InvalidFileSystem.NotFound	The specified file system does not exist.	指定的檔案系統不存在。
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	指定的MaxResults非法。

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

變更歷史

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