All Products
Search
Document Center

Apsara File Storage NAS:DescribeMountedClients

Last Updated:Mar 14, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
PageSizeintegerNo

The number of IP addresses to return on each page.

Valid values: 1 to 100.

Default value: 10.

10
FileSystemIdstringYes

The ID of the file system.

109c****66
ClientIPstringNo

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
MountTargetDomainstringYes

The domain name of the mount target.

1111222****95.cn-hangzhou.nas.aliyuncs.com
PageNumberintegerNo

The page number.

Pages start from page 1. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of IP addresses.

10
RequestIdstring

The request ID.

A70BEE5D-76D3-49FB-B58F-1F398211****
PageSizeinteger

The number of IP addresses returned per page.

10
PageNumberinteger

The page number.

1
Clientsobject []

The queried clients.

ClientIPstring

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 timeSummary of changesOperation
No change history