管理中心
我的
API参考华为全屋智能北向开放接口说明书应用API设备管理和控制接口查询指定设备信息

查询指定设备信息

  1. 描述:调用此接口查询指定设备信息。一次查询最多支持查询20个设备信息。
  2. 接口类型:REST
  3. URI:

    请求方法

    GET

    URI

    /openapi/asset/v1/devices?deviceId=xx&deviceId=xx

    传输协议

    HTTPS

  4. 请求参数:

    序号

    参数

    是否必须

    类型

    长度

    描述

    1

    deviceId

    必选

    String

    1-24

    设备ID

  5. 响应参数:

    序号

    参数

    是否必须

    类型

    长度

    描述

    1

    devices

    可选

    Object

    0-500

    设备集合

    2

    deviceId

    必选

    String

      

    设备ID

    3

    status

    必选

    String

    8

    设备状态

    枚举:

    online/offline

    4

    spaceId

    必选

    String

    1-24

    空间ID

    5

    gatewayDeviceId

    必选

    String

    1-36

    中枢/主机的设备ID,针对下挂设备;假如就是中枢/主机值等于deviceId。

    6

    devInfo

    必选

    Object

      

    设备基本信息

    7

    model

    必选

    String

      

    设备型号

    8

    devType

    必选

    String

      

    设备类型ID

    9

    deviceName

    可选

    String

      

    设备名称

    10

    manu

    必选

    String

      

    制造商ID

    11

    prodId

    必选

    String

      

    产品ID

    12

    hiv

    必选

    String

      

    sdk版本

    13

    swv

    可选

    String

      

    software version.软件版本

    14

    fwv

    可选

    String

      

    固件版本

    15

    hwv

    可选

    String

      

    硬件版本

    16

    protType

    可选

    Integer

      

    协议类型:

    1: WiFi

    2: Z-Wave

    3: ZigBee

    4: BLE

    17

    services

    必选

    Object

    0-100

    服务集

    18

    serviceType

    必选

    String

      

    服务类型

    19

    serviceId

    必选

    String

      

    服务ID

    20

    characteristics

    必选

    Object

    0-100

    特性集

    21

    timestamp

    可选

    String

      

    时间戳

    UTC时间。Device可选,Gateway上报时必选添加此字段。时间格式:yyyymmddThhmmssSSSZ,如:20151212T121212001Z

    22

    characteristicName

    必选

    String

      

    特性名

    23

    characteristicValue

    必选

    Object

      

    特性值

  6. 请求示例:
    收起
    自动换行
    深色代码主题
    复制
    1. GET https://{Endpoint}/openapi/asset/v1/devices?deviceId=xxx
  7. 响应示例:

    Status Code: 200 OK

    收起
    自动换行
    深色代码主题
    复制
    1. {
    2. "devices": [
    3. {
    4. "deviceId": "xxx",
    5. "status": "offline",
    6. "spaceId": "",
    7. "gatewayDeviceId": "",
    8. "devInfo": {
    9. "model": "",
    10. "devType": "",
    11. "deviceName": "",
    12. "manu": "",
    13. "prodId": "",
    14. "hiv": "",
    15. "swv": "",
    16. " protType ": 0
    17. },
    18. "services": [
    19. {
    20. "serviceType": "string",
    21. "serviceId": "string",
    22. "characteristics": [
    23. {
    24. "timestamp": "string",
    25. "characteristicName": "string",
    26. "characteristicValue": "xxx"
    27. }
    28. ]
    29. }
    30. ]
    31. }
    32. ]
    33. }
  8. 错误码

HTTP状态码

错误码

英文错误描述

中文错误描述

处理建议

400

space.001000

Bad Request.

请求的格式不正确,如json非法,mediaType不正确等。

请排查该请求的请求格式是否正确。

space.001001

Space name invalid.

空间命名不合法

请修改空间命名

space.001002

Space name repeat in a project.

同一个项目下,不允许重复命名

请修改空间命名

space.001003

Space

count exceeds.

空间数量超过限额

不允许超过1000个

401

common.000001

Unauthorized.

非法请求

请检查AK/SK算法是否正确。

403

common.000002

Forbidden.

没有权限

请检查是否被授权

404

common.000003

Not Found.

资源不存在

请排查请求参数是否有误

500

common.000004

Internal server error.

内部错误

请稍等重试

503

Common.000005

Limit access.

限制访问

请联系华为工程师分析解决。

590