Query CPFS Protocol Mount Target Export Directory via API - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Queries the export directory information of a protocol service.

Operation description

Queries the export directory information of a protocol service.

Before you begin

Before you call this operation, make sure that each dependent resource in the following three-layer resource model already exists:

File system (FileSystem): Call DescribeFileSystems to obtain the FileSystemId.
Protocol service (ProtocolService): Call DescribeProtocolService to obtain the ProtocolServiceId, or call CreateProtocolService to create one.
Export directory (ProtocolMountTarget): Call CreateProtocolMountTarget to create an export directory and obtain the ExportId, or call DescribeProtocolMountTarget to query the ExportId.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:GetProtocolMountTarget

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	If the response is truncated, you can use NextToken to send a subsequent request to retrieve the content after the current truncation point.	M18xMA==
MaxResults	integer	No	The maximum number of results to return per query. Valid values: 10 to 100. Default value: 20.	20
FileSystemId	string	Yes	The file system ID. CPFS: The ID must start with `cpfs-`, such as cpfs-125487**. CPFS for Lingjun: The ID must start with `bmcpfs-`, such as bmcpfs-0015. CPFS SE: The ID must start with `cpfsse-`, such as cpfsse-022c71b134**.	cpfs-099394bd928c****
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 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 to ensure idempotence. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API request.	123e4567-e89b-12d3-a456-42665544****
ProtocolServiceId	string	Yes	The protocol service ID. Required. How to obtain: Call the DescribeProtocolService operation to query the list of protocol services and obtain the ProtocolServiceId from the response.	ptc-197ed6a00f2b****
ExportId	string	Yes	The export directory ID of the protocol service. Required. How to obtain: Call CreateProtocolMountTarget to create an export directory and obtain the ExportId from the response. Or call DescribeProtocolMountTarget to query the list of export directories and obtain the ExportId from the response.	exp-19abf5beab8d****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	6299428C-3861-435D-AE54-9B330A00****
NextToken	string	If the response is truncated, you can use NextToken to send a subsequent request to retrieve the content after the current truncation point.	M18xMA==
ProtocolMountTarget	object	The export directory information of the protocol service.
ExportId	string	The export directory ID.	exp-19abf5beab8d****
ProtocolMountTargetDomain	string	The domain name of the protocol service export directory.	cpfs-0229cb80bcc0**-x**.cn-***.cpfs.aliyuncs.com
ProtocolType	string	The protocol type of the file system. Valid values: NFS: NFS protocol SMB: SMB protocol cpfs: the protocol type supported by CPFS file systems	NFS
VpcId	string	The virtual private cloud (VPC) ID of the protocol service export.	vpc-bp1h5mxoqfuo3xurf****
VSwitchId	string	The vSwitch ID of the protocol service export.	vsw-8vb2qjnxs6hiobzve****
VSwitchIds	array	The list of vSwitch IDs of the protocol service export.
	string	The vSwitch ID of the protocol service export.	vsw-bp1q3ro8erikjjrb2****
FsetId	string	Fileset ID。	fset-299b4ca04de8****
Path	string	The path of the queried CPFS directory. Format: The path is 1 to 1,024 characters in length. The path is encoded in UTF-8. The path must start and end with a forward slash (/). The root directory is `/`.	/
AccessGroupName	string	The permission group name. Default permission group: DEFAULT_VPC_GROUP_NAME.	DEFAULT_VPC_GROUP_NAME
CreateTime	string	The creation time. Format: yyyy-MM-dd HH:mm:ss	2025-12-22 17:49:25
Status	string	The status of the protocol service export directory. Valid values: CREATING: Being created. AVAILABLE: Available. MODIFYING: Being modified. DELETING: Being deleted. STOPPING: Being stopped.	AVAILABLE
Description	string	The description of the protocol service export.	Description of this protocol service export

Examples

Success response

JSON format

{
  "RequestId": "6299428C-3861-435D-AE54-9B330A00****",
  "NextToken": "M18xMA==",
  "ProtocolMountTarget": {
    "ExportId": "exp-19abf5beab8d****",
    "ProtocolMountTargetDomain": "cpfs-0229cb80bcc0****-x******.cn-*****.cpfs.aliyuncs.com",
    "ProtocolType": "NFS",
    "VpcId": "vpc-bp1h5mxoqfuo3xurf****",
    "VSwitchId": "vsw-8vb2qjnxs6hiobzve****",
    "VSwitchIds": [
      "vsw-bp1q3ro8erikjjrb2****"
    ],
    "FsetId": "fset-299b4ca04de8****",
    "Path": "/",
    "AccessGroupName": "DEFAULT_VPC_GROUP_NAME",
    "CreateTime": "2025-12-22 17:49:25",
    "Status": "AVAILABLE",
    "Description": "此协议服务导出的描述。"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingFileSystemId	FileSystemId is mandatory for this action.	The FileSystemId parameter is not specified.
400	MissingExportId	ExportId is mandatory for this action.	The ExportId parameter is not specified.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	Resource.NotFound	The specified resource does not exist.	The specified resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.