1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
获取 LoRa 网关列表接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetLoRaGatewayList。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。 |
IsCommunity | 是 | Boolean | 是否是社区网关 示例值:true |
Offset | 否 | Integer | 偏移量 示例值:0 |
Limit | 否 | Integer | 限制个数 示例值:10 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 返回总数 示例值:2 |
Gateways | Array of LoRaGatewayItem | 返回详情项 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取非社区网关列表
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetLoRaGatewayList
<公共请求参数>
{
"Limit": 1,
"IsCommunity": true,
"Offset": 1
}
输出示例
{
"Response": {
"Gateways": [
{
"GatewayId": "ff00000000000003",
"IsPublic": true,
"Description": "fortest",
"Name": "ddgw3",
"Position": "tfine",
"PositionDetails": "fyd",
"Location": {
"Latitude": 0,
"Longitude": 0,
"Altitude": 0,
"Accuracy": 0
},
"UpdatedAt": "2019-12-05 03:53:32 PM",
"CreatedAt": "2019-12-05 03:53:32 PM",
"LastSeenAt": ""
},
{
"GatewayId": "ff00000000000004",
"IsPublic": false,
"Description": "fortest",
"Name": "ddgw4",
"Position": "",
"PositionDetails": "",
"Location": {
"Latitude": 0,
"Longitude": 0,
"Altitude": 0,
"Accuracy": 0
},
"UpdatedAt": "2019-12-05 04:13:50 PM",
"CreatedAt": "2019-12-05 04:13:50 PM",
"LastSeenAt": ""
}
],
"RequestId": "1e99faaf-a0f0-4c49-9d85-7f09f2b7f74e",
"Total": 2
}
}
示例2 获取 LoRa 社区网关列表
输入示例
https://iotexplorer.tencentcloudapi.com/?Action=GetLoRaGatewayList
&IsCommunity=true
&<公共请求参数>
输出示例
{
"Response": {
"Gateways": [
{
"GatewayId": "ff00000000000003",
"IsPublic": true,
"Description": "fortest",
"Name": "ddgw3",
"Position": "tfine",
"PositionDetails": "fyd",
"Location": {
"Latitude": 0,
"Longitude": 0,
"Altitude": 0,
"Accuracy": 0
},
"UpdatedAt": "2019-12-05 03:53:32 PM",
"CreatedAt": "2019-12-05 03:53:32 PM",
"LastSeenAt": ""
},
{
"GatewayId": "1000000000000019",
"IsPublic": true,
"Description": "fortest",
"Name": "test0233",
"Position": "tfine",
"PositionDetails": "teshu",
"Location": {
"Latitude": 0,
"Longitude": 0,
"Altitude": 0,
"Accuracy": 0
},
"UpdatedAt": "1970-01-01 08:00:00 AM",
"CreatedAt": "2019-12-03 02:32:18 PM",
"LastSeenAt": ""
}
],
"RequestId": "1e99faaf-a0f0-4c49-9d85-7f09f2b7f74e",
"Total": 2
}
}
5. 开发者资源
腾讯云 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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DBOpertaionError | DB操作错误。 |
InternalError.InternalRPCError | 内部RPC错误。 |
InternalError.InternalServerExceptionDB | 内部DB错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |