文档

ListInstance - 查询实例列表

更新时间:

查询一个或多个实例的详细信息。

接口说明

获取实例列表,返回实例列表按 GmtCreate 倒序。请求参数的作用类似于一个过滤器,过滤器为逻辑与( AND )关系。如果某个参数为空,则过滤器不起作用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /v2/openapi/instances

请求参数

名称类型必填描述示例值
pageinteger

指定页码,默认为:1。

1
sizeinteger

指定每页展示条数,默认为 10,限制:[1-50]。

10
statusstring

通过实例运行状态进行过滤。

取值:

  • Initializing:初始化中。

  • Ready:待数据导入。

  • Running:运行中。

Running
namestring

通过实例名称进行过滤,支持模糊匹配。

实例1
expiredTimestring

秒级时间戳,通过过期时间过滤,大于当前时间会过滤出即将过期的实例(不包含已经过期的实例)。

1608533404
instanceIdstring

通过实例 ID 进行过滤,支持模糊匹配。

airec-cn-****

返回参数

名称类型描述示例值
object

返回参数。

resultobject []

返回参数。

regionIdstring

实例所在的区域。

cn-beijing
typestring

实例类型。

取值:

  • Algorithm_configuration:算法配置版。

  • Industry_operation:行业运营版。

  • Cold_start:冷启动版。

Standard
lockModestring

实例锁定状态。

取值:

  • Unlock:未锁定。

  • ManualLock:手动锁定。

  • LockByExpiration:欠费锁定。

Unlock
expiredTimestring

实例过期时间,单位为 UTC 时间。

2019-01-06T16:00:00.000Z
statusstring

实例运行状态。

取值:

  • Initializing:初始化中。

  • Ready:待数据导入。

  • Running:运行中。

Running
gmtCreatestring

实例创建时间,单位为 UTC 时间。

2018-12-06T06:14:01.000Z
chargeTypestring

实例付费类型。

取值:

  • PREPAY:预付费(包年包月)。

  • POSTPAY:后付费(按量付费)。

PrePaid
industrystring

实例行业类型。

取值:

  • content:内容型。

  • item:商品型。

  • news:新闻型。

news
commodityCodestring

Airec 商品代码。

airecpre
gmtModifiedstring

实例最后更新时间,单位为 UTC 时间。

2018-12-06T11:17:49.000Z
dataSetVersionstring

当前在线服务的数据集版本。

20181206170353
namestring

实例名称。

实例1
instanceIdstring

实例 ID。

airec-cn-****
codestring

错误码。

InternalServerError
requestIdstring

请求 ID。

8F81A922-6C81-46D6-B78C-CC35E16B1691
messagestring

错误信息。

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"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)