Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Operation Management/ Changing the Type of a Single-Node CBH Instance
Updated on 2024-11-12 GMT+08:00

Changing the Type of a Single-Node CBH Instance

Function

This API is used to change the type of a single-node CBH instance.

URI

PUT /v2/{project_id}/cbs/instance/type

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

server_id

Yes

String

Instance ID.

availability_zone

No

String

AZ name.

For details, see "Obtaining AZs Where CBH Is Available."

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 charged to your Huawei Cloud account.) If the automatic payment fails, an unpaid order will be generated, and you need to manually complete the payment. (During the manual payment, you can still modify the discounts and coupons that were automatically selected.)

  • 0: No. (You need to manually pay for the bill. Discounts and coupons can be used.)

The default value is 0.

Request Parameters

Table 3 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."

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

None

Example Responses

Status code: 200

Change Single-Node Instance type to HA success

{
  "order_id" : "CS22xxx82xx5AssGxxx"
}

Status Codes

Status Code

Description

200

Change Single-Node Instance type to HA success

400

Bad Request

401

Unauthorized

403

Access denied.

404

Not Found

Error Codes

See Error Codes.