DescribeInstanceStatus

Description

call DescribeInstanceStatus to obtain the status information of multiple ECS instances.

Request Method

POST

Request Path

/apsara/route/Ecs/DescribeInstanceStatus

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
ZoneId	BODY	string	No	cn-qingdao-env17-amtest11001-a	the zone to which the instance belongs.
PageSize	BODY	integer	No	10	the number of rows per page set during paging query. Value range: 1~50 default value: 10.
ClusterId	BODY	string	No	cls-bp67acfmxazb4p****	the cluster ID to which the instance belongs.
PageNumber	BODY	integer	No	1	page number of instance status list. starting value: 1. default value: 1.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
RegionId	BODY	string	Yes	cn-qingdao-env17-d01	the region ID to which the instance belongs. You can call the DescribeRegions to view the latest Alibaba Cloud region list.
version	BODY	string	No	2016-01-01	version of api
InstanceId.N	BODY	repeatlist	No	i-bp1j4i2jdf3owlhe****	one or more ECS instance IDs. The value range of N is 1~100. Multiple values are in the form of duplicate lists.

Return data

Name	Type	Sample value	Description
Status	string	Running	instance status.
TotalCount	integer	58	the total number of instances.
PageSize	integer	1	the number of rows per page set when entering.
RequestId	string	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	request ID.
InstanceId	string	i-bp1j4i2jdf3owlhe****	instance ID.
PageNumber	integer	1	page number of instance list.
InstanceStatus		No sample value for this parameter.	No description for this parameter.
InstanceStatuses	array of instancestatus	No sample value for this parameter.	instance status set type (InstanceStatus).

Example

Successful Response example

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

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}