1. API Description

Domain name for API request: lighthouse.intl.tencentcloudapi.com.

This API is used to modify the description of a single firewall rule.

• FirewallVersion is used to specify the version of the firewall to be manipulated. If the FirewallVersion value passed in is not equal to the current latest version of the firewall, a failure will be returned. If FirewallVersion is not passed in, the description of the specified rule will be modified directly.

In the FirewallRule parameter:

• Valid values of the Protocol field include TCP, UDP, ICMP, and ALL.
• For the Port field, you can enter only ALL, a single port number, several port numbers separated by commas, or a port range indicated by two port numbers separated by a minus sign. If Port is a range, the port number on the left of the minus sign must be smaller than the one on the right. If Protocol is not TCP or UDP, Port can only be empty or ALL. The length of the Port field cannot exceed 64 characters.
• For the CidrBlock field, you can enter any string that conforms to the CIDR format standard. Multi-Tenant network isolation rules take precedence over private network rules in the firewall.
• For the Action field, you can enter only ACCEPT or DROP.
• The length of the FirewallRuleDescription field cannot exceed 64 characters.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Modifying firewall rule description

Input Example

https://lighthouse.intl.tencentcloudapi.com/?Action=ModifyFirewallRuleDescription
&InstanceId=lhins-aglzynfg
&FirewallRule.Protocol=TCP
&FirewallRule.Port=80
&FirewallRule.FirewallRuleDescription='test'
&<Common request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.