文档首页/ 应用与数据集成平台 ROMA Connect/ API参考（阿布扎比区域）/ 设备集成API/ 设备管理/ 查询子设备
更新时间：2022-12-05 GMT+08:00
查看PDF
分享

查询子设备

功能介绍

查询子设备

URI

GET /v2/{project_id}/link/instances/{instance_id}/devices/{device_id}/subsets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度：0

最大长度：32

instance_id

是

String

实例ID

最小长度：0

最大长度：36

device_id

是

Integer

设备ID

最小值：0

最大值：99999999999999999
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页显示条目数量，最大数量999，超过999后只返回999

最小值：0

最大值：999999

缺省值：10

device_name

否

String

设备名称

最小长度：2

最大长度：32

status

否

Integer

设备状态 0-启动 1-停用

最小值：0

最大值：10

online_status

否

Integer

设备状态 0-未连接 1-在线 2-离线

最小值：0

最大值：10

offset

否

Integer

偏移量，表示从此偏移量开始查询， offset大于等于0

最小值：0

最大值：999999

缺省值：0

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

总数

最小值：1

最大值：99999

size

Integer

本次返回数量

最小值：1

最大值：1000

items

Array of Device objects

设备ID列表
表4 Device

参数

参数类型

描述

permissions

Array of strings

权限

id

Integer

设备ID

最小值：1

最大值：99999999999999999

parent_device_id

Integer

父设备ID

最小值：1

最大值：99999999999999999

parent_device_name

String

父设备名称

最小长度：2

最大长度：64

product

ProductReferer object

产品

device_name

String

设备名称，支持中文、中文标点符号（）。；，：“”、？《》及英文大小写、数字及英文符号()_,#.?'-@%&!, 长度2-64

最小长度：2

最大长度：64

instance_id

String

实例id

最小长度：2

最大长度：64

client_id

String

设备客户端ID，平台生成的设备唯一标识

最小长度：0

最大长度：32

node_id

String

设备物理编号，通常使用MAC或者IMEI号，支持英文大小写，数字，下划线和中划线，长度2-64

最小长度：2

最大长度：64

app_name

String

应用名称

最小长度：0

最大长度：256

status

Integer

设备状态 0-启用 1-禁用

最小值：0

最大值：10

online_status

Integer

是否在线 0-未连接 1-在线 2-离线

最小值：0

最大值：10

description

String

备注

最小长度：0

最大长度：200

authentication

Authentication object

鉴权

created_user

CreatedUser object

创建时的用户

last_updated_user

LastUpdatedUser object

最后更新时的用户

tags

Array of strings

标签

created_datetime

Long

创建时间，timestamp(ms)，使用UTC时区

最小值：1

最大值：99999999999999999

last_updated_datetime

Long

最后修改时间，timestamp(ms)，使用UTC时区

最小值：1

最大值：99999999999999999

connect_address

String

设备接入地址

最小长度：0

最大长度：200

ssl_connect_address

String

设备接入SSL地址

最小长度：0

最大长度：200

ipv6_connect_address

String

设备接入IPV6地址

最小长度：0

最大长度：200

ipv6_ssl_connect_address

String

设备接入IPV6 SSL地址

最小长度：0

最大长度：200

last_login_datetime

Long

最后登录时间

最小值：1

最大值：99999999999999999

node_type

Integer

节点类型 0-直连 1-网关 2-子设备

最小值：1

最大值：99999999999999999

device_type

Integer

设备类型0-普通设备（无子设备也无父设备）1-网关设备(可挂载子设备)2-子设备(归属于某个网关设备)

最小值：0

最大值：10

client_ip

String

客户端ip

最小长度：0

最大长度：64

keep_alive

String

心跳时间

最小长度：0

最大长度：200

last_active_time

Long

最后登录时间

最小值：1

最大值：99999999999999999

version

String

设备版本

最小长度：0

最大长度：64

plugin_id

Integer

modbus和opcua设备特有,表示设备所属产品的类型 0-普通产品 1-modbus网关产品 2-opcua网关产品

最小值：1

最大值：99999999999999999

app_id

String

应用ID

最小长度：0

最大长度：36
表5 ProductReferer

参数

参数类型

描述

product_id

Integer

