DescribeCpfsAccessPointMountedClients - Cloud Parallel File Storage

Operation description

Queries the list of clients mounted to a CPFS for Lingjun access point.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
FileSystemId	string	Yes	The file system ID.	bmcpfs-370lx1ev9ss27o0****
AccessPointId	string	Yes	The access point ID.	ap-ie15yd****
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
MountedClient	array<object>	The clients mounted to the access point.
	object
ChannelType	string	The channel type of the client mounted to the access point. Valid values: vsc and tcp.	vsc
ClientId	string	The ID of the client mounted to the access point.	vsc-8vb864o3ppwfvh****
ClientIp	string	The IP address of the client mounted to the access point.	219.145.34.210
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned per page. Valid values: 1 to 100. Default value: 10.	10
TotalCount	integer	The total number of clients mounted to the access point.	10

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "MountedClient": [
    {
      "ChannelType": "vsc",
      "ClientId": "vsc-8vb864o3ppwfvh****",
      "ClientIp": "219.145.34.210"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRequest	The request is invalid.	Invalid request
400	InvalidParameter.FileSystem	Invalid FileSystem in ResourceIds.	The file system in the ResourceIds is invalid.
400	InvalidFilesystemType.NotSupport	This Api does not support this fileSystem type.	The current interface does not support this type of file system.
400	FeatureOrAPI.NotSupported	The Feature/API is not supported in this region now.	This feature or API is not currently supported in this region.
403	Forbbiden.Ram	User not authorized to operate on the specified resource, or this API doesn't support RAM.	The user is not authorized to operate the specified resource, or the API does not support RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.