Batch Upgrade HBR Clients on ECS Instances - Cloud Backup - Alibaba Cloud - Cloud Backup

Operation description

Creates an asynchronous backend job that calls Cloud Assistant to upgrade the HBR client installed on an ECS instance.
You can call the DescribeTask operation to query the result of the asynchronous job.
The asynchronous job times out after 15 minutes.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	object	No	The IDs of ECS instances. The combined number of ECS instance IDs and Cloud Backup client IDs cannot exceed 100.	["c-*********************"]
ClientIds	object	No	The IDs of Cloud Backup clients. The combined number of Cloud Backup client IDs and ECS instance IDs cannot exceed 100.	["i-0xi5wj******3j3bh2gj5"]
CrossAccountType	string	No	Specifies whether the backup runs within the same Alibaba Cloud account or across accounts. Valid values: SELF_ACCOUNT: Backs up data within the same Alibaba Cloud account. CROSS_ACCOUNT: Backs up data across Alibaba Cloud accounts.	CROSS_ACCOUNT
CrossAccountUserId	integer	No	The ID of the source Alibaba Cloud account that authorizes the current account for cross-account backup.	1283948272xxxxx
CrossAccountRoleName	string	No	The name of the RAM role created within the source Alibaba Cloud account and assigned to the current account for cross-account backup authorization.	hbrcrossrole

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code. Status code 200 indicates a successful call.	200
Message	string	The returned message. Returns "successful" for a successful call, or an error message if the call fails.	successful
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	The ID of the asynchronous job. Call the DescribeTask operation to query the job result.	t-*********************
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
InstanceStatuses	array<object>	The statuses of the ECS instances. If an ECS instance does not meet the requirements for HBR client installation and multiple instance IDs are specified, an error message is returned for each ineligible instance.
	object
ValidInstance	boolean	Indicates whether an HBR client can be installed on the ECS instance. Valid values: true: An HBR client can be installed on the ECS instance. false: An HBR 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 call 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.