ModifyFirewallRuleDescription

Last updated: 2025-10-30 21:47:29

ModifyFirewallRuleDescription

Last updated: 2025-10-30 21:47:29

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyFirewallRuleDescription.
Version	Yes	String	Common Params. The value used for this API: 2020-03-24.
Region	No	String	Common Params. This parameter is not required for this API.
InstanceId	Yes	String	Instance ID.
FirewallRule	Yes	FirewallRule	Firewall rule.
FirewallVersion	No	Integer	Current firewall version number. Every time you update the firewall rule version, it will be automatically increased by 1 to prevent the rule from expiring. If it is left empty, conflicts will not be considered.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

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.

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.

Error Code	Description
InvalidParameterValue.FirewallRuleDescriptionTooLong	The length of the firewall rule description exceeds the limit.
InvalidParameterValue.InstanceIdMalformed	Invalid parameter value: the instance ID format is invalid.
ResourceNotFound.FirewallNotFound	The firewall does not exist.
ResourceNotFound.FirewallRulesNotFound	The firewall rule does not exist.
ResourceNotFound.InstanceIdNotFound	The instance ID does not exist.
UnauthorizedOperation.NoPermission	No permission.
UnsupportedOperation.FirewallBusy	The firewall is busy.
UnsupportedOperation.FirewallVersionMismatch	The specified firewall version number does not match the current version.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud