1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
查询内网间访问控制规则的生效范围
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeVpcAclEdgeRange。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| FromList | 是 | String | 规则列表来源:rules,来源于当前已配置的规则;switchs,来源于开关列表 示例值:rules |
| Index | 否 | String | 需要查询的索引,特定场景使用,可不填 示例值:vpc_rule |
| 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. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总条数 示例值:1 |
| EdgeRanges | Array of EdgeRange | 内网间访问控制规则的生效范围列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询内网间访问控制规则的生效范围
查询内网间访问控制规则的生效范围示例
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVpcAclEdgeRange
<公共请求参数>
{
"FromList": "rules",
"Filters": [
{
"Name": "EdgeId",
"Values": [
"cfws-xxxx"
],
"OperatorType": 9
}
],
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"EdgeRanges": [
{
"EdgeId": "cfws-xxx",
"EdgeName": "test",
"SrcId": "vpc-xxx",
"SrcRegion": "ap-shanghai",
"SrcName": "test1",
"SrcCidr": "192.168.0.0/24",
"DstId": "vpc-xxx",
"DstRegion": "ap-shanghai",
"DstName": "test2",
"DstCidr": "192.168.2.0/24"
}
],
"TotalCount": 1,
"RequestId": "xx"
}
}
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: 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| UnauthorizedOperation | 未授权操作。 |