DescribeProtocolMountTarget - 查询协议服务导出目录 - 文件存储 CPFS

查询协议服务导出目录。

接口说明

该接口仅适用于 CPFS 文件系统。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:DescribeProtocolMountTarget

list

*FileSystem

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

无

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	当请求的返回结果被截断时，您可以使用 NextToken 再次发起请求，获取从当前截断位置之后的内容。	aBcdg==
MaxResults	integer	否	每次查询结果的个数限制。取值范围：10~100 默认值：20	20
FileSystemId	string	是	文件系统 ID。	cpfs-099394bd928c****
Filters	array<object>	否	查询协议服务导出目录的筛选键。
	object	否	查询协议服务导出目录的筛选键。
Key	string	否	筛选键的名称。 ProtocolServiceIds：根据协议服务 ID 筛选。 ExportIds：根据 ExportId 筛选。 VpcIds：根据 VpcId 进行筛选。 FsetIds：根据 Fileset ID 进行筛选。 Paths：根据挂载点对应的文件系统路径进行筛选。 AccessGroupNames：根据权限组名称进行筛选。	ExportIds
Value	string	否	筛选键的值。该参数不支持通配符。 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`。	exp-19abf5beab8d**, exp-19acf6beaf7d**
ClientToken	string	否	保证请求幂等性，从您的客户端生成一个参数值，确保不同的请求间该参数值唯一。 ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。说明若用户未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。	123e4567-e89b-12d3-a456-42665544****
ProtocolServiceIds	string	否	协议服务 Id 列表	ptc-123xxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0****
NextToken	string	用户继续查询剩余导出目录的 Marker。	aBcdeg==
ProtocolMountTargets	array<object>	协议服务导出目录集合。
	object	协议服务导出目录。
ExportId	string	协议服务导出目录 ID。	exp-19abf5beab8d****
ProtocolMountTargetDomain	string	协议服务导出目录的域名。	cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com
ProtocolType	string	协议服务支持的协议类型。	NFS
VpcId	string	协议服务导出的专有网络 ID。	vpc-2vct297b8157bth9z****
VSwitchId	string	协议服务导出的交换机 ID。	vsw-2vc3c2lybvdllxyq4****
FsetId	string	协议服务导出的 Fileset ID。	fset-1902718ea0ae****
Path	string	协议服务导出的目录。	/path/
AccessGroupName	string	协议服务导出目录绑定的权限组。	DEFAULT_VPC_GROUP_NAME
CreateTime	string	协议服务导出目录创建时间。执行 ISO8601 标准表示，返回格式：yyyy-MM-ddTHH:mm:ssZ。	2018-12-12T07:28:38Z
Status	string	挂载点状态。	CREATING
ProtocolServiceId	string	协议服务 ID。	ptc-123****
Description	string	协议服务导出目录的描述。	此协议服务导出目录的描述。
VSwitchIds	array	同城冗余虚拟交换机 ID 列表
	string	同城冗余虚拟交换机 ID 列表	vsw-123xxx

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
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.
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参数非法。

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

变更历史

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