Help Center> Cloud Bastion Host> API Reference> API Description> Managing CBH Instances> Upgrading a CBH Instance
Updated on 2023-05-24 GMT+08:00
View PDF

Upgrading a CBH Instance

Function

This API is used to upgrade a CBH instance.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. You can obtain the project ID by referring to https://support.huaweicloud.com/intl/en-us/api-cbh/cbh_02_0020.html.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

CBH instance ID, in the UUID format.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

Integer

Operation results

description

String

Description.

task_id

String

Task ID.

order_id

String

Order ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_description

String

Incorrect request parameter.

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

Permissions required.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_description

String

CBH instances not found.

Example Requests

{
  "instance_id" : "6e22aced-2fdb-42e9-9175-4796fbe9fc23"
}

Example Responses

Status code: 200

request info:"success"

{
  "code" : 1,
  "description" : "You are using the latest version, no need to upgrade. The agent is not started."
}

Status Codes

Status Code

Description

200

request info:"success"

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Managing CBH Instances