Updated on 2023-05-16 GMT+08:00

Restarting a CBH Instance

Function

This API is used to restart a CBH instance.

URI

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

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.

reboot

Yes

RebootType object

CBH instance restart method.

Table 3 RebootType

Parameter

Mandatory

Type

Description

type

Yes

String

The value is case-insensitive.

-SOFT: General restart. Services on VMs are closed.

-HARD: Forcible restart. VMs are restarted.

Response Parameters

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" : "c7277d87-5a0d-4cfc-a418-97acb567cf29",
  "reboot" : {
    "type" : "SOFT"
  }
}

Example Responses

None

Status Codes

Status Code

Description

200

request info:"success"

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.