文档首页/ 设备接入 IoTDA/ API参考/ 应用侧API参考/ API/ 实例管理/ 查询实例列表
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

查询实例列表

功能介绍

用户可以调用此接口查询设备接入实例列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v5/iot/{project_id}/iotda-instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数说明：项目ID。获取方法请参见 获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数说明：表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。 - 限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 取值范围：0-500的整数，默认为0。

limit

否

Integer

参数说明：分页查询时每页显示的记录数。

取值范围：1-500的整数，默认为500。

marker

否

String

上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。

name

否

String

参数说明：设备接入实例名称，匹配规则为模糊匹配。

取值范围：由中文字符，英文字母、数字及“_”、“-”组成，且长度为[1-64]个字符。

instance_type

否

String

参数说明：实例类型。

取值范围：

  • standard：标准版实例

  • enterprise：企业版实例

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数说明：设备接入实例的总数。

marker

String

参数说明：本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。

instances

Array of QueryInstanceSimplify objects

参数说明：设备接入实例的详情列表。
表5 QueryInstanceSimplify

参数

参数类型

描述

instance_type

String

参数说明：实例类型。

取值范围：

  • standard：标准版实例

  • enterprise：企业版实例

instance_id

String

参数说明：实例ID。

取值范围：长度不超过36，由小写字母[a-f]、数字、连接符（-）的组成。

name

String

参数说明：实例名称

取值范围：由中文字符，英文字母、数字及“_”、“-”组成，且长度为[1-64]个字符。

charge_mode

String

参数说明：实例的付费方式。

取值范围：

  • prePaid：包年/包月

  • postPaid：按需计费

flavor

Flavor object

参数说明：设备接入实例的规格参数。

status

String

参数说明：实例状态。

取值范围：

  • CREATING：实例正在创建

  • ACTIVE：实例正常

  • FROZEN：实例冻结

  • TRADING: 实例正在进行交易

  • MODIFYING：实例正在变更规格

  • FAILED：实例创建失败

create_time

String

参数说明：实例的创建时间。时间格式例如：2023-01-28T06:57:52Z。

update_time

String

参数说明：实例的最近一次更新的时间。时间格式例如：2023-01-28T06:57:52Z。

enterprise_project_id

String

参数说明：企业项目Id。
表6 Flavor

参数

参数类型

描述

type

String

参数说明：待创建设备接入实例的规格名称。详情请参见产品规格说明中的规格编码。

size

Integer

参数说明：待创建设备接入标准版实例的单元数量。详情请参见产品规格说明。当instance_type是standard时，该参数必填。

请求示例

列表查询所有实例。

GET https://{endpoint}/v5/iot/{project_id}/iotda-instances

响应示例

状态码： 200

OK

{
  "count" : 1,
  "marker" : 1805431584415871305,
  "instances" : [ {
    "instance_type" : "standard",
    "instance_id" : "8561675c-d8a3-4956-9884-9cf9cbdd3134",
    "name" : "iotda_instance",
    "flavor" : {
      "type" : "iotda.standard.s1",
      "size" : 1
    },
    "status" : "ACTIVE",
    "create_time" : "2023-01-28T06:57:52Z",
    "update_time" : "2023-01-28T06:57:52Z",
    "enterprise_project_id" : "d22e47e9-cfad-4254-8a29-d2a56a07681d"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 实例管理