Obtaining the Status of a CBH Instance

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

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

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

**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. The value of X-Subject-Token in the response header is the user token. For details, see "Obtaining the Token of an IAM User."

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.

None

Status code: 200

Search Instance Info Success

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

Status Code	Description
200	Search Instance Info Success
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found

Parent topic: Operation Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.