DescribeInstanceStatus - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the status of one or more Elastic Compute Service (ECS) instances.

Operation description

For information about the lifecycle states of an ECS instance, see Instance states.
You can also call this operation to query the list of ECS instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instances. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ZoneId	string	No	The zone ID of the instances. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-d
ClusterId	string	No	The cluster ID of the instances.	cls-bp67acfmxazb4p****
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10
InstanceId	array	No	The IDs of the instances. When you use this parameter to specify multiple instance IDs, separate the IDs with commas(,). Example: `InstanceId.1=i-bp1j4i2jdf3owlhe**, InstanceId.2=i-bp1j4i2jdf3o1234**`.
	string	No	The IDs of the instances. When you use this parameter to specify multiple instance IDs, separate the IDs with commas(,). Example: `InstanceId.1=i-bp1j4i2jdf3owlhe**, InstanceId.2=i-bp1j4i2jdf3o1234**`.	i-bp1j4i2jdf3owlhe****

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	1
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of instances.	58
InstanceStatuses	array<object>	The status information of the instances.
InstanceStatus	object
Status	string	The status of the instance. Valid values: Pending: The instance is being created. Running: The instance is running. Starting: The instance is being started. Stopping: The instance is being stopped. Stopped: The instance is stopped.	Running
InstanceId	string	The ID of the instance.	i-bp1j4i2jdf3owlhe****

Examples

Sample success responses

JSONformat

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 58,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "Status": "Running",
        "InstanceId": "i-bp1j4i2jdf3owlhe****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.	-
403	Abs.InvalidInstanceIds.MalFormed	The specified instanceIds is not valid.	-
404	InvalidZoneId.NotFound	The ZoneId provided does not exist in our records.	The specified zone ID does not exist.

For a list of error codes, visit the Service error codes.