Upgrading a CBH Instance_Operation Management_API Description_API Reference

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	Definition Project ID, which uniquely identifies a project. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details, see Obtaining a User Token. Constraints N/A Range String type. The value can contain 1 to 28,000 characters. Default Value N/A

**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

None

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	Token verification failed.

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-xxxxxxxx-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

Upgrading a CBH Instance