ListInstance - 查询实例列表
查询一个或多个实例的详细信息。
接口说明
获取实例列表,返回实例列表按 GmtCreate 倒序。请求参数的作用类似于一个过滤器,过滤器为逻辑与( AND )关系。如果某个参数为空,则过滤器不起作用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /v2/openapi/instances HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| page |
integer |
否 |
指定页码,默认为:1。 |
1 |
| size |
integer |
否 |
指定每页展示条数,默认为 10,限制:[1-50]。 |
10 |
| status |
string |
否 |
通过实例运行状态进行过滤。 取值:
|
Running |
| name |
string |
否 |
通过实例名称进行过滤,支持模糊匹配。 |
实例1 |
| expiredTime |
string |
否 |
秒级时间戳,通过过期时间过滤,大于当前时间会过滤出即将过期的实例(不包含已经过期的实例)。 |
1608533404 |
| instanceId |
string |
否 |
通过实例 ID 进行过滤,支持模糊匹配。 |
airec-cn-**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| result |
array<object> |
返回参数。 |
|
|
object |
返回参数。 |
||
| regionId |
string |
实例所在的区域。 |
cn-beijing |
| type |
string |
实例类型。 取值:
|
Standard |
| lockMode |
string |
实例锁定状态。 取值:
|
Unlock |
| expiredTime |
string |
实例过期时间,单位为 UTC 时间。 |
2019-01-06T16:00:00.000Z |
| status |
string |
实例运行状态。 取值:
|
Running |
| gmtCreate |
string |
实例创建时间,单位为 UTC 时间。 |
2018-12-06T06:14:01.000Z |
| chargeType |
string |
实例付费类型。 取值:
|
PrePaid |
| industry |
string |
实例行业类型。 取值:
|
news |
| commodityCode |
string |
Airec 商品代码。 |
airecpre |
| gmtModified |
string |
实例最后更新时间,单位为 UTC 时间。 |
2018-12-06T11:17:49.000Z |
| dataSetVersion |
string |
当前在线服务的数据集版本。 |
20181206170353 |
| name |
string |
实例名称。 |
实例1 |
| instanceId |
string |
实例 ID。 |
airec-cn-**** |
| code |
string |
错误码。 |
InternalServerError |
| requestId |
string |
请求 ID。 |
8F81A922-6C81-46D6-B78C-CC35E16B1691 |
| message |
string |
错误信息。 |
An internal server error occurred |
示例
正常返回示例
JSON格式
{
"result": [
{
"regionId": "cn-beijing",
"type": "Standard",
"lockMode": "Unlock",
"expiredTime": "2019-01-06T16:00:00.000Z",
"status": "Running",
"gmtCreate": "2018-12-06T06:14:01.000Z",
"chargeType": "PrePaid",
"industry": "news",
"commodityCode": "airecpre",
"gmtModified": "2018-12-06T11:17:49.000Z",
"dataSetVersion": "20181206170353",
"name": "实例1",
"instanceId": "airec-cn-****"
}
],
"code": "InternalServerError",
"requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
"message": "An internal server error occurred"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。