Upgrading a CBH Instance

This API is used to upgrade a CBH instance.

For details, see Calling APIs.

POST /v2/{project_id}/cbs/instance/upgrade

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. To obtain the value, see Obtaining a Project ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header. For details, see Obtaining a User Token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
server_id	Yes	String	Instance ID.
upgrade_time	Yes	Long	Scheduled upgrade time, which must be 24 hours later than the current time.
cancel	No	Boolean	Whether to cancel the scheduled upgrade task. Once a task starts, it cannot be canceled. true: Cancel false: No impact

Status code: 200

Upgrade Cbh Instance Success

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Incorrect request parameters.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Failed to verify the token.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	The current version is the latest. There is no need to upgrade. The agent is not started.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Not CBH instances found.

{
  "server_id" : "c7277d87-5a0d-4cfc-a418-97acb567cf29",
  "upgrade_time" : 1702974655000
}

None

Status Code	Description
200	Upgrade Cbh Instance Success
400	Bad Request
401	Unauthorized
403	The current version is the latest. There is no need to upgrade./The agent is not started.
404	Not Found