V2.4 Get Gateway¶
Get the gateway information based on the specified sub-device.
If you need to invoke this API after performing bulk updates to relevant gateways or sub-devices using other APIs, it is recommended to wait for about 2 seconds to avoid obtaining unupdated data.
Request Format¶
POST https://{apigw-address}/connect-service/v2.4/device-topos?action=getGateway
Request Parameters (URI)¶
Name | Location (Path/Query) | Mandatory/Optional | Data Type | Description |
---|---|---|---|---|
orgId | Query | Mandatory | String | The organization ID which the asset belongs to. How to get orgId>> |
Request Parameters (Body)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
subDevice | Mandatory | DeviceIdentifier Struct | The information of the sub-device. For more details, see DeviceIdentifier Struct. |
requireSecret | Optional | Boolean |
|
DeviceIdentifier Struct ¶
Note
Use either the (assetId
) or (productKey
+ deviceKey
) for the following.
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
assetId | Optional (See Note above) | String | The asset ID. How to get assetId>> |
productKey | Optional (See Note above) | String | The product key. To be used with deviceKey . |
deviceKey | Optional (See Note above) | String | The device key. To be used with productKey . |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
data | Device Struct | The information of the gateway device. For more details, see Device Struct. |
Device Struct ¶
Name | Data Type | Description |
---|---|---|
orgId | String | The organization ID which the asset belongs to. |
assetId | String | The asset ID. |
modelId | String | The model ID which the asset belongs to. |
modelIdPath | String | The model ID path. |
productKey | String | The product key. |
productName | StringI18n | The product name. |
productType | String | The product type. |
dataFormat | String |
|
deviceKey | String | The device key. |
deviceName | StringI18n | The device name. |
deviceSecret | String | The device secret, returned only when the value of requireSecret is true . The returned value will be encrypted. How to Decrypt >> |
sessionKey | String | The key for encrypting and decrypting the value of deviceSecret , returned only when the value of requireSecret is true . The returned value will be encrypted. How to Decrypt >> |
deviceDesc | String | The device description. |
timezone | String | Timezone of the device’s location. |
deviceAttributes | Map | The device attributes. The Key is the attribute ID, and the Value type depends on the attribute defined in the ThingModel . |
deviceTags | Map | The device tags. (The Key and Value are of String type.) |
mirrorSource | String | The device key of the mirror source. |
createTime | Long | The time when the device was created. |
status | String | The device status (online, offline, inactive, disable, or mirror)
|
activeTime | Long | The time when the device was activated. |
lastOnlineTime | Long | The last online time of the device. |
lastOfflineTime | Long | The last offline time of the device. |
measurepointLastUpdate | Long | The last time when a measurement point was updated. |
eventLastUpdate | Long | The last time when an event was updated. |
attributeLastUpdate | Long | The last time when an attribute was updated. |
featureLastUpdate | Long | The last time when a measurement point, an event, or an attribute was updated. |
firmwareVersion | String | The firmware version. |
Error Codes¶
Code | Message | Description |
---|---|---|
11858 | Unable to find public key | Unable to find public key for requireSecret due to there is no RSA key pair for the service account. Creating RSA Key Pairs >>. |
Samples¶
Request Sample¶
url: https://{apigw-address}/connect-service/v2.4/device-topos?action=getGateway&orgId=yourOrgId
method: POST
requestBody:
{
"subDevice":{
"assetId":"yourAssetId",
},
"requireSecret": true
}
Return Sample¶
{
"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
}
}