查詢協議服務信息。
接口說明
該接口僅適用于中國站 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。
| ptc-197ed6a00f2b****,ptc-196ed6a00f2b**** |
| Status | string | 否 | 按照協議服務的狀態作匹配。 格式：CSV 取值：
| Running,Updating |
| NextToken | string | 否 | 當請求的返回結果被截斷時，您可以使用 NextToken 再次發起請求，獲取從當前截斷位置之后的內容。 | aBcdg== |
| MaxResults | long | 否 | 每次查詢結果的個數限制。
| 20 |
| FileSystemId | string | 是 | 文件系統 ID。 | cpfs-099394bd928c**** |
| Description | string | 否 | 協議服務的描述或描述的一部分作匹配。 限制：
| 此協議服務的描述 |
| ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數值，確保不同的請求間該參數值唯一。ClientToken 只支持 ASCII 字符，且不能超過 64 個字符。更多信息，請參見如何保證冪等性。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
返回參數
示例
正常返回示例
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"
}
]
}錯誤碼
| 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非法。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史