DescribeBackupClients - Security Center - Alibaba Cloud Documentation Center

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

Operation description

You can call the DescribeBackupClients operation to query the servers on which the anti-ransomware agent is installed in a specified region.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SupportRegionId	string	Yes	The region in which the anti-ransomware feature is supported. Note You can call the DescribeSupportRegion operation to query the regions in which the anti-ransomware feature is supported.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	E3ED094C-9EB7-4239-962B-D0FB3D5F23C7
Clients	array<object>	An array that consists of the information about the anti-ransomware agent.
BackupMachineDTO	object	The information about the server on which the anti-ransomware agent is installed.
Uuid	string	The UUID of the Elastic Compute Service (ECS) instance on which the anti-ransomware agent is installed.	22f6550d-f294-449b-b6e6-90638fd1****
InstanceId	string	The ID of the ECS instance on which the anti-ransomware agent is installed.	i-bp15hyph4aci99dv****
ClientStatus	string	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.	ONLINE
ClientId	string	The ID of the anti-ransomware agent.	c-000az2f537r73dyh****
ClientVersion	string	The version of the anti-ransomware agent.	2.0.0

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation

No change history