Get Device


获取设备信息。

请求格式

GET https://{apigw-address}/connect-service/v2.1/devices?action=get

请求参数（URI）

注解

以下非必须字段中，必须提供 assetId 或 productKey + deviceKey 的组合，用于指定设备。

名称 位置（Path/Query） 必需/可选 数据类型 描述
orgId Query 必需 String 资产所属的组织 ID。如何获取 orgId 信息>>
assetId Query 可选（见上述注解） String 资产 ID。如何获取 assetId 信息>>
productKey Query 可选（见上述注解） String 设备的 product key，需与 deviceKey 一起使用。
deviceKey Query 可选（见上述注解） String 设备的 device key，需与 productKey 一起使用。

响应参数

名称 数据类型 描述
data Device 结构体 网关设备信息，其结构参见 Device 结构体。

Device 结构体

名称 数据类型 描述
orgId String 资产所属的组织 ID。
assetId String 资产 ID。
modelId String 资产所属模型 ID。
modelIdPath String 模型 ID 的路径。
productKey String Product Key。
productName StringI18n 产品名称。
productType String 产品类型。
dataFormat String 数据格式。Custom 表示支持用户自定义数据格式，Json 表示只支持 EnOS 设备协议格式。
deviceKey String Device Key。
deviceName StringI18n 设备名称。
deviceSecret String 设备的连接秘钥。
deviceDesc String 设备描述。
timezone String 设备所在时区。
deviceAttributes Map（Key 为 String，Value 为 String） 设备的属性。
deviceTags Map（Key 为 String，Value 为 String） 设备的标志。
mirrorSource String 镜像源设备的 device key。
createTime Long 设备的创建时间。
status String

设备的状态（online、offline、inactive、disable 或 mirror）。

注：EnOS Edge 仅支持 online 或 offline。
activeTime Long 设备的激活时间。
lastOnlineTime Long 设备最后一次上线时间。
lastOfflineTime Long 设备最后一次离线时间。
measurepointLastUpdate Long 设备测点最近一次更新的时间。
eventLastUpdate Long 设备事件最近一次更新的时间。
attributeLastUpdate Long 设备属性最近一次更新的时间。
featureLastUpdate Long 设备最近一次更新的时间，以上述三个时间（ measurepointLastUpdate 、 eventLastUpdate 、 attributeLastUpdate ）里最近的时间为准。
firmwareVersion String 固件版本号。

错误码

代码 错误信息 描述
11404 Device cannot be found 用于指定设备的 assetId、productKey 或 deviceKey 不存在。

示例

请求示例

url: https://{apigw-address}/connect-service/v2.1/devices?action=get&orgId=yourOrgId&assetId=yourAssetId
method: GET

返回示例

{
        "code": 0,
        "msg": "OK",
        "requestId": "835a5cc4-4487-4bf2-961a-55bc0ee77d02",
        "data": {
                "orgId": "yourOrgId",
                "assetId": "yourAssetId",
                "modelId": "yourModelId",
                "modelIdPath": "yourModelIdPath",
                "productKey": "yourProductKey",
                "productName": {
                        "defaultValue": "test_product_name",
                        "i18nValue": {}
                },
                "productType": "Device",
                "dataFormat": "Json",
                "deviceKey": "yourDeviceKey",
                "deviceName": {
                        "defaultValue": "testforname",
                        "i18nValue": {}
                },
                "deviceSecret": "yourDeviceSecret",
                "deviceDesc": "test for undatedevice",
                "timezone": "+08:00",
                "deviceAttributes": {
                        "int11": 617
                },
                "deviceTags": {
                        "test": "test for tags"
                },
                "mirrorSource": "mirrorSourceAssetId",
                "createTime": 1557905107199,
                "status": "offline",
                "activeTime": 1557909526473,
                "lastOnlineTime": 1560743931658,
                "lastOfflineTime": 1560744111658,
                "measurepointLastUpdate": 1565875705704,
                "eventLastUpdate": 1565875705856,
                "attributeLastUpdate": 1547793776699,
                "featureLastUpdate": 1565875705856,
                "firmwareVersion": "2.2"
        }
}

Java SDK 调用示例

package com.envisioniot.enos.api.sample.connect_service.device;

import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envisioniot.enos.connect_service.v2_1.device.GetDeviceRequest;
import com.envisioniot.enos.connect_service.v2_1.device.GetDeviceResponse;

public class GetDevice {

    public static void main(String[] args) {
        final String appKey = "yourAppKey";
        final String appSecret = "yourAppSecret";
        String serverUrl = "yourServerUrl";

        String orgId = "yourOrgId";
        String assetId = "yourAssetId";
        GetDeviceRequest request = new GetDeviceRequest();
        request.setOrgId(orgId);
        request.setAssetId(assetId);
        GetDeviceResponse response = Poseidon.config(PConfig.init().appKey(appKey).appSecret(appSecret).debug())
                .url(serverUrl)
                .getResponse(request, GetDeviceResponse.class);

    }
}