DescribeDirectConnectGatewayCcnRoutes

Last updated: 2021-03-19 16:26:18

1. API Description

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

This API (DescribeDirectConnectGatewayCcnRoutes) is used to query the CCN routes (IDC IP range) of the Direct Connect gateway.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeDirectConnectGatewayCcnRoutes.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
DirectConnectGatewayId	Yes	String	The ID of the Direct Connect gateway, such as `dcg-prpqlmg1`.
CcnRouteType	No	String	The route learning type of the CCN. Available values: `BGP` - Automatic learning. `STATIC` - Static means user-configured. This is the default value.
Offset	No	Integer	Offset.
Limit	No	Integer	The returned quantity.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	The number of objects meeting the condition.
RouteSet	Array of DirectConnectGatewayCcnRoute	The CCN route (IDC IP range) list.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the CCN routes of a direct connect gateway

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeDirectConnectGatewayCcnRoutes
&DirectConnectGatewayId=dcg-prpqlmg1
&<Common request parameters>

Output Example

{
  "Response": {
    "RouteSet": [
      {
        "RouteId": "ccnr-bvipc87w",
        "DestinationCidrBlock": "10.33.0.0/24",
        "ASPath": [
          "1000",
          "2000",
          "3000"
        ]
      },
      {
        "RouteId": "ccnr-oc61so0o",
        "DestinationCidrBlock": "192.168.0.0/24",
        "ASPath": []
      }
    ],
    "TotalCount": 2,
    "RequestId": "6e446c86-d8c9-4981-9b33-d10956585058"
  }
}

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
InvalidParameterValue.Malformed	Invalid input parameter format.
ResourceNotFound	The resource does not exist.

Recent Pages