产品ID，未填写厂商ID+型号时产品ID必填

最小值：1

最大值：99999999999999999

product_name

String

产品名称

最小长度：0

最大长度：64

manufacturer_id

String

厂商ID，未填写产品ID时厂商ID和型号必填

最小长度：0

最大长度：64

model

String

型号，未填写产品ID时厂商ID和型号必填

最小长度：0

最大长度：64

protocol_type

Integer

产品的协议类型：0-mqtt，2-modbus，4-opcua

最小值：0

最大值：10

product_type

Integer

产品类型：0-普通产品 1-网关产品

最小值：0

最大值：10
表6 Authentication

参数

参数类型

描述

user_name

String

一型一密/一机一密的用户名

最小长度：0

最大长度：64

password

String

一型一密/一机一密的密码，输入要求：至少1个数字，1个大写字母，1个小写字母，1个特殊字符(~!@#$%^&*()-_=+|[{}];:<>/?)，长度8-32个字符

最小长度：0

最大长度：64
表7 CreatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度：0

最大长度：64

user_name

String

用户名

最小长度：0

最大长度：64
表8 LastUpdatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度：0

最大长度：64

user_name

String

用户名

最小长度：0

最大长度：64

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码

最小长度：0

最大长度：64

error_msg

String

错误描述

最小长度：0

最大长度：200

request_id

String

消息ID

最小长度：0

最大长度：64

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码

最小长度：0

最大长度：64

error_msg

String

错误描述

最小长度：0

最大长度：200

request_id

String

消息ID

最小长度：0

最大长度：64

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码，针对4xx和5xx类HTTP错误码的详细错误码

最小长度：0

最大长度：64

error_msg

String

错误描述

最小长度：0

最大长度：200

request_id

String

消息ID

最小长度：0

最大长度：64

请求示例

GET /{project_id}/link/instances/{instance_id}/devices/{device_id}/subsets

响应示例

状态码： 200

OK

{
  "total" : 1,
  "size" : 1,
  "connect_address" : "xx.xxx.xxx.xxx",
  "ssl_connect_address" : "xx.xxx.xxx.xxx",
  "ipv6_connect_address" : "xx.xxx.xxx.xxx",
  "ipv6_ssl_connect_address" : "xx.xxx.xxx.xxx",
  "items" : [ {
    "permissions" : [ "read", "access", "delete", "modify" ],
    "id" : 711537,
    "parent_device_id" : 711536,
    "parent_device_name" : "parent-device",
    "product" : {
      "product_id" : 116303,
      "product_name" : "p1",
      "manufacturer_id" : "p1",
      "model" : "p1",
      "product_type" : 0,
      "protocol_type" : 0
    },
    "device_name" : "device",
    "instance_id" : "8993a690-cf61-46af-880d-587d823d14e5",
    "client_id" : "D116303711537sGDtK",
    "node_id" : "string",
    "app_name" : "app",
    "status" : 0,
    "online_status" : 2,
    "description" : "device",
    "authentication" : {
      "user_name" : "F01A8D25FE6E4CF5A286B711B31888AE",
      "password" : "************************"
    },
    "created_user" : {
      "user_id" : null,
      "user_name" : "user"
    },
    "last_updated_user" : {
      "user_id" : null,
      "user_name" : "user"
    },
    "tags" : [ ],
    "created_datetime" : 1607408244841,
    "last_updated_datetime" : 1607422571094,
    "connect_address" : "xx.xx.xx.xx",
    "ssl_connect_address" : "xx.xx.xx.xx",
    "ipv6_connect_address" : "xx.xx.xx.xx",
    "ipv6_ssl_connect_address" : "xx.xx.xx.xx",
    "last_login_datetime" : null,
    "node_type" : 0,
    "device_type" : 0,
    "client_ip" : "xx.xx.xx.xx",
    "keep_alive" : 60,
    "last_active_time" : 1608082247010,
    "version" : 4,
    "plugin_id" : 2,
    "app_id" : "cb4b3ec0-8f7f-432f-b05e-fc149d05da5d"
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-device.batchQuerySubDevices]. Parameter is [deviceOid]. Processor is [path].",
  "requestId" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码： 404

Not Found

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Not Found"
}

状态码： 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 设备管理