Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Operation Management/ Stopping a CBH Instance
Updated on 2025-07-07 GMT+08:00
View PDF
Share

Stopping a CBH Instance

Function

This API is used to stop a CBH instance.

URI

POST /v2/{project_id}/cbs/instance/stop

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

Instance ID.

Response Parameters

Status code: 200

Stop Cbh Instance Success

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Incorrect request parameters.

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

Not CBH instances found.

Example Requests

{
  "server_id" : "c7277d87-5a0d-4cfc-a418-97acb567cf29"
}

Example Responses

None

Status Codes

Status Code

Description

200

Stop Cbh Instance Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Operation Management