Changing a CBH Instance_Operation Management_API Description_API Reference

Function

This API is used to change a CBH instance.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/cbs/instance

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

Request Parameters

**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	CBH instance ID, in UUID format.
new_resource_spec_code	No	String	ID of the specification of the CBH instance to be changed. cbh.basic.50 cbh.enhance.50 For details, see Querying CBH Instance Specifications.
attach_disk_size	No	Integer	Additional disk size. Unit: TB. 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 cloud account. 1: Yes. (Discounts and coupons are automatically selected. The fee will be automatically deducted from your 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.
job_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	Token verification failed.

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

Example request for changing a bastion host instance

{
  "server_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "new_resource_spec_code" : "cbh.basic.50",
  "attach_disk_size" : 1,
  "is_auto_pay" : 1
}

Example Responses

Status code: 200

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

Changing a CBH Instance