tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Virtual Private Cloud
    Documentation
    Download PDF

    DescribeCcnRoutes

    Last updated: 2024-11-25 20:09:55
    Download PDF

      1. API Description

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

      This API (DescribeCcnRoutes) is used to query routes that have been added to a CCN.

      A maximum of 100 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: DescribeCcnRoutes.
      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.
      CcnId Yes String The CCN instance ID, such as ccn-gree226l.
      RouteIds.N No Array of String The unique ID of the CCN routing policy, such as ccnr-f49l6u0z.
      Filters.N No Array of Filter Filter condition. RouteIds and Filters cannot be specified at the same time.
    • route-id - String - (Filter condition) Routing policy ID.
    • cidr-block - String - (Filter condition) Destination.
    • instance-type - String - (Filter condition) The next hop type.
    • instance-region - String - (Filter condition) The next hop region.
    • instance-id - String - (Filter condition) The instance ID of the next hop.
    • route-table-id - String - (Filter condition) The list of route table IDs in the format of ccntr-1234edfr. Filters by the route table ID.
      		•
      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 CcnRoute The CCN routing policy object.
      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 list of CCN routes

      This example shows you how to query the list of CCN routes.

      Input Example

      https://vpc.intl.tencentcloudapi.com/?Action=DescribeCcnRoutes
&CcnId=ccn-gree226l
&Filters.0.Name=route-id
&Filters.0.Values.0=ccnr-bvipc87w
&Filters.0.Values.1=ccnr-oc61so0o
&Filters.1.Name=instance-type
&Filters.1.Values.0=VPC
&Filters.1.Values.1=DIRECTCONNECT
&Filters.2.Name=instance-region
&Filters.2.Values.0=ap-guangzhou
&Filters.2.Values.1=ap-beijing
&Filters.2.Values.2=ap-shanghai
&Filters.2.Values.3=eu-frankfurt
&Filters.3.Name=instance-id
&Filters.3.Values.0=vpc-r1ckkpid
&Filters.3.Values.1=dcg-98qosdc3
&Filters.4.Name=cidr-block
&Filters.4.Values.0=10.33.0.0/16
&Filters.4.Values.1=192.168.0.0/24
&<Common request parameters>

      Output Example

      {
    "Response": {
        "TotalCount": 1,
        "RequestId": "3e866888-83ea-4716-b99b-21592cba6548",
        "RouteSet": [
            {
                "DestinationCidrBlock": "10.33.0.0/16",
                "UpdateTime": "2020-09-22 00:00:00",
                "RoutePriority": 1,
                "InstanceId": "vpc-r1ckkpid",
                "InstanceUin": "234532345",
                "Enabled": true,
                "InstanceExtraName": "test",
                "IsBgp": true,
                "InstanceRegion": "ap-guangzhou",
                "ExtraState": "Running",
                "RouteId": "ccnr-bvipc87w",
                "InstanceName": "test",
                "InstanceType": "VPC"
            },
            {
                "DestinationCidrBlock": "192.168.0.0/24",
                "UpdateTime": "2020-09-22 00:00:00",
                "RoutePriority": 1,
                "InstanceId": "vpc-r1ckkpid",
                "InstanceName": "test",
                "Enabled": true,
                "InstanceExtraName": "test",
                "IsBgp": true,
                "InstanceRegion": "ap-guangzhou",
                "ExtraState": "Running",
                "RouteId": "ccnr-oc61so0o",
                "InstanceUin": "234532345",
                "InstanceType": "VPC"
            }
        ]
    }
}

      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
      InvalidParameter.Coexist The parameters cannot be specified at the same time.
      InvalidParameterValue.Malformed Invalid input parameter format.
      InvalidParameterValue.ParameterMismatch Invalid parameter format
      InvalidParameterValue.Range The parameter value is not in the specified range.
      ResourceNotFound The resource does not exist.
      UnsupportedOperation.AppIdNotFound The APPId doesn't exist.
      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