tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Firewall
    Documentation
    Download PDF

    DescribeNatFwVpcDnsLst

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

    1. API Description

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

    This API is used to get the VPC DNS status of NAT firewall instances.

    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: DescribeNatFwVpcDnsLst.
    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.
    NatFwInsId Yes String NAT firewall instance ID
    NatInsIdFilter No String Content filtered by NAT firewall, separated with ","
    Offset No Integer Number of pages
    Limit No Integer Maximum entries per page

    3. Output Parameters

    Parameter Name Type Description
    VpcDnsSwitchLst Array of VpcDnsInfo VPC DNS info array of NAT firewall
    Note: This field may return null, indicating that no valid value was found.
    ReturnMsg String Response parameter
    Note: This field may return null, indicating that no valid value was found.
    Total Integer Total number of toggles
    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 Getting the VPC DNS status of NAT firewall instances of a tenant

    Input Example

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

{
    "NatFwInsId": "cfwnat-d1580b7b",
    "Offset": 0,
    "Limit": 10
}

    Output Example

    {
    "Response": {
        "VpcDnsSwitchLst": [
            {
                "SwitchStatus": 0,
                "NatInsId": "cfwnat-f3250045",
                "DNSEip": "121.5.27.250",
                "VpcIpv4Cidr": "10.115.0.0/16",
                "FwMode": 1,
                "VpcName": "wy",
                "VpcId": "vpc-ilbrv877"
            }
        ],
        "Total": 1,
        "ReturnMsg": "success",
        "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.
    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
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy