The content of this page has been automatically translated by AI. If you encounter any problems while reading, you can view the corresponding content in Chinese.
Help & Documentation>IoT Explorer>Application Side API>Device management>Get the Sub-Device List of the Designated Gateway Device

Get the Sub-Device List of the Designated Gateway Device

Last updated: 2025-04-30 15:32:35

On this page:

1. API Description

api request domain name: iot.cloud.tencent.com/api/exploreropen/tokenapi. this interface (AppGetGatewayBindDeviceList) is used to obtain the sub-device list of the designated gateway device.

2. Input Parameters

Name
Type
Required
Description
AccessToken
String
Yes
Common parameter. AccessToken is used for user authentication of a logged-in user.
RequestId
String
Yes
Common parameter. Unique request ID can be generated manually. It is recommended to use uuId. When locating issues, provide the RequestId for the request.
Action
String
Yes
Common parameter. This interface takes values: AppGetGatewayBindDeviceList.
ProductId
String
Yes
Subdevice's ProductId.
GatewayProductId
String
Yes
ProductId of the gateway device.
GatewayDeviceName
String
Yes
DeviceName of the gateway device.
Offset
Int
Yes
Message offset.
Limit
Int
Yes
Maximum return message count, with a maximum value of 50.

3. Output Parameters

Name
Type
Description
RequestId
String
Common parameter. Unique request ID can be generated manually. It is recommended to use uuId. When locating issues, provide the RequestId for the request.
Total
String
Total number.
DeviceList
Array of DeviceList
Device list.

4. Example

Input example
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1
content-type: application/json 
{
    "RequestId": "req_1",
    "Action": "AppGetGatewayBindDeviceList",
    "ProductId":"LAEG4YJE1A"  // Subdevice's productId
    "GatewayProductId":"NJ27OVLZT4",  //gateway device's productId
    GatewayDeviceName: gwdev  // deviceName of the gateway device
    "Offset":0,
    "Limit":2,
    "AccessToken": "8b4a70dd16105f******************18edd4e78a3bb8ec"
}
Output example
{
    "Response": {
            "DeviceList": [{
                "ProductId": "LAEG4YJE1A",  
                "DeviceName": "subdev2"
                "DeviceId": "LAEG4YJE1A/subdev2", //subdevice's deviceId
                "AliasName": "",
                "IconUrl": "",
                "BindStatus": 0   //not bound to family
            }, {
                "ProductId": "LAEG4YJE1A",
                "DeviceName": "subdev1",
                "DeviceId": "LAEG4YJE1A/subdev1",
                "AliasName": "",
                "IconUrl": "",
                "BindStatus": 1  //already bound to family
            }],
            "RequestId": "req_1",
            "Total": 2
    }
}

5. Error Code

Error Code
Description
InternalError
Internal error.
InternalError.InternalRPCError
Call timeout.
InternalError.InternalRPCError
The call returned failure.
InvalidParameterValue
Invalid parameter value.
InvalidParameterValue.InvalidAccessToken
Token invalid.
UnsupportedOperation
Unsupported operation.
UnsupportedOperation.NotSupportVirtualDevice
Virtual devices are not supported.
UnsupportedOperation.DeviceNotGateway
Not a gateway device.
ResourceNotFound
The resource does not exist.
ResourceNotFound.DeviceNotExist
The device is not created or has been deleted.
ResourceNotFound.StudioMemberNotExist
Family members are not created or have been deleted.

中国站 - English