DescribeBackupClients API Overview for Anti-Ransomware Servers - Security Center - Alibaba Cloud - Security Center

Operation description

Queries servers that have the anti-ransomware client installed in a specified region.

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

yundun-sas:DescribeBackupClients

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The response data of servers that have the anti-ransomware client installed.
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use the request ID to troubleshoot issues.	E3ED094C-9EB7-4239-962B-D0FB3D5F23C7
Clients	array<object>	The anti-ransomware client information.
	object	The information about the server that has the anti-ransomware client installed.
Uuid	string	The UUID of the ECS instance that has the anti-ransomware client installed.	22f6550d-f294-449b-b6e6-90638fd1****
InstanceId	string	The instance ID of the ECS instance that has the anti-ransomware client installed.	i-bp15hyph4aci99dv****
ClientStatus	string	The status of the anti-ransomware client. Valid values: INSTALLING: The client is being installed. ONLINE: The client is online. UNINSTALLING: The client is being uninstalled. NOT_INSTALLED: The client is not installed. ACTIVATED: The client is activated. CLIENT_CONNECTION_ERROR: A client connection error occurred.	ONLINE
ClientId	string	The anti-ransomware client ID.	c-000az2f537r73dyh****
ClientVersion	string	The version number of the anti-ransomware client.	2.0.0

Examples

Success response

JSON format

{
  "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
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.