更新时间:2023-11-29 GMT+08:00

查询设备列表

功能介绍

通过调用API查询设备名称、设备id、关联的产品id、客户端id、密码、关于此设备的说明、状态、用户名等信息。

URI

GET /v1/{project_id}/link/instances/{instance_id}/devices

表1 参数说明

参数

类型

是否必填

说明

project_id

string

租户每个区域对应的项目ID。

instance_id

string

租户使用ROMA Connect的实例ID。

请求消息

请求参数

请求示例

https://example.cloud.com/v1/80e2b******f4a398d6409a50932d917/link/instances/fb3b24ab-5d87-473d-9c57-fc6******6a1/devices

响应消息

响应参数

表2 响应参数

名称

类型

描述

total

integer

设备总数。

devices

Array<device>

设备信息。

表3 device

名称

类型

描述

client_id

string

客户端ID。

device_id

integer

设备ID。

device_name

string

设备名称,支持英文大小写,数字,下划线和中划线,不超过64个字符。

password

string

密码。

product_id

integer

产品ID。

product_name

string

产品名。

remark

string

描述信息,不能超过200个字符。

status

integer

设备状态,0或1。

  • 0表示启用设备。
  • 1表示停用设备。

user_name

string

用户名。

响应示例

{ 
    "total": 1,
    "devices": [
    {
        "device_id": 49,
        "device_name": "device8",
        "product_id": 20,
        "product_name": "user_demo",
        "client_id": "D2186efd403682f8",
        "password": "*****************",
        "remark": null,
        "status": 0,
        "user_name": "d0784baedafe4d5c8e5c951744ac11dd"
    }
    ]
}