Queries the servers on which the anti-ransomware agent is installed in a specific region.

When you create a restoration task, you can use the server information that is returned for the DescribeBackupClients operation to specify the servers whose data you want to restore.

Debugging

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 DescribeBackupClients

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

SupportRegionId String Yes cn-hangzhou

The region in which the anti-ransomware feature is supported. You can call the DescribeSupportRegion operation to query the regions in which the anti-ransomware feature is supported.

Response parameters

Parameter Type Example Description
RequestId String E3ED094C-9EB7-4239-962B-D0FB3D5F23C7

The ID of the request, which is used to locate and troubleshoot issues.

Clients Array of BackupMachineDTO

The information about the anti-ransomware agent.

Uuid String 22f6550d-f294-449b-b6e6-90638fd1****

The UUID of the Elastic Compute Service (ECS) instance on which the anti-ransomware agent is installed.

InstanceId String i-bp15hyph4aci99dv****

The ID of the ECS instance on which the anti-ransomware agent is installed.

ClientStatus String ONLINE

The status of the anti-ransomware agent.

Valid values:

  • INSTALLING: The agent is being installed.
  • ONLINE: The agent is online.
  • UNINSTALLING: The agent is being uninstalled.
  • NOT_INSTALLED: The agent is not installed.
  • ACTIVATED: The agent is enabled.
  • CLIENT_CONNECTION_ERROR: A connection error occurs on the agent.
ClientId String c-000az2f537r73dyh****

The ID of the anti-ransomware agent.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeBackupClients
&SupportRegionId=cn-hangzhou
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupClientsResponse>
    <RequestId>E3ED094C-9EB7-4239-962B-D0FB3D5F23C7</RequestId>
    <Clients>
        <Uuid>22f6550d-f294-449b-b6e6-90638fd1****</Uuid>
        <InstanceId>i-bp15hyph4aci99dv****</InstanceId>
        <ClientStatus>ONLINE</ClientStatus>
        <ClientId>c-000az2f537r73dyh****</ClientId>
    </Clients>
</DescribeBackupClientsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E3ED094C-9EB7-4239-962B-D0FB3D5F23C7",
  "Clients" : [ {
    "Uuid" : "22f6550d-f294-449b-b6e6-90638fd1****",
    "InstanceId" : "i-bp15hyph4aci99dv****",
    "ClientStatus" : "ONLINE",
    "ClientId" : "c-000az2f537r73dyh****"
  } ]
}

Error codes

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