1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
修改企业安全组规则,包括编辑内容或启停规则。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyEnterpriseSecurityGroupRule。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| ModifyType | 是 | Integer | 修改类型,仅接受 0、1、2。0:用 Data 完整替换 RuleUuid 指定规则的可写内容;1:修改 RuleUuid 指定规则的启停状态;2:修改当前账号全部可操作规则的启停状态。 示例值:0 |
| RuleUuid | 是 | Integer | 规则数值 ID。ModifyType=0 或 1 时,调用 DescribeCfwRules,传 RuleType=enterprise_sg、RuleId=<数值 RuleUuid>、ExpandNames=false,并使用返回的 rules[].uuid;ModifyType=2 时传 0。 示例值:900001 |
| CfwAiAgentOperationSource | 否 | String | AI操作来源 枚举值:
示例值:console |
| Data | 否 | SecurityGroupRule | ModifyType=0 时必填的完整规则内容对象,不是局部更新。调用 DescribeCfwRules,传 RuleType=enterprise_sg、RuleId=<数值 RuleUuid>、ExpandNames=false 获取原规则:src_content、dst_content 分别写入 SourceContent、DestContent;src_type 和 dst_type 的 0、1/2/3/4/5/6/16/24/25、7、8、9/10、100 分别对应 net、instance、template、tag、region、resourcegroup,DestType 的 20 对应 dnsparse;未列出的数值类型不能转换。再调用 DescribeEnterpriseSecurityGroupRule,使用同一 RuleUuid 获取 OrderIndex、Protocol、Port、RuleAction、Description、Scope 和 ServiceTemplateId。缺失字段按空值处理,仅 Scope 省略时保留原值。ModifyType=1 或 2 时不传 Data。 |
| Enable | 否 | Integer | 规则状态,JSON 整数:0 表示关闭,1 表示开启。ModifyType=1 时修改 RuleUuid 指定规则,ModifyType=2 时修改当前账号的全部可操作规则;这两种模式下应显式填写。ModifyType=0 时忽略该字段。 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NewRuleUuid | Integer | ModifyType=0/1 返回规则 ID;ModifyType=2 回显请求中的 RuleUuid。 示例值:35641 |
| Status | Integer | 处理状态:0 表示成功。 示例值:0 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改单条企业安全组规则内容
修改 RuleUuid 指定的企业安全组规则完整内容。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyEnterpriseSecurityGroupRule
{
"RuleUuid": 420001,
"ModifyType": 0,
"Data": {
"SourceContent": "192.0.2.0/24",
"SourceType": "net",
"DestContent": "198.51.100.10",
"DestType": "net",
"RuleAction": "accept",
"Description": "允许文档网段访问HTTPS",
"OrderIndex": "10",
"Protocol": "TCP",
"Port": "443",
"ServiceTemplateId": "",
"Scope": "SG"
}
}
输出示例
{
"Response": {
"Status": 0,
"NewRuleUuid": 420001,
"RequestId": "11111111-2222-4333-8444-555555555555"
}
}
示例2 关闭单条企业安全组规则
关闭 RuleUuid 指定的企业安全组规则。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyEnterpriseSecurityGroupRule
{
"RuleUuid": 420002,
"ModifyType": 1,
"Enable": 0
}
输出示例
{
"Response": {
"Status": 0,
"NewRuleUuid": 420002,
"RequestId": "22222222-3333-4444-8555-666666666666"
}
}
示例3 开启全部企业安全组规则
开启全部企业安全组规则;RuleUuid 传 0。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyEnterpriseSecurityGroupRule
{
"RuleUuid": 0,
"ModifyType": 2,
"Enable": 1
}
输出示例
{
"Response": {
"Status": 0,
"NewRuleUuid": 0,
"RequestId": "33333333-4444-4555-8666-777777777777"
}
}
示例4 将企业安全组规则修改为地域访问解析域名
用户要求广州地域资产按 DNS 解析结果访问域名时,调用 DescribeCfwRules 和 DescribeEnterpriseSecurityGroupRule 获取原规则完整字段,调用 DescribeSecurityGroupRegionList 获取广州对应的 Region=ap-guangzhou,再完整提交修改。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyEnterpriseSecurityGroupRule
{
"RuleUuid": 420003,
"ModifyType": 0,
"Data": {
"SourceContent": "ap-guangzhou",
"SourceType": "region",
"DestContent": "example.org",
"DestType": "dnsparse",
"RuleAction": "log",
"Description": "观察广州地域资产访问解析域名",
"OrderIndex": "12",
"Protocol": "TCP",
"Port": "443",
"ServiceTemplateId": "",
"Scope": "SG"
}
}
输出示例
{
"Response": {
"Status": 0,
"NewRuleUuid": 420003,
"RequestId": "44444444-5555-4666-8777-888888888888"
}
}
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 | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |