tencent cloud

All product documents
APIs
DocumentationAPIsVirtual Private CloudNetwork ACL APIsModifyNetworkAclEntries
ModifyNetworkAclEntries
Last updated: 2024-11-25 20:08:26
ModifyNetworkAclEntries
Last updated: 2024-11-25 20:08:26

1. API Description

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

This API is used to modify (add or delete) the inbound and outbound rules of a network ACL. In NetworkAclEntrySet parameters,

  • Passing in the new inbound/outbound rules will reset the original rules.
  • Passing in the inbound rules will only reset the original inbound rules and not affect the original outbound rules, and vice versa.

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: ModifyNetworkAclEntries.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
NetworkAclId Yes String Network ACL instance ID, such as acl-12345678.
NetworkAclEntrySet No NetworkAclEntrySet Network ACL rule set. NetworkAclEntrySet and NetworkAclQuintupleSet cannot be entered at the same time.
NetworkAclQuintupleSet No NetworkAclQuintupleEntries Network ACL quintuple rule set. NetworkAclEntrySet and NetworkAclQuintupleSet cannot be entered at the same time.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Deleting inbound rules of a network ACL

This example shows you how to modify network ACL rules by only passing in the rule you want to retain and discarding the ones you want to delete. For example, the acl-12345678 has two inbound rules:

  • Rule 1: TCP 192.168.1.0/24 80 Accept
  • Rule 2: TCP 192.168.1.0/24 443 Accept

    If you want to delete the inbound rule 2, pass in parameters shown in the example.

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNetworkAclEntries
<Common request parameters>

{
    "NetworkAclId": "acl-12345678",
    "NetworkAclEntrySet": {
        "Ingress": [
            {
                "Protocol": "TCP",
                "Description": "test",
                "ModifyTime": "xx",
                "Action": "Accept",
                "CidrBlock": "192.168.1.0/24",
                "Port": "80"
            }
        ]
    }
}

Output Example

{
    "Response": {
        "RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
    }
}

Example2 Adding only inbound rules to a network ACL

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNetworkAclEntries
<Common request parameters>

{
    "NetworkAclId": "acl-12345678",
    "NetworkAclEntrySet": {
        "Ingress": [
            {
                "Protocol": "TCP",
                "Description": "test",
                "ModifyTime": "xx",
                "Action": "Accept",
                "CidrBlock": "192.168.1.0/24",
                "Port": "442"
            },
            {
                "Protocol": "TCP",
                "Description": "test",
                "ModifyTime": "xx",
                "Action": "Accept",
                "CidrBlock": "192.168.1.0/24",
                "Port": "80"
            }
        ]
    }
}

Output Example

{
    "Response": {
        "RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
    }
}

Example3 Adding inbound and outbound rules to a network ACL

This example shows you how to modify network ACL rules by only passing in the rule you want to retain and discarding the ones you want to delete. For example, the acl-12345678 has two inbound rules:

  • Rule 1: TCP 192.168.1.0/24 80 Accept
  • Rule 2: TCP 192.168.1.0/24 443 Accept

    If you want to delete the inbound rule 2, pass in parameters shown in the example.

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNetworkAclEntries
<Common request parameters>

{
    "NetworkAclId": "acl-12345678",
    "NetworkAclEntrySet": {
        "Ingress": [
            {
                "Protocol": "TCP",
                "Description": "test",
                "ModifyTime": "xx",
                "Action": "Accept",
                "CidrBlock": "192.168.1.0/24",
                "Port": "80"
            }
        ],
        "Egress": [
            {
                "Protocol": "TCP",
                "Description": "test",
                "ModifyTime": "xx",
                "Action": "Accept",
                "CidrBlock": "192.168.1.0/24",
                "Port": "80"
            }
        ]
    }
}

Output Example

{
    "Response": {
        "RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
    }
}

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

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
InvalidParameter.AclTypeMismatch
InvalidParameter.Coexist The parameters cannot be specified at the same time.
InvalidParameterValue The parameter value is invalid.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
LimitExceeded Quota limit is reached.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
UnsupportedOperation.AppIdMismatch The resource is not under the specified AppId.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support