Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Operation Management/ Obtaining the Status of a CBH Instance
Updated on 2025-12-01 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Status of a CBH Instance

Function

This API is used to obtain the instance of CBH instances that have not been deleted.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/cbs/instance/{server_id}/status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

To obtain the value, see Obtaining a Project ID.

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

For details, see Obtaining a User Token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

name

String

CBH instance name.

status

String

CBH instance status.

  • POWERING_ON: The instance is being started.

  • POWERING_OFF: The instance is being shut down.

  • DELETE_WAITE: This instance is waiting to be deleted.

  • REBOOTING: The instance is being restarting.

  • RESIZE: The instance is being changed.

  • UPGRADING: The instance is being upgraded.

  • FROZEN: The instance is frozen.

  • ACTIVE: The instance is running.

server_id

String

CBH instance ID, in UUID format.

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

None

Example Responses

Status code: 200

Search Instance Info Success

{
  "name" : "cbh-test",
  "status" : "POWERING_ON",
  "server_id" : "e113077b-xxxx-xxxx-xxxx-be60289cd258"
}

Status Codes

Status Code

Description

200

Search Instance Info Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Operation Management