1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
修改一条互联网边界访问控制规则。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyAclRule。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Rules.N | 是 | Array of CreateRuleItem | 待修改的规则数组,必须恰好包含一条完整规则,不是局部更新。调用 DescribeCfwRules,传 RuleType=border、目标 RuleUuid、ExpandNames=false 获取原规则。字段转换:uuid→Uuid,sequence→OrderIndex,src_ip→SourceContent,src_type→SourceType,dst_content→TargetContent,dst_type→TargetType,dst_port→Port,detail→Description;action 的 0、1、2 分别转换为 log、drop、accept,enabled 的布尔值转换为字符串 true、false;protocol、direction、scope、param_template_id、rule_source、log_id 分别写入 Protocol、Direction、Scope、ParamTemplateId、RuleSource、LogId。src_type 和 dst_type 的 1、2、3、4/5、6、8、9、10、100、101、102 分别对应 net、url、domain、template、instance、tag、dnsparse、domainiptwoverify、group、location、vendor;仅当转换结果属于对应 SourceType 或 TargetType 的有效取值时才能提交。用户要求改为某地域时,调用 DescribeAclRegInfo:Scope=serial 传 FwType=["SERIAL"],Scope=side 传 FwType=["BYPASS"],Scope=all 同时传两项,按用户地域名称匹配 Data[].RegionName,并将对应 Data[].RegionCode 写入 location 类型的 Content;不得使用 ap-guangzhou 等云资源地域、中文地域名称或自行拼接代码。vendor 类型的 Content 仅使用 tencent、aliyun、aws、huawei、azure 或 all,不使用“腾讯云”等展示名称。省略的可写字段不会继承旧值。 |
| CfwAiAgentOperationSource | 否 | String | AI操作来源 枚举值:
示例值:console |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleUuid | Array of Integer | 修改后的规则 ID 列表,成功时包含请求规则的 Uuid。 示例值:[8888] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 先查后完整修改一条互联网边界规则
修改 Uuid 指定规则的 Description;其它可写字段随完整规则一并提交。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAclRule
{
"Rules": [
{
"SourceContent": "192.0.2.10",
"SourceType": "net",
"TargetContent": "198.51.100.20",
"TargetType": "net",
"Protocol": "ANY",
"RuleAction": "accept",
"Port": "-1/-1",
"Direction": 0,
"OrderIndex": 3,
"Uuid": 246810,
"Enable": "true",
"Description": "允许文档示例业务访问",
"Scope": "serial",
"RuleSource": 0,
"LogId": "alert-log-example-001",
"ParamTemplateId": ""
}
]
}
输出示例
{
"Response": {
"RuleUuid": [
246810
],
"RequestId": "00000000-0000-4000-8000-000000000002"
}
}
示例2 按用户要求将规则修改为观察广东来源入站访问
用户要求“将规则修改为观察广东来源的入站访问”时,先调用 DescribeAclRegInfo,按规则 Scope=serial 传 FwType=["SERIAL"],从 Data 中精确匹配 RegionName=广东省并取得 RegionCode=gd44;再调用 DescribeCfwRules 查询目标规则,完整携带原规则可写字段,并把入站来源改为 location 和 gd44。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAclRule
{
"Rules": [
{
"SourceContent": "gd44",
"SourceType": "location",
"TargetContent": "198.51.100.20",
"TargetType": "net",
"Protocol": "TCP",
"RuleAction": "log",
"Port": "443",
"Direction": 1,
"OrderIndex": 4,
"Uuid": 246811,
"Enable": "true",
"Description": "观察广东来源入站访问",
"Scope": "serial",
"RuleSource": 0,
"LogId": "",
"ParamTemplateId": ""
}
]
}
输出示例
{
"Response": {
"RuleUuid": [
246811
],
"RequestId": "00000000-0000-4000-8000-000000000003"
}
}
示例3 将互联网边界规则修改为域名规则
先查询并完整携带目标规则字段,再把出站目的改为域名;域名目的使用 HTTPS 等应用层协议。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAclRule
{
"Rules": [
{
"SourceContent": "192.0.2.0/24",
"SourceType": "net",
"TargetContent": "example.com",
"TargetType": "domain",
"Protocol": "HTTPS",
"RuleAction": "log",
"Port": "443",
"Direction": 0,
"OrderIndex": 3118,
"Uuid": 246813,
"Enable": "false",
"Description": "观察文档域名 HTTPS 访问",
"Scope": "serial",
"RuleSource": 0,
"LogId": "",
"ParamTemplateId": ""
}
]
}
输出示例
{
"Response": {
"RuleUuid": [
246813
],
"RequestId": "00000000-0000-4000-8000-000000000004"
}
}
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 | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |