Upgrades a backup client that is installed on one or more ECS instances.

Description

  • This operation creates an asynchronous task at the backend and calls Cloud Assistant to upgrade a backup client that is installed on an ECS instance.
  • You can call the DescribeTask operation to query the execution result of an asynchronous task.
  • The timeout period of an asynchronous task is 15 minutes.

Request parameters

Parameter Type Required Example Description
Action String Yes UpgradeBackupClients

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

InstanceIds Map Yes ["c-*********************"]

The IDs of backup clients. The sum of the number of backup client IDs and the number of ECS instance IDs cannot exceed 100.

ClientIds Map Yes ["i-0xi5wj******3j3bh2gj5"]

The IDs of ECS instances. The sum of the number of backup client IDs and the number of ECS instance IDs cannot exceed 100.

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code. The status code 200 indicates that the request is successful.

Message String successful

The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TaskId String t-*********************

The ID of the asynchronous task. You can call the DescribeTask operation to query the execution result of the asynchronous task.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request failed.
InstanceStatuses Array of InstanceStatuses

The status of the ECS instance.

If the status of an ECS instance cannot meet the requirements to install a backup client and the value of the InstanceIds parameter is greater than 1, an error message is returned based on the value of this parameter.

ValidInstance Boolean true

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.
InstanceId String i-0xi5w***v3j3bh2gj5

The ID of the ECS instance.

ErrorCode String InstanceNotExists

The error code that is returned. 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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpgradeBackupClients
&<Common request parameters>

Sample success responses

XML format

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

<UpgradeBackupClientsResponse>
    <Code>200</Code>
    <Message>successful</Message>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TaskId>t-*********************</TaskId>
    <Success>true</Success>
    <InstanceStatuses>
        <ValidInstance>true</ValidInstance>
        <InstanceId>i-0xi5w***v3j3bh2gj5</InstanceId>
        <ErrorCode>InstanceNotExists</ErrorCode>
    </InstanceStatuses>
</UpgradeBackupClientsResponse>

JSON format

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

{
  "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

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