DescribeProtocolMountTarget - Cloud Parallel File Storage

Queries the export directories of a protocol service.

Operation description

This operation is available only to Cloud Parallel File Storage (CPFS) file systems.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nas:DescribeProtocolMountTarget	list	*FileSystem `acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	aBcdg==
MaxResults	long	No	The number of results for each query. Value values: 10 to 100. Default value: 20.	20
FileSystemId	string	Yes	The ID of the file system.	cpfs-099394bd928c****
Filters	array<object>	No	The filter that is used to query the export directories of the protocol service.
	object	No	The filter that is used to query the export directories of the protocol service.
Key	string	No	The filter name. ProtocolServiceIds: Filters export directories by protocol service ID. ExportIds: Filters export directories by export directory ID. VpcIds: Filters export directories by VPC ID. FsetIds: Filters export directories by fileset ID. Paths: Filters export directories based on the path of the file system corresponding to the mount target. AccessGroupNames: Filters export directories by permission group name.	ExportIds
Value	string	No	The filter value. This parameter does not support wildcards. If Key is set to ProtocolServiceIds, set Value to a protocol service ID. You can specify a maximum of 10 protocol service IDs. Example: `ptc-12345678` or `ptc-12345678,ptc-12345679`. If Key is set to ExportIds, set Value to an export directory ID. You can specify a maximum of 10 export directory IDs. Example: `exp-12345678` or `exp-12345678,exp-12345679`. If Key is set to VpcIds, set Value to a VPC ID of the protocol service. You can specify a maximum of 10 VPC IDs. Example: `vpc-12345678` or `vpc-12345678,vpc-12345679`. If Key is set to FsetIds, set Value to a fileset ID. You can specify a maximum of 10 fileset IDs. Example: `fset-12345678` or `fset-12345678,fset-12345679`. If Key is set to Paths, set Value to a path of the file system corresponding to the mount target. You can specify a maximum of 10 paths. Example: `/cpfs/mnt_1/` or `/cpfs/mnt_1/,/cpfs/mnt_2/`. If Key is set to AccessGroupNames, set Value to a permission group name for the protocol service. You can specify a maximum of 10 permission group names. Example: `ag-12345678` or `ag-12345678,ag-12345679`.	exp-19abf5beab8d**, exp-19acf6beaf7d**
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How do I ensure the idempotence? Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-42665544****
ProtocolServiceIds	string	No	Protocol service ID list	ptc-123xxx

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0****
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	aBcdeg==
ProtocolMountTargets	array<object>	The export directories of the protocol service.
protocolMountTarget	object	The export directory of the protocol service.
ExportId	string	The ID of the export directory for the protocol service.	exp-19abf5beab8d****
ProtocolMountTargetDomain	string	The domain name of the export directory for the protocol service.	cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com
ProtocolType	string	The protocol type supported by the protocol service.	NFS
VpcId	string	The VPC ID of the export directory for the protocol service.	vpc-2vct297b8157bth9z****
VSwitchId	string	The vSwitch ID of the export directory for the protocol service.	vsw-2vc3c2lybvdllxyq4****
FsetId	string	The fileset ID of the export directory for the protocol service.	fset-1902718ea0ae****
Path	string	The export directory of the protocol service.	/path/
AccessGroupName	string	The permission group that is associated with the export directory of the protocol service.	DEFAULT_VPC_GROUP_NAME
CreateTime	string	The time when the export directory of the protocol service was created.	2018-12-12T07:28:38Z
Status	string	The status of the mount target.	CREATING
ProtocolServiceId	string	The ID of the protocol service.	ptc-123****
Description	string	The description of the export directory for the protocol service.	test
VSwitchIds	array	A list of IDs for the zone-redundant vSwitches.
VSwitchId	string	A list of IDs for the zone-redundant vSwitches.	vsw-123xxx

Examples

Sample success responses

JSONformat

{
  "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": "test",
      "VSwitchIds": [
        "vsw-123xxx"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingFileSystemId	FileSystemId is mandatory for this action.	-
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.	-
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	-
404	InvalidFilterValue	The specified Filter.N.Value is invalid.	-
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-12-22	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details