Querying the Instance Status

This API is used to query the instance status.

For details, see Calling APIs.

GET /v1/{project_id}/instances/{id}/status

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. Constraints N/A Range Project ID of the account. Default Value N/A
id	Yes	String	Definition Instance ID, which is returned in the response to the CreateInstance request. Constraints N/A Range N/A Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token. Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
state	String	Definition The instance status. Constraints N/A Range pending: The instance is being started (resources are being allocated or the OS is being started). running: The instance is running properly (can be connected through SSH or RDP). stopped: The instance is completely stopped (storage volumes are retained). shutting-down: The instance is being terminated (being deleted). terminated: The instance has been terminated (all resources are deleted and cannot be restored). error: The instance is abnormal (resources are not completely deleted). Default Value N/A
error	ErrorStatus object	Definition Error object returned upon a failure. Constraints N/A

**Table 4** ErrorStatus
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.
error_type	String	Definition Error type. Constraints N/A Range create_instance_error: Instance creation error delete_instance_error: Instance deletion error reinstall_error: OS reinstallation error modify_ip_error: IP address change error verify_server_error: Server verification error delete_server_error: Server deletion error Default Value N/A

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Status code: 429

**Table 6** Response body parameters
Parameter	Type	Description
-	String

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Querying the instance status

GET https://{endpoint}/v1/{project_id}/instances/{id}/status

Status code: 200

The instance status has been queried.

{
  "state" : "stopped"
}

Status Code	Description
200	The instance status has been queried.
401	The request is not authenticated.
429	The request is overloaded.
500	Internal server error.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.