接口说明
查询实例状态信息列表，仅返回实例ID和资源状态信息。
请求示例
- 根据某个可用区查询实例以及状态信息，入参示例：
"zoneId": "cn-jiangsu-1a"
- 根据实例ID查询实例对应状态信息，入参示例：
"instanceIds":["94fec171-5423-46ae-a0eb-5ad07269b3e4"]
URL
GET https://ecloud.10086.cn/api/openapi-instance/v4/list/describe-instance-status
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
instanceIds
|
<string> array(multi)
|
否
|
实例ID数组,可通过查询实例状态列表接口获取。 |
|
zoneId
|
string
|
否
|
可用区，可通过查询属地地域可用区信息接口获取。 |
|
page
|
integer(int32)
|
否
|
列表分页页数，起始页为1。 |
|
pageSize
|
integer(int32)
|
否
|
列表分页每页大小，最大值为100，默认值为10。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-instance/v4/list/describe-instance-status返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«InstanceStatus»
|
请求成功时返回的数据。 |
|
content
|
<InstanceStatus> array
|
分页查询返回的具体结构体。 |
|
status
|
string
|
实例状态。取值范围： - active：运行中。 - shutoff：已关机。 - creating：创建中。 - operateError：操作失败。 - frozen：业务暂停中。 |
|
instanceId
|
string
|
实例ID。 |
|
total
|
integer
|
满足查询条件的总个数。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
返回码：200
OK
{
"requestId":"reqId-a5148d38d0ed8453d3f77-29455c7f-5",
"state":"OK",
"body":{
"total":2,
"content":[
{
"status":"active",
"instanceId":"bf5037f5-c7c9-4701-b2b9-b40537327ef6"
},
{
"status":"active",
"instanceId":"32396a06-e04d-49f5-9037-02f8885ac3a8"
}
]
}
}