操作指南

API 文档

修改防火墙规则描述

最近更新时间:2022-04-13 06:54:28

我的收藏

1. 接口描述

接口请求域名: lighthouse.tencentcloudapi.com 。

本接口(ModifyFirewallRuleDescription)用于修改单条防火墙规则描述。

  • FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本,将返回失败;若不传 FirewallVersion 则直接修改防火墙规则备注。

在 FirewallRule 参数中:

  • Protocol 字段支持输入 TCP,UDP,ICMP,ALL。
  • Port 字段允许输入 ALL,或者一个单独的端口号,或者用逗号分隔的离散端口号,或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时,减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时,Port 字段只能为空或 ALL。Port 字段长度不得超过 64。
  • CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。
  • Action 字段只允许输入 ACCEPT 或 DROP。
  • FirewallRuleDescription 字段长度不得超过 64。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyFirewallRuleDescription。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID。
FirewallRule FirewallRule 防火墙规则。
FirewallVersion Integer 防火墙当前版本。用户每次更新防火墙规则时版本会自动加1,防止规则已过期,不填不考虑冲突。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改防火墙规则描述

输入示例

https://lighthouse.tencentcloudapi.com/?Action=ModifyFirewallRuleDescription
&InstanceId=lhins-aglzynfg
&FirewallRule.Protocol=TCP
&FirewallRule.Port=80
&FirewallRule.FirewallRuleDescription='test'
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "f9c1597d-90ef-4493-b6b4-bbc55f194a76"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.FirewallRuleDescriptionTooLong 防火墙规则描述长度超出限制。
InvalidParameterValue.InstanceIdMalformed 参数值非法,实例 ID 格式非法。
ResourceNotFound.FirewallNotFound 防火墙不存在。
ResourceNotFound.FirewallRulesNotFound 防火墙规则不存在。
ResourceNotFound.InstanceIdNotFound 实例 ID 不存在。
UnsupportedOperation.FirewallBusy 防火墙忙。
UnsupportedOperation.FirewallVersionMismatch 指定的防火墙版本号和当前版本不一致。
目录