tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeNatAcRule

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

1. API Description

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

This API is used to get the NAT access control list.

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: DescribeNatAcRule.
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.
Limit Yes Integer Number of entries per page.
Offset Yes Integer Page offset.
Index No String Index to be queried. This parameter is optional, and is used only in specific cases.
Filters.N No Array of CommonFilter Filter condition combination.
StartTime No String Start time for search. This parameter is optional.
EndTime No String End time for search. This parameter is optional.
Order No String Valid values: desc: descending; asc: ascending. The returned results are sorted by the value of By. If this parameter is specified, By is also required.
By No String Field by which the returned results are sorted.

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of entries.
Data Array of DescAcItem NAT access control list data.
Note: This field may return null, indicating that no valid values can be obtained.
AllTotal Integer Total number of entries returned without filtering.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the NAT access control list

This example shows you how to get the NAT access control list.

Input Example

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

{
    "Index": "xx",
    "Filters": [
        {
            "Name": "xx",
            "Values": [
                "xx"
            ],
            "OperatorType": 0
        }
    ],
    "Limit": 1,
    "Offset": 1,
    "StartTime": "xx",
    "EndTime": "xx",
    "Order": "xx",
    "By": "xx"
}

Output Example

{
    "Response": {
        "Total": 1,
        "Data": [
            {
                "SourceContent": "xx",
                "TargetContent": "xx",
                "Protocol": "xx",
                "Port": "xx",
                "RuleAction": "xx",
                "Description": "xx",
                "Count": 1,
                "OrderIndex": 1,
                "SourceType": "xx",
                "TargetType": "xx",
                "Uuid": 1,
                "Invalid": 1,
                "IsRegion": 1,
                "CountryCode": 1,
                "CityCode": 1,
                "CountryName": "xx",
                "CityName": "xx",
                "CloudCode": "xx",
                "IsCloud": 1,
                "Enable": "xx",
                "Direction": 1,
                "InstanceName": "xx",
                "InternalUuid": 0,
                "Status": 1
            }
        ],
        "AllTotal": 1,
        "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
FailedOperation Operation failed.
InvalidParameter Invalid parameter.
LimitExceeded The quota limit has been reached.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy