物联网通信 网关子设备

一、1. 接口描述

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeGatewayBindDevices。
Version	是	String	公共参数，本接口取值：2021-04-08。
Region	是	String	公共参数，详见产品支持的地域列表。
GatewayProductId	是	String	网关设备的产品ID示例值：EQPOKD5111
GatewayDeviceName	是	String	网关设备的设备名示例值：devGat-001
Offset	是	Integer	偏移量，Offset从0开始示例值：0
Limit	是	Integer	分页的页大小示例值：10
ProductId	否	String	LoRa产品的ID示例值：BSDGEW222

三、3. 输出参数

参数名称	类型	描述
TotalCount	Integer	子设备总数示例值：1
Devices	Array of BindDeviceInfo	子设备信息
ProductName	String	子设备所属的产品名示例值：devGat-001
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

四、输入示例

https://iotcloud.tencentcloudapi.com/?Action=DescribeGatewayBindDevices
&GatewayProductId=EQPOKD5111
&GatewayDeviceName=devGat-001
&Offset=0
&Limit=10
&ProductId=EQPOKD5111
&<公共请求参数>

五、输出示例

{
"Response": {
"TotalCount": 1,
"Devices": [
{
"ProductId": "EQPOKD5111",
"DeviceName": "devGat-001",
"BindTime": 1,
"Tags": []
}
],
"ProductName": "dev-001",
"RequestId": "69f65618-600b-4ac4-b8e3-4528a6819078"
}
}

六、腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便你从同一入口查询及使用腾讯云提供的所有 API 服务。

七、API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

八、SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

九、命令行工具

·Tencent Cloud CLI 3.0

十、6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InternalError.DBOperationError	数据库内部错误。
InvalidParameterValue	参数取值错误。
ResourceNotFound.ProductNotExist	产品不存在。