V2.4 Get Gateway¶
获取子设备对应的网关信息。
如果你在使用 API 批量更新相关设备信息后调用当前 API,建议两次调用间隔 2 秒左右,以免获取到未更新数据。
请求格式¶
POST https://{apigw-address}/connect-service/v2.4/device-topos?action=getGateway
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织 ID。 如何获取 orgId 信息>> |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
subDevice |
必需 |
DeviceIdentifier 结构体 |
识别子设备的标志信息,其结构参见 DeviceIdentifier 结构体。 |
requireSecret |
可选 |
Boolean |
|
DeviceIdentifier 结构体 ¶
备注
以下非必需字段中,必须提供 assetId
,或提供 productKey
+ deviceKey
,用于指定设备。
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
assetId |
可选(见上述注解) |
String |
资产 ID。如何获取 assetId 信息>> |
productKey |
可选(见上述注解) |
String |
设备的 product key,需与 |
deviceKey |
可选(见上述注解) |
String |
设备的 device key,需与 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
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 |
设备连接密钥,仅当 |
sessionKey |
String |
配合解密 deviceSecret 的参数,仅当 |
deviceDesc |
String |
设备描述。 |
timezone |
String |
设备所在时区。 |
deviceAttributes |
Map(Key 和 Value 为 string) |
设备的属性。 |
deviceTags |
Map(Key 和 Value 为 string) |
设备的标签。 |
mirrorSource |
String |
镜像源设备的 device key。 |
createTime |
Long |
设备的创建时间。 |
status |
String |
设备的状态(online、offline、inactive、disable 或 mirror)。
|
activeTime |
Long |
设备的激活时间。 |
lastOnlineTime |
Long |
设备最后一次上线时间。 |
lastOfflineTime |
Long |
设备最后一次离线时间。 |
measurepointLastUpdate |
Long |
设备测点最近一次更新的时间。 |
eventLastUpdate |
Long |
设备事件最近一次更新的时间。 |
attributeLastUpdate |
Long |
设备属性最近一次更新的时间。 |
featureLastUpdate |
Long |
设备最近一次更新的时间,以上述三个时间( |
firmwareVersion |
String |
固件版本号。 |
错误码¶
代码 |
错误信息 |
描述 |
---|---|---|
11858 |
Unable to find public key |
由于应用的服务帐号未创建 RSA 密钥对,无法获取 RSA 公钥,因此无法请求 |
示例¶
请求示例¶
url: https://{apigw-address}/connect-service/v2.4/device-topos?action=getGateway&orgId=yourOrgId
method: POST
requestBody:
{
"subDevice":{
"assetId":"yourAssetId",
},
"requireSecret": true
}
返回示例¶
{
"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":"EncryptedDeviceSecret",
"sessionKey":"EncryptedSessionKey",
"deviceDesc": null,
"timezone": "+08:00",
"deviceAttributes": {},
"deviceTags": {},
"mirrorSource": null,
"firmwareVersion": null,
"createTime": 1560759829419,
"status": "inactive",
"activeTime": 0,
"lastOnlineTime": 0,
"lastOfflineTime": 0,
"measurepointLastUpate": null,
"eventLastUpdate": null,
"attributeLastUpdate": 1561447707379,
"featureLastUpdate": 1561447707379
}
}
SDK 示例¶
你可以在 Github 上获取接入服务的 SDK 示例: