All Products
Search
Document Center

Cloud Parallel File Storage:GetProtocolMountTarget

Last Updated:Jan 12, 2026

Query the export directory information of the protocol service

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
nas:GetProtocolMountTargetget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NextTokenstringNo

A pagination token. It can be used in the next request to retrieve a new page of results.

M18xMA==
MaxResultslongNo

The number of results for each query.

Valid values: 10 to 100. Default value: 20.

20
FileSystemIdstringYes

The ID of the file system.

  • The IDs of CPFS file systems must start with cpfs-. Example: cpfs-125487****.
  • The IDs of CPFS for Lingjun file systems must start with bmcpfs-. Example: bmcpfs-0015****.
  • The IDs of CPFS SE file systems must start with cpfsse-. Example: cpfsse-022c71b134****.
cpfs-099394bd928c****
ClientTokenstringNo

A client-generated, case-sensitive token that you can use to ensure the idempotency of the request. The token must be unique for each request.

It must be an ASCII string with a maximum length of 64 characters. For more information, see How to ensure 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****
ProtocolServiceIdstringYes

The ID of the protocol service.

ptc-197ed6a00f2b****
ExportIdstringYes

The ID of the export directory for the protocol service.

exp-19abf5beab8d****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

6299428C-3861-435D-AE54-9B330A00****
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

M18xMA==
ProtocolMountTargetobject

Information of the export directory for the protocol service

ExportIdstring

The ID of the export directory.

exp-19abf5beab8d****
ProtocolMountTargetDomainstring

The domain name of the export directory for the protocol service.

cpfs-0229cb80bcc0****-x******.cn-*****.cpfs.aliyuncs.com
ProtocolTypestring

The protocol type of the file system.

Valid values:

  • NFS: Network File System (NFS)
  • SMB: Server Message Block (SMB)
  • cpfs: The protocol type supported by the CPFS file system.
NFS
VpcIdstring

The VPC ID of the export directory.

vpc-bp1h5mxoqfuo3xurf****
VSwitchIdstring

The vSwitch ID of the export directory.

vsw-8vb2qjnxs6hiobzve****
VSwitchIdsarray

The vSwitch ID list of the export directory.

VSwitchIdstring

The vSwitch ID of the export directory.

vsw-bp1q3ro8erikjjrb2****
FsetIdstring

The fileset ID.

fset-299b4ca04de8****
Pathstring

The path of the CPFS directory that was queried.

Format:

  • Must be 1 to 1,024 characters in length.
  • Must be encoded in UTF-8.
  • Must start and end with a forward slash (/). The root directory is /.
/
AccessGroupNamestring

The name of the permission group.

Default permission group: DEFAULT\_VPC\_GROUP\_NAME

DEFAULT_VPC_GROUP_NAME
CreateTimestring

The time when the export directory was created. Return format: yyyy-MM-dd HH:mm:ss

2025-12-22 17:49:25
Statusstring

The status of the export directory. Valid values:

  • CREATING: The export directory is being created.
  • AVAILABLE : The export directory is available.
  • MODIFYING: The export directory is being modified.
  • DELETING: The export directory is being deleted.
  • STOPPING: The export directory is being stopped.
AVAILABLE
Descriptionstring

The description of the export directory.

The description of the export directory.

Examples

Sample success responses

JSONformat

{
  "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": "The description of the export directory."
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingFileSystemIdFileSystemId is mandatory for this action.-
400MissingExportIdExportId is mandatory for this action.-
404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
404Resource.NotFoundThe specified resource does not exist.The specified resource does not exist.

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

Change history

Change timeSummary of changesOperation
2026-01-06Add OperationView Change Details