tencent cloud

Feedback

AddNatAcRule

Last updated: 2023-05-04 17:40:20

1. API Description

Domain name for API request: cfw.tencentcloudapi.com.

This API is used to add NAT access control rules.

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: AddNatAcRule.
Version Yes String Common Params. The value used for this API: 2019-09-04.
Region No String Common Params. This parameter is not required for this API.
Rules.N Yes Array of CreateNatRuleItem NAT access control rules to be added.
From No String Source of the rules to be added. Generally, this parameter is not used. The value insert_rule indicates that rules in the specified location are inserted, and the value batch_import indicates that rules are imported in batches. If the parameter is left empty, rules defined in the API request are added.

3. Output Parameters

Parameter Name Type Description
RuleUuid Array of Integer ID list of new rules.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding NAT access control rules

This example shows you how to add NAT access control rules.

Input Example

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddNatAcRule
<Common Request Parameters>

{
    "Rules": [
        {
            "SourceContent": "xx",
            "SourceType": "xx",
            "TargetContent": "xx",
            "TargetType": "xx",
            "Protocol": "xx",
            "RuleAction": "xx",
            "Port": "xx",
            "Direction": 1,
            "OrderIndex": 0,
            "Uuid": 0,
            "Enable": "xx",
            "Description": "xx"
        }
    ],
    "From": "xx"
}

Output Example

{
    "Response": {
        "RuleUuid": [
            0
        ],
        "RequestId": "xx"
    }
}

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
AuthFailure CAM signature/authentication error.
DryRunOperation DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit has been reached.
MissingParameter Missing parameter.
OperationDenied Operation denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse The resource is occupied.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation Unsupported operation.