V2.1 Get Gateway¶

获取子设备对应的网关信息。

如果你在使用 API 批量更新相关子设备或网关设备相关信息后调用当前 API，建议两次调用间隔 2 秒左右，以免获取到未更新数据。

当前 API 支持在 EnOS 2.1.0 及以上环境中使用，并已新增 V2.4 版本。推荐使用最新版本，参见 V2.4 Get Gateway。

请求格式¶

POST https://{apigw-address}/connect-service/v2.1/device-topos?action=getGateway

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	设备所属的 OU ID。如何获取 orgId 信息>>

请求参数（Body）¶

名称	必需/可选	数据类型	描述
subDevice	必需	DeviceIdentifier 结构体	识别子设备的标志信息，其结构参见 DeviceIdentifier 结构体。

DeviceIdentifier 结构体 ¶

备注

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

名称	数据类型	描述
assetId	String	设备的 asset ID。如何获取 assetId 信息>>
productKey	String	设备的 Product Key。如何获取 productKey 信息>>
deviceKey	String	设备的 Device Key。如何获取设备的 deviceKey 信息>>

响应参数¶

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

Device 结构体 ¶

名称	数据类型	描述
orgId	String	设备所属的 OU ID。
assetId	String	设备的 asset ID。
modelId	String	设备所属模型 ID。
modelIdPath	String	模型 ID 的路径。
productKey	String	设备的 product Key。如何获取设备的 productKey 信息>>
productName	StringI18n	产品名称。
productType	String	产品类型。
dataFormat (弃用)	String	数据格式。`Json` 表示只支持 EnOS 设备协议格式。
deviceKey	String	设备的 Device Key。如何获取设备的 deviceKey 信息>>
deviceName	StringI18n	设备名称。
deviceSecret	String	设备的 device secret。
deviceDesc	String	设备描述。
timezone	String	设备所在时区。
deviceAttributes	Map（Key 和 Value 为 string）	设备的属性。
deviceTags	Map（Key 和 Value 为 string）	设备的标签。
createTime	Long	设备的创建时间。
status	String	设备的状态（online、offline、inactive、disable）。注：EnOS Edge 仅支持 online 或 offline。
activeTime	Long	设备的激活时间。
lastOnlineTime	Long	设备最后一次上线时间。
lastOfflineTime	Long	设备最后一次离线时间。
measurepointLastUpdate	Long	设备测点最近一次更新的时间。
attributeLastUpdate	Long	设备属性最近一次更新的时间。
featureLastUpdate	Long	设备最近一次更新的时间，以上述三个时间（ `measurepointLastUpdate` 、`attributeLastUpdate` ）里最近的时间为准。
firmwareVersion	String	固件版本号。

示例¶

请求示例¶

url: https://{apigw-address}/connect-service/v2.1/device-topos?action=getGateway&orgId=yourOrgId
method: POST
requestBody:
{
    "subDevice":{
        "assetId":"yourAssetId"
    }
}

返回示例¶

{
    "code": 0,
    "msg": "OK",
    "requestId": "49ef6c03-02a0-449b-ab1e-92812071de80",
    "data": {
        "orgId": "yourOrgId",
        "assetId": "J1Rqyaqz",
        "modelId": "AlterTest0617",
        "modelIdPath": "/AlterTest0617",
        "productKey": "yourProductKey",
        "productName": {
            "defaultValue": "testtopo",
            "i18nValue": {}
        },
        "productType": "Gateway",
        "dataFormat": "Json",
        "deviceKey": "yourDeviceKey",
        "deviceName": {
            "defaultValue": "testtopo",
            "i18nValue": {}
        },
        "deviceSecret": "yourDeviceSecret",
        "deviceDesc": null,
        "timezone": "+08:00",
        "deviceAttributes": {},
        "deviceTags": {},
        "firmwareVersion": null,
        "createTime": 1560759829419,
        "status": "inactive",
        "activeTime": 0,
        "lastOnlineTime": 0,
        "lastOfflineTime": 0,
        "measurepointLastUpate": null,
        "attributeLastUpdate": 1561447707379,
        "featureLastUpdate": 1561447707379
    }
}