DescribeProtocolService - 查询协议服务信息 - 文件存储 CPFS

查询协议服务信息。

接口说明

该接口仅适用于 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非法。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。