tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

RefreshDirectConnectGatewayRouteToNatGateway

Last updated: 2023-08-23 14:11:25

1. API Description

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

This API is used to refresh the route between a NAT gateway and Direct Connect and update the associated route table.

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: RefreshDirectConnectGatewayRouteToNatGateway.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
VpcId Yes String VPC ID
NatGatewayId Yes String The NAT gateway ID.
DryRun Yes Boolean Whether it is pre-refresh. Valid values: True (yes) and False (no)

3. Output Parameters

Parameter Name Type Description
DirectConnectSubnetSet Array of DirectConnectSubnet IDC subnet information
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Performing a dry run before refreshing the routes

This example shows you how to do a dry run of route refreshing. In this case, only the IDC IP range is returned.

Input Example

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

{
    "VpcId": "vpc-3m6kvgrx",
    "NatGatewayId": "nat-2jd1e1rm",
    "DryRun": "True",
}

Output Example

{
    "Response": {
        "RequestId": "928d1513-d3fa-4c4e-b8fd-077cebbc3118",
        "DirectConnectSubnetSet": [
            {
                "DirectConnectGatewayId": "dcg-71awizmv",
                "CidrBlock": "99.99.99.77/32"
            }
        ]
    }
}

Example2 Refreshing routes

This example shows you how to refresh routes.

Input Example

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

{
    "VpcId": "vpc-3m6kvgrx",
    "NatGatewayId": "nat-2jd1e1rm",
    "DryRun": "False"
}

Output Example

{
    "Response": {
        "RequestId": "b2b08cbc-c0dc-4346-bc55-a9b17a7a2a03",
        "DirectConnectSubnetSet": [
            {
                "DirectConnectGatewayId": "dcg-71awizmv",
                "CidrBlock": "99.99.99.77/32"
            }
        ]
    }
}

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
InternalError An internal error occurred.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy