调用DescribeProtocolMountTarget查询协议服务导出目录-阿里云帮助中心

该接口仅适用于中国站。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeProtocolMountTarget	接口名称。固定取值：DescribeProtocolMountTarget。
NextToken	String	否	aBcdg==	如果一次查询结果并没有完整返回所有的数据流动，返回的NextToken不为空说明还有数据未返回，在查询中附加正确的NextToken字符串可以继续上一次的查询。
MaxResults	Long	否	20	每次查询结果的个数限制。取值范围：10~100 默认值：20
FileSystemId	String	是	cpfs-099394bd928c****	文件系统ID。
Filters.N.Key	String	否	ExportIds	筛选键的名称。 ProtocolServiceIds：根据协议服务ID筛选。 ExportIds：根据ExportId筛选。 VpcIds：根据VpcId进行筛选。 VSwitchIds：根据VSwitchids进行筛选。 FsetIds：根据Fileset ID进行筛选。 Paths：根据挂载点对应的文件系统路径进行筛选。 AccessGroupNames：根据权限组名称进行筛选。
Filters.N.Value	String	否	exp-19abf5beab8d**, exp-19acf6beaf7d**	筛选键的值。该参数不支持通配符。 Key取值为ProtocolServiceIds时，Value设置为协议服务ID，协议服务ID 最多可设置 10 个。例如`ptc-12345678`或`ptc-12345678,ptc-12345679`。 Key取值为ExportIds时，Value设置为协议服务ID，导出目录ID最多可设置 10 个。例如`exp-12345678`或`exp-12345678,exp-12345679`。 Key取值为VpcIds时，Value设置为协议服务所在的VpcId， Vpc Id最多可设置 10 个。例如 `vpc-12345678`或`vpc-12345678,vpc-12345679`。 Key取值为FsetIds时，Value设置为Fileset ID，Fileset ID 最多可设置 10 个。例如 `fset-12345678`或`fset-12345678,fset-12345679`。 Key取值为Paths时，Value设置为挂载点对应的文件系统目录，Path最多可设置 10 个。例如 `/cpfs/mnt_1/`或`/cpfs/mnt_1/,/cpfs/mnt_2/`。 Key取值为AccessGroupNames时，Value值设置为协议服务的权限组名称，AccessGroupName最多可设置 10 个。例如 `ag-12345678`或`ag-12345678,ag-12345679`。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。 ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见如何保证幂等性。说明若用户未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。

返回数据


名称	类型	示例值	描述
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0****	请求ID。
NextToken	String	aBcdeg==	用户继续查询剩余导出目录的Marker。
ProtocolMountTargets	Array of protocolMountTarget		协议服务导出目录集合。
ExportId	String	exp-19abf5beab8d****	协议服务导出目录ID。
ProtocolMountTargetDomain	String	cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com	协议服务导出目录的域名。
ProtocolType	String	NFS	协议服务支持的协议类型。
VpcId	String	vpc-2vct297b8157bth9z****	协议服务导出的专有网络ID。
VSwitchId	String	vsw-2vc3c2lybvdllxyq4****	协议服务导出的交换机ID。
FsetId	String	fset-1902718ea0ae****	协议服务导出的Fileset ID。
Path	String	/path/	协议服务导出的目录。
AccessGroupName	String	DEFAULT_VPC_GROUP_NAME	协议服务导出目录绑定的权限组。
CreateTime	String	2018-12-12T07:28:38Z	协议服务导出目录创建时间。
Status	String	CREATING	挂载点状态。
ProtocolServiceId	String	ptc-123****	协议服务ID。
Description	String	此协议服务导出目录的描述。	协议服务导出目录的描述。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeProtocolMountTarget
&NextToken=aBcdg==
&MaxResults=20
&FileSystemId=cpfs-099394bd928c****
&Filters=[{"Key":"ExportIds","Value":"exp-19abf5beab8d****, exp-19acf6beaf7d****"}]
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&公共请求参数

正常返回示例

XML格式

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

<DescribeProtocolMountTargetResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0****</RequestId>
    <NextToken>aBcdeg==</NextToken>
    <ProtocolMountTargets>
        <ProtocolMountTarget>
            <ExportId>exp-123****</ExportId>
            <ProtocolMountTargetDomain>cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com</ProtocolMountTargetDomain>
            <ProtocolType>NFS</ProtocolType>
            <VpcId>vpc-123***</VpcId>
            <VSwitchId>vsw-123****</VSwitchId>
            <FsetId>fset-123****</FsetId>
            <Path>/path/</Path>
            <AccessGroupName>DEFAULT_VPC_GROUP_NAME</AccessGroupName>
            <CreateTime>2018-12-12T07:28:38Z</CreateTime>
            <Status>CREATING</Status>
            <ProtocolServiceId>ptc-123****</ProtocolServiceId>
            <Description>此协议服务导出目录的描述。</Description>
        </ProtocolMountTarget>
    </ProtocolMountTargets>
</DescribeProtocolMountTargetResponse>

JSON格式

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

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0****",
  "NextToken" : "aBcdeg==",
  "ProtocolMountTargets" : {
    "ProtocolMountTarget" : [ {
      "ExportId" : "exp-123****",
      "ProtocolMountTargetDomain" : "cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com",
      "ProtocolType" : "NFS",
      "VpcId" : "vpc-123***",
      "VSwitchId" : "vsw-123****",
      "FsetId" : "fset-123****",
      "Path" : "/path/",
      "AccessGroupName" : "DEFAULT_VPC_GROUP_NAME",
      "CreateTime" : "2018-12-12T07:28:38Z",
      "Status" : "CREATING",
      "ProtocolServiceId" : "ptc-123****",
      "Description" : "此协议服务导出目录的描述。"
    } ]
  }
}

错误码


HttpCode	错误码	错误信息	描述
400	MissingFileSystemId	FileSystemId is mandatory for this action.	未指定FileSystemId参数。
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非法。
404	InvalidFilterValue	The specified Filter.N.Value is invalid.	指定的Filter.N.Value参数非法。
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	指定的Filter.N.Key参数非法。

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