Queries the statuses of clients in the blacklist of a Cloud Paralleled File System (CPFS) file system.


The API operation is available only for CPFS file systems.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description 
Action String Yes DescribeBlackListClients

The operation that you want to perform. Set the value to DescribeBlackListClients.

FileSystemId String Yes 1ca404a348

The ID of the file system.

RegionId String Yes cn-hangzhou

The ID of the region where the file system resides.

ClientIP String No

The IP address of the client.

Response parameters

Parameter Type Example Description 
Clients String EVICTING

The IDs of clients and the status of each client. This parameter contains a JSON object, for example, {"client1": "EVICTING","client2":"EVICTED"}.

Available client statuses include:

  • EVICTING indicates that a client is being removed
  • EVICTED indicates that a client is removed
  • ACCEPTING indicates that the write access to the file system is being granted to a client
  • ACCEPTABLE indicates that the write access to the file system is granted to a client
RequestId String A70BEE5D-76D3-49FB-B58F-1F398211A5C3

The ID of the request.


Sample requests

GET https://nas.cn-hangzhou.aliyuncs.com/?Action=DescribeBlackListClients
&<Common request parameters>

Sample success responses

XML fomat


JSON format

	"clients": [

Error codes

For a list of error codes, visit the API Error Center.