Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Operation Management/ Changing a CBH Instance
Updated on 2024-06-13 GMT+08:00
View PDF
Share

Changing a CBH Instance

Function

This API is used to change a CBH instance.

URI

PUT /v2/{project_id}/cbs/instance

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

For details about how to obtain the project ID, see "Obtaining a Project ID".

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained 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 the Token of an IAM User."
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

server_id

Yes

String

CBH instance ID, in UUID format.

For details about how to obtain the value, see " Viewing CBH Instance Details" in Cloud Bastion Host User Guide.

new_resource_spec_code

No

String

ID of the specifications of the CBH instance to be changed, for example:

  • cbh.basic.50

  • cbh.enhance.50

For details, see "Querying CBH Instance Specifications."

attach_disk_size

No

Integer

Additional disk size. Unit: TB

NOTE:

Note: The size of the additional disk and the built-in disk cannot exceed 300 TB.

is_auto_pay

No

Integer

Whether an order is automatically paid from your Huawei Cloud account.

  • 1: Yes. (Discounts and coupons are automatically selected. The fee will be automatically deducted from your Huawei Cloud account.) If the automatic payment fails, an unpaid order will be generated, and you need to manually complete the payment. (During manual payment, you can still modify the discounts and coupons that were automatically selected.)

  • 0: No. (The customer needs to manually pay for the bill. Discounts and coupons can be used.)

The default value is 0.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

order_id

String

Order ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Incorrect request parameters.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Failed to verify the token.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Permissions required.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Not CBH instances found.

Example Requests

{
  "server_id" : "xxxxxx",
  "new_resource_spec_code" : "cbh.basic.10",
  "attach_disk_size" : 1,
  "is_auto_pay" : 1
}

Example Responses

Status code: 200

Create Alter Task Success

{
  "order_id" : "CS22xxx82xx5AssGxxx"
}

Status Codes

Status Code

Description

200

Create Alter Task Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Operation Management