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

Querying the Instance Status

Function

This API is used to query the instance status.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

clouddc:instance:get

Read

-

-

-

-

URI

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

Request Parameters

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

Response Parameters

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

stateDiagram-v2
    [*] --> pending: CreateInstance
    pending --> running: CreateInstance Succeed
    pending --> shutting_down: DeleteInstance
    running --> stopped: PowerOff/PowerReboot
    stopped --> running: PowerOn/Provision Succeed
    stopped --> stopped: ChangePassword
    pending --> error: CreateInstance Failed
    stopped --> error: Provision Failed
    error --> running: Retry Provision Succeed
    stopped --> shutting_down: DeleteInstance
    error --> shutting_down: Retry DeleteInstance
    shutting_down --> error: DeleteInstance Failed
    shutting_down --> terminated: DeleteInstance Succeed

Default Value

N/A

operation_state

String

Definition

Operation status.

Constraints

N/A

Range

  • install-processing: The OS is being installed.

  • install-succeed: The OS has been installed.

  • install-failed: The OS fails to be installed.

  • reinstall-processing: The OS is being reinstalled.

  • reinstall-succeed: The OS has been reinstalled.

  • reinstall-failed: The OS fails to be reinstalled.

  • switch-install-processing: The OS is being changed.

  • switch-install-succeed: The OS has been changed.

  • switch-install-failed: The OS fails to be changed.

  • modify-ip-processing: The IP address is being changed.

  • modify-ip-succeed: The IP address has been modified.

  • modify-ip-failed: The IP address fails to be changed.

  • uninstall-processing: The OS is being uninstalled.

  • uninstall-succeed: The OS has been uninstalled.

  • uninstall-failed: The OS fails to be uninstalled.

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

  • power_off_error: power-off error

  • power_on_error: power-on error

  • reboot_failed_error: reboot 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.

Example Requests

Querying the instance status

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

Example Responses

Status code: 200

The instance status has been queried.

{
  "state" : "stopped"
}

Status Codes

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.

Error Codes

See Error Codes.