Automate ECS Backup Client Removal via API - Cloud Backup - Alibaba Cloud - Cloud Backup

Operation description

This operation creates an asynchronous backend job and calls Cloud Assistant to uninstall a backup client from an ECS instance.
You can call the DescribeTask operation to query the result of an asynchronous job.
The timeout period of an asynchronous job is 15 minutes. We recommend that you first call the DescribeTask operation 30 seconds after you call UninstallBackupClients, and then query the result every 30 seconds.

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

hbr:UninstallBackupClients

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	object	No	The IDs of Elastic Compute Service (ECS) instances. You can specify a maximum of 20 ECS instances.	["i-0xi5wj5*****v3j3bh2gj5"]
ClientIds	object	No	The IDs of Cloud Backup clients. The total number of Cloud Backup client IDs and ECS instance IDs cannot exceed 20. Otherwise, an error occurs.	["c-*********************"]
CrossAccountType	string	No	Indicates whether data is backed up and restored within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values: SELF_ACCOUNT: Data is backed up and restored within the same Alibaba Cloud account. CROSS_ACCOUNT: Data is backed up and restored across Alibaba Cloud accounts.	CROSS_ACCOUNT
CrossAccountUserId	integer	No	The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account for cross-account backup and restore.	129349237xxxxx
CrossAccountRoleName	string	No	The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account for cross-account backup and restore.	BackupRole

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code. Status code 200 indicates that the request was successful.	200
Message	string	The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.	successful
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	The ID of the asynchronous job. You can call the DescribeTask operation to query the result of the asynchronous job.	t-*********************
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
InstanceStatuses	array<object>	The statuses of the ECS instances.
	object
ValidInstance	boolean	Indicates whether a backup client can be installed on the ECS instance. true: A backup client can be installed on the ECS instance. false: A backup client cannot be installed on the ECS instance.	true
InstanceId	string	The ID of the ECS instance.	i-0xi5w***v3j3bh2gj5
ErrorCode	string	The error code. Valid values: If the value is empty, the request is successful. InstanceNotExists: The ECS instance does not exist. InstanceNotRunning: The ECS instance is not running. CloudAssistNotRunningOnInstance: Cloud Assistant is unavailable.	InstanceNotExists

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-*********************",
  "Success": true,
  "InstanceStatuses": [
    {
      "ValidInstance": true,
      "InstanceId": "i-0xi5w***v3j3bh2gj5",
      "ErrorCode": "InstanceNotExists"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.