tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeNatFwInstancesInfo

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 all NAT instances and instance card information of a tenant.

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: DescribeNatFwInstancesInfo.
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.
Filter.N No Array of NatFwFilter Gets filtering fields of instance list
Offset No Integer Page number
Limit No Integer Page length

3. Output Parameters

Parameter Name Type Description
NatinsLst Array of NatInstanceInfo Instance card info array
Note: This field may return null, indicating that no valid value was found.
Total Integer Number of NAT firewalls
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 Querying the list of all NAT firewalls

Input Example

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

{
    "Filter": [
        {
            "FilterType": "NatinsId",
            "FilterContent": "cfwnat-65d0d823,cfwnat-65d0d824"
        },
        {
            "FilterType": "NatinsName",
            "FilterContent": "wytest"
        },
        {
            "FilterType": "FwMode",
            "FilterContent": "1"
        },
        {
            "FilterType": "Region",
            "FilterContent": "ap-guangzhou"
        },
        {
            "FilterType": "EipAddress",
            "FilterContent": "1.13.19.217,1.13.16.20"
        },
        {
            "FilterType": "VpcIp",
            "FilterContent": "10.255.0.20,10.255.0.5"
        }
    ],
    "Offset": 0,
    "Limit": 10
}

Output Example

{
    "Response": {
        "NatinsLst": [
            {
                "BandWidth": 30,
                "EipAddress": [
                    "1.117.4.229",
                    "121.5.27.250"
                ],
                "FwMode": 0,
                "InFlowMax": 4985,
                "NatinsId": "cfwnat-f3250045",
                "NatinsName": "yw",
                "OutFlowMax": 14642,
                "Region": "ap-shanghai",
                "RegionZh": "Shanghai",
                "Subnets": [
                    "subnet-cjxihpy1",
                    "subnet-1e34182d",
                    "subnet-5sx5vrcj",
                    "subnet-he9ba55f",
                    "subnet-0yd4fk0j",
                    "subnet-kdu0qj4t"
                ],
                "VpcIp": [
                    "10.255.6.36",
                    "10.255.6.37",
                    "10.255.6.21",
                    "10.255.6.18",
                    "10.255.6.19",
                    "10.255.5.28",
                    "10.255.5.18",
                    "10.255.5.19"
                ],
                "RegionDetail": "Southwest China"
            }
        ],
        "Total": 1,
        "RequestId": "50e39f16-3b3a-4c66-b76e-1705449ba828"
    }
}

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy