tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateAcRules

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

1. API Description

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

This API is used to create access control rules.

A maximum of 10 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: CreateAcRules.
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.
Data.N Yes Array of RuleInfoData Creates rule data
Type No Integer 0: add (default); 1: insert
EdgeId No String Edge ID
Enable No Integer Access control rule status
Overwrite No Integer 0: add; 1: overwrite
InstanceId No String NAT instance ID, required when the parameter Area exists
From No String portScan: from port scanning; patchImport: from batch import
Area No String NAT region

3. Output Parameters

Parameter Name Type Description
Status Integer Status value. 0: operation successful
Info String Returns redundant information
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating rules

Input Example

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

{
    "Data": [
        {
            "OrderIndex": 17,
            "SourceIp": "0.0.0.0/0",
            "TargetIp": "0.0.0.0/0",
            "Protocol": "TCP",
            "Port": "-1/-1",
            "Strategy": "0",
            "Detail": "test",
            "CloudCode": "",
            "SourceType": 1,
            "TargetType": 1,
            "Direction": 1,
            "IsRegion": 0,
            "Country": 0,
            "City": 0,
            "CityName": "",
            "CountryName": ""
        }
    ],
    "Type": 0,
    "EdgeId": "",
    "InstanceId": "",
    "Area": "",
    "Enable": 1
}

Output Example

{
    "Response": {
        "Status": 0,
        "Info": "",
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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
FailedOperation Operation failed.
InvalidParameter Invalid parameter.
LimitExceeded The quota limit has been reached.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy