DescribeMountedClients - File Storage NAS - Alibaba Cloud Documentation Center

Queries the clients on which a file system is mounted.

Operation description

Only General-purpose NAS file systems support this operation.
This operation returns the clients that have accessed the specified file system within the last minute. If the file system is mounted on a client but the client did not access the file system within the last minute, the client is not included in the returned information.

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:
- The required resource types are displayed in bold characters.
- 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:DescribeMountedClients	list	FileSystem acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
PageSize	integer	No	The number of IP addresses to return on each page. Valid values: 1 to 100. Default value: 10.	10
FileSystemId	string	Yes	The ID of the file system.	109c****66
ClientIP	string	No	The IP address of the client. If you specify an IP address, the operation checks whether the client list includes this IP address. If the client list includes the IP address, the operation returns the IP address. If the client list does not include the IP address, the operation returns an empty list. If you do not specify an IP address, the operation returns the IP addresses of all clients that have accessed the specified NAS file system within the last minute.	10.10.10.1
MountTargetDomain	string	Yes	The domain name of the mount target.	1111222****95.cn-hangzhou.nas.aliyuncs.com
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of IP addresses.	10
RequestId	string	The request ID.	A70BEE5D-76D3-49FB-B58F-1F398211****
PageSize	integer	The number of IP addresses returned per page.	10
PageNumber	integer	The page number.	1
Clients	array<object>	The queried clients.
Client	object
ClientIP	string	The IP address of the client.	10.10.10.1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "RequestId": "A70BEE5D-76D3-49FB-B58F-1F398211****",
  "PageSize": 10,
  "PageNumber": 1,
  "Clients": {
    "Client": [
      {
        "ClientIP": "10.10.10.1"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history