Use DescribeProtocolMountTarget to query export directories for a protocol service - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Queries the export directories of a protocol service.

Operation description

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

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:DescribeProtocolMountTarget

list

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token used to initiate the next request when the response is truncated. You can use this token to retrieve the remaining results from where the truncation occurred.	aBcdg==
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-099394bd928c****
Filters	array<object>	No	The filter keys for querying protocol service export directories.
	object	No	The filter keys for querying protocol service export directories.
Key	string	No	The name of the filter key. ProtocolServiceIds: filters by protocol service ID. ExportIds: filters by export directory ID. VpcIds: filters by VPC ID. FsetIds: filters by fileset ID. Paths: filters by the file system path that corresponds to the mount target. AccessGroupNames: filters by permission group name.	ExportIds
Value	string	No	The value of the filter key. Wildcards are not supported. If Key is set to ProtocolServiceIds, set Value to a protocol service ID. You can specify up to 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 up to 10 export directory IDs. Example: `exp-12345678` or `exp-12345678,exp-12345679`. If Key is set to VpcIds, set Value to the VPC ID of the protocol service. You can specify up to 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 up to 10 fileset IDs. Example: `fset-12345678` or `fset-12345678,fset-12345679`. If Key is set to Paths, set Value to the file system directory that corresponds to the mount target. You can specify up to 10 paths. Example: `/cpfs/mnt_1/` or `/cpfs/mnt_1/,/cpfs/mnt_2/`. If Key is set to AccessGroupNames, set Value to the permission group name of the protocol service. You can specify up to 10 permission group names. Example: `ag-12345678` or `ag-12345678,ag-12345679`.	exp-19abf5beab8d**, exp-19acf6beaf7d**
ClientToken	string	No	Ensures the idempotence of the request. Generate a unique parameter value from your client to ensure that the value is unique among different requests. ClientToken supports 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 uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API request.	123e4567-e89b-12d3-a456-42665544****
ProtocolServiceIds	string	No	The list of protocol service IDs.	ptc-123xxx

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0****
NextToken	string	The marker used to retrieve the remaining export directories in subsequent queries.	aBcdeg==
ProtocolMountTargets	array<object>	The collection of protocol service export directories.
	object	The protocol service export directory.
ExportId	string	The ID of the protocol service export directory.	exp-19abf5beab8d****
ProtocolMountTargetDomain	string	The domain name of the protocol service export directory.	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 protocol service export directory.	vpc-2vct297b8157bth9z****
VSwitchId	string	The vSwitch ID of the protocol service export directory.	vsw-2vc3c2lybvdllxyq4****
FsetId	string	The fileset ID of the protocol service export directory.	fset-1902718ea0ae****
Path	string	The exported directory of the protocol service.	/path/
AccessGroupName	string	The permission group associated with the protocol service export directory.	DEFAULT_VPC_GROUP_NAME
CreateTime	string	The time when the protocol service export directory was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2018-12-12T07:28:38Z
Status	string	The mount target status.	CREATING
ProtocolServiceId	string	The protocol service ID.	ptc-123****
Description	string	The description of the protocol service export directory.	此协议服务导出目录的描述。
VSwitchIds	array	The list of zone-redundant vSwitch IDs.
	string	The list of zone-redundant vSwitch IDs.	vsw-123xxx

Examples

Success response

JSON format

{
  "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"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingFileSystemId	FileSystemId is mandatory for this action.	The FileSystemId parameter is not specified.
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.	The specified MaxResults is invalid.
404	InvalidFilterValue	The specified Filter.N.Value is invalid.	The specified Filter.N.Value parameter is invalid.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	The specified Filter.N.Key parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.