DescribeNatGatewayDirectConnectGatewayRoute

Download PDF

DescribeNatGatewayDirectConnectGatewayRoute

最后更新时间：2024-11-25 20:08:46

下载PDF

1. API Description

Domain name for API request: vpc.intl.tencentcloudapi.com.

This API is used to query the routes between a NAT gateway and Direct Connect.

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: DescribeNatGatewayDirectConnectGatewayRoute.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
NatGatewayId	Yes	String	Unique ID of the NAT gateway
VpcId	Yes	String	Unique ID of VPC
Limit	No	Integer	Valid range: 0-200
Offset	No	Integer	Greater than 0

3. Output Parameters

Parameter Name	Type	Description
NatDirectConnectGatewayRouteSet	Array of NatDirectConnectGatewayRoute	Route data
Total	Integer	Total number of routes
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the information of the routes of a NAT gateway

Input Example

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

{
    "NatGatewayId": "nat-2jd1e1rm",
    "VpcId": "vpc-3m6kvgrx",
    "Limit": 10,
    "Offset": 0
}

Output Example

{
    "Response": {
        "Total": 1,
        "NatDirectConnectGatewayRouteSet": [
            {
                "DestinationCidrBlock": "99.99.99.77/32",
                "UpdateTime": "2020-09-22 00:00:00",
                "GatewayType": "DIRECTCONNECT",
                "GatewayId": "dcg-71awizmv",
                "CreateTime": "2020-09-22 00:00:00"
            }
        ],
        "RequestId": "852bd0e9-2104-4e83-b0fc-87c2c2036140"
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError	An internal error occurred.
InvalidParameterValue	The parameter value is invalid.
InvalidParameterValue.Malformed	Invalid input parameter format.
ResourceNotFound	The resource does not exist.
UnauthorizedOperation	Unauthorized operation.

tencent cloud

Recent Pages

DescribeNatGatewayDirectConnectGatewayRoute

1. API Description

2. Input Parameters

3. Output Parameters

4. Example