1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
串行防火墙IP开关列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeFwEdgeIps。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Filters.N | 否 | Array of CommonFilter | 过滤条件组合 |
| Limit | 否 | Integer | 每页条数 示例值：20 |
| Offset | 否 | Integer | 偏移值 示例值：0 |
| StartTime | 否 | String | 检索的起始时间，可不传 示例值：2022-07-27 16:00:00 |
| EndTime | 否 | String | 检索的截止时间，可不传 示例值：2022-07-27 16:00:00 |
| Order | 否 | String | desc：降序；asc：升序。根据By字段的值进行排序，这里传参的话则By也必须有值 示例值：desc |
| By | 否 | String | 排序所用到的字段 示例值： id |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of EdgeIpInfo | ip 开关列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | ip 开关列表个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| RegionLst | Array of String | 地域列表 注意：此字段可能返回 null，表示取不到有效值。 |
| InstanceTypeLst | Array of String | 实例类型列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 串行防火墙开关列表
串行防火墙开关列表
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFwEdgeIps
<公共请求参数>
{
"Filters": [
{
"Name": "PublicIp",
"Values": [
"1.1.1.1"
],
"OperatorType": 9
}
],
"Limit": 10,
"Offset": 0,
"StartTime": "2022-07-27 16:00:00",
"EndTime": "2022-07-27 16:00:00",
"Order": "desc",
"By": "PublicIp"
}输出示例
{
"Response": {
"Data": [
{
"PublicIp": "2.2.2.2",
"PublicIpType": 2,
"InstanceId": "ins-xxxxxxxx",
"InstanceName": "cvm实例1",
"IntranetIp": "172.16.1.1",
"AssetType": "cvm",
"Region": "ap-chongqing",
"PortRiskCount": 10,
"LastScanTime": "2022-07-27 16:00:00",
"SwitchMode": 2,
"IsRegionEip": 1,
"VpcId": "vpc-abcdabcd",
"IsSerialRegion": 1,
"IsPublicClb": 0,
"EndpointBindEipNum": 1,
"ScanMode": "medium",
"ScanStatus": 0,
"EndpointId": "vpce-xxxxxxxx",
"EndpointIp": "10.10.10.10",
"SwitchWeight": 100
}
],
"Total": 10,
"RegionLst": [
"abc"
],
"InstanceTypeLst": [
"nat",
"cvm"
],
"RequestId": "0752de63-570c-4c2e-bbd2-78574e22a1ae"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。