调用DescribeProtocolService接口查询协议服务信息-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeProtocolService	接口名称。固定取值：DescribeProtocolService。
ProtocolServiceIds	String	否	ptc-197ed6a00f2b**,ptc-196ed6a00f2b**	协议服务ID。格式：CSV 限制：协议服务ID最多可设置10个。
Status	String	否	Running,Updating	按照协议服务的状态作匹配。格式：CSV 取值： Creating：创建中 Starting：启动中 Running：可用 Updating：更新中 Deleting：删除中 Stopping：停止中 Stopped：停止
NextToken	String	否	aBcdg==	如果一次查询结果并没有完整返回所有的数据流动，返回的NextToken不为空说明还有数据未返回，用户在查询中附加正确的NextToken字符串可以继续上一次的查询。
MaxResults	Long	否	20	每次查询结果的个数限制。最大值：100。最小值：10。默认值：20。
FileSystemId	String	是	cpfs-099394bd928c****	文件系统ID。
Description	String	否	此协议服务的描述	协议服务的描述或描述的一部分作匹配。限制：长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以`http://`和`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。
ClientToken	String	否	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见如何保证幂等性。说明若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。

返回数据


名称	类型	示例值	描述
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	请求ID。
NextToken	String	aBcdeg==	用户继续查询剩余协议服务的Marker。
ProtocolServices	Array of protocolService		协议机服务信息列表。
FileSystemId	String	cpfs-099394bd928c****	文件系统ID。
ProtocolServiceId	String	ptc-197ed6a00f2b****	协议服务ID。
ProtocolSpec	String	General	协议机集群的规格。取值范围：General 默认值：General
ProtocolThroughput	Integer	500	协议服务的吞吐。单位：MB/s。
InstanceRAM	Integer	0	协议节点的内存缓存大小。单位：GiB。
InstanceBaseThroughput	Integer	100	协议节点的Base吞吐。单位：MB/s。
InstanceBurstThroughput	Integer	100	协议节点的Burst吞吐。单位：MB/s。
MountTargetCount	Integer	5	此协议服务中导出的CPFS目录和Fileset总数。
ProtocolType	String	NFS	协议服务支持的协议类型。取值范围： NFS：协议服务支持NFS协议访问。
Status	String	Running	协议服务状态。取值： Creating：创建中 Starting：启动中 Running：可用 Updating：更新中 Deleting：删除中 Stopping：停止中 Stopped：停止
Description	String	此协议服务的描述	协议服务的描述。限制：长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以`http://`和`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。
CreateTime	String	2018-12-12T07:28:38Z	协议机服务创建时间，UTC时间。
ModifyTime	String	2018-12-12T07:28:38Z	协议机服务修改时间，UTC时间。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeProtocolService
&ProtocolServiceIds=ptc-197ed6a00f2b****,ptc-196ed6a00f2b****
&Status=Running,Updating
&NextToken=aBcdg==
&MaxResults=20
&FileSystemId=cpfs-099394bd928c****
&Description=此协议服务的描述
&ClientToken=473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeProtocolServiceResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <NextToken>aBcdeg==</NextToken>
    <ProtocolServices>
        <ProtocolService>
            <FileSystemId>cpfs-123****</FileSystemId>
            <ProtocolServiceId>ptc-123***</ProtocolServiceId>
            <ProtocolSpec>General</ProtocolSpec>
            <ProtocolThroughput>500</ProtocolThroughput>
            <InstanceRAM>0</InstanceRAM>
            <InstanceBaseThroughput>100</InstanceBaseThroughput>
            <InstanceBurstThroughput>100</InstanceBurstThroughput>
            <MountTargetCount>5</MountTargetCount>
            <ProtocolType>NFS</ProtocolType>
            <Status>Running</Status>
            <Description>此协议服务的描述</Description>
            <CreateTime>2018-12-12T07:28:38Z</CreateTime>
            <ModifyTime>2018-12-12T07:28:38Z</ModifyTime>
        </ProtocolService>
    </ProtocolServices>
</DescribeProtocolServiceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "NextToken" : "aBcdeg==",
  "ProtocolServices" : {
    "ProtocolService" : [ {
      "FileSystemId" : "cpfs-123****",
      "ProtocolServiceId" : "ptc-123***",
      "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"
    } ]
  }
}

错误码


HttpCode	错误码	错误信息	描述
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.	指定的NextToken非法。
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	指定的MaxResults非法。

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