Query mounted clients with DescribeMountedClients - File Storage NAS - Alibaba Cloud - File Storage NAS

Operation description

仅通用型 NAS 支持该接口。
客户端列表显示近一分钟对文件系统有读写访问的客户端 IP，部分已挂载而没有访问文件系统的客户端 IP 可能不在此列表中显示。

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

list

*FileSystem

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

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.	31a8e4****
ClientIP	string	No	The IP address of the client. If specified, the operation checks whether this IP address is in the client list. If found, the IP address is returned. If not found, an empty list is returned. If not specified, the operation returns the IP addresses of all clients that 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 elements

Element	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	object
Client	array<object>	The queried clients.
	object
ClientIP	string	The IP address of the client.	10.10.10.1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.