Help Center/ Cloud Data Center / API Reference/ API/ iMetal Instance Management/ Querying Instance Status
Updated on 2025-07-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Instance Status

Function

This API is used to query the instance status.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID.

Constraints

N/A

Range

The project ID of the account

Default Value

N/A

id

Yes

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameter

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

state

String

Definition

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).

  • stopping: The instance is being stopped (transiting to the stopped or hibernated state).

  • stopped: The instance is completely stopped (storage volumes are retained).

  • reinstalling: The OS is being reinstalled.

  • shutting-down: The instance is being terminated (being deleted).

  • terminated: The instance has been terminated (all resources are deleted and cannot be restored).

  • failed: The instance is in the failed state. You can only try to reinstall the OS. Other operations are not supported and related resources are cleared.

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.

Constraints

N/A

Range

N/A

Default Value

N/A

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

Default Value

N/A

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 exception

Default Value

N/A

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Default Value

N/A

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 429

Table 6 Response body parameter

Parameter

Type

Description

-

String

-

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Default Value

N/A

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

Request for querying instance status

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

Example Responses

Status code: 200

Instance status returned.

{
  "status" : "stopped"
}

Status Codes

Status Code

Description

200

Instance status returned.

401

The request is not authenticated.

429

The request is overloaded.

500

Internal server error.

Error Codes

For details, see Error Codes.