Obtaining the Status of a CBH Instance_Operation Management_API Description_API Reference

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

For details, see Calling APIs.

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

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

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
name	String	CBH instance name.
status	String	Bastion host instance status. POWERING_ON: starting POWERING_OFF: stopping DELETE_WAIT: waiting for deletion REBOOTING: restarting RESIZE: resizing UPGRADING: upgrading FROZEN: frozen ACTIVE: 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	Token verification failed.

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

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

Obtaining the Status of a CBH Instance