1. 接口描述
接口请求域名： iss.tencentcloudapi.com 。
用于获取网关列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListGateways。 |
| Version | 是 | String | 公共参数，本接口取值：2023-05-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| PageNumber | 否 | Integer | 页码，默认为1 示例值：1 |
| PageSize | 否 | Integer | 每页数量，默认为20 示例值：10 |
| Name | 否 | String | 网关名称 示例值：网关1 |
| ClusterId | 否 | String | 服务节点ID 示例值：b2181417-03ce-4ea3-ae39-**** 取值可参考： 查询设备可用服务节点 |
| Status | 否 | Integer | 网关状态（0：离线，1 ：在线） 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | ListGatewaysData | 返回数据 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListGateways
<公共请求参数>
{}输出示例
{
"Response": {
"Data": {
"List": [
{
"ClusterId": "abcdefgh-1234-5678-ijkl-1234567890ab",
"ClusterName": "上海一区",
"CreatedAt": "2007-01-01T08:00:00+08:00",
"Description": "123",
"DeviceNum": 0,
"GwId": "2b8d8734******************4a82f19",
"GatewayId": "hijklmno-efgh-5678-ijkl-1234567890ab",
"Name": "you think who you are",
"Status": 0,
"Region": "ap-shanghai"
}
],
"TotalCount": 1
},
"RequestId": "8f541de2-e247-4c93-98b7-8243d9e4f0ef"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败 |
| InvalidParameterValue | 无效的参数值 |
| InvalidParameterValue.InvalidClusterId | 无效的集群ID，长度或内容不符合规则 |
| InvalidParameterValue.InvalidName | 名称为空或填写有误 |