查询一个或多个实例的详细信息。
获取实例列表,返回实例列表按GmtCreate倒序。请求参数的作用类似于一个过滤器,过滤器为逻辑与( AND )关系。如果某个参数为空,则过滤器不起作用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /v2/openapi/instances HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
page | Integer | Query | 否 | 1 |
指定页码,默认为:1 |
size | Integer | Query | 否 | 10 |
指定每页展示条数,默认为10,限制:1-50 |
status | String | Query | 否 | Running |
通过实例状态进行过滤。Running, Ready, Initializing,Starting |
name | String | Query | 否 | 测试实例 |
通过实例名称进行过滤,支持模糊匹配。 |
expiredTime | String | Query | 否 | 1608533404 |
秒级时间戳,通过过期时间过滤,大于当前时间会过滤出即将过期的实例(不包含已经过期的实例) |
instanceId | String | Query | 否 | airec-cn-xxxxxx |
通过实例ID进行过滤,支持模糊匹配。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | InternalServerError |
错误码 |
message | String | An internal server error occurred |
错误详情 |
requestId | String | 8F81A922-6C81-46D6-B78C-CC35E16B1691 |
请求id |
result | Array of Result |
返回参数 |
|
chargeType | String | PrePaid |
付费类型,包含 包年包月( PrePaid)和 按量付费 ( PostPaid ),当前产品只支持包年包月付费类型。 |
commodityCode | String | airecpre |
商品代码。 |
dataSetVersion | String | 20181206170353 |
当前在线服务的数据集版本。 |
expiredTime | String | 2019-01-06T16:00:00.000Z |
实例过期时间,单位为UTC时间。 |
gmtCreate | String | 2018-12-06T06:14:01.000Z |
实例创建时间,单位为UTC时间。 |
gmtModified | String | 2018-12-06T11:17:49.000Z |
实例最后更新时间,单位为UTC时间。 |
industry | String | news |
行业名称,行业名称分为:内容型( content )、商品型( item )、新闻型( news)、视频型( video )、社交型( sns )。 |
instanceId | String | airec-cn-o400whm78004 |
实例ID。 |
lockMode | String | Unlock |
锁定状态,包含 未锁定( Unlock )、手动锁定( ManualLock )、欠费锁定 ( LockByExpiration)。 |
name | String | airec-cn-o400whm78004 |
实例名称。 |
regionId | String | cn-beijing |
实例所在的区域。 |
status | String | Running |
实例状态,初始化中(Initializing)、待数据导入(Ready)、运行中(Running)。 |
type | String | Standard |
实例类型,当前只有 标准版(Standard)。 |
示例
请求示例
GET /openapi/instances?name=test&instanceId=abc&page=1&size=10
正常返回示例
XML
格式
<result>
<instanceId>airec-cn-5i3mq380d9q6</instanceId>
<name>测试使用</name>
<type>Standard</type>
<status>Running</status>
<industry>item</industry>
<regionId>cn-hangzhou</regionId>
<chargeType>PrePaid</chargeType>
<dataSetVersion>20201220105251</dataSetVersion>
<commodityCode>airecpre</commodityCode>
<gmtCreate>2020-12-20T02:51:57.000Z</gmtCreate>
<gmtModified>2020-12-20T03:34:05.000Z</gmtModified>
<expiredTime>2021-01-20T16:00:00.000Z</expiredTime>
<lockMode>Unlock</lockMode>
</result>
<requestId>CD76827D-8D92-4C90-9C31-A01941834442</requestId>
<headers>
<X-Total-Count>1</X-Total-Count>
</headers>
JSON
格式
{
"result": {
"instanceId": "airec-cn-5i3mq380d9q6",
"name": "测试使用",
"type": "Standard",
"status": "Running",
"industry": "item",
"regionId": "cn-hangzhou",
"chargeType": "PrePaid",
"dataSetVersion": 20201220105251,
"commodityCode": "airecpre",
"gmtCreate": "2020-12-20T02:51:57.000Z",
"gmtModified": "2020-12-20T03:34:05.000Z",
"expiredTime": "2021-01-20T16:00:00.000Z",
"lockMode": "Unlock"
},
"requestId": "CD76827D-8D92-4C90-9C31-A01941834442",
"headers": {
"X-Total-Count": 1
}
}
错误码
访问错误中心查看更多错误码。