Tenant Cloud Network Virtual Private Cloud CCN APIs DescribeCcnRoutes

DescribeCcnRoutes

Last Updated At: 2026-08-02 00:06:16

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

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

Default interface request rate limit: 100 times per second.

Interface update time: 2018-12-20 05:37:04.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeCcnRoutes
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
CcnId Yes No String CCN instance ID, e.g., ccn-gree226l.
Example: ccn-gree226l
RouteIds No No Array of String Unique ID of CCN routing policy, e.g., ccnr-f49l6u0z.
Example: ccnr-f49l6u0z
Filters No No Array of Filter Filters. Parameters RouteIds and Filters must not be specified simultaneously.
  • route-id - String - (Filters) Routing policy ID.
  • cidr-block - String - (Filters) Destination endpoint.
  • instance-type - String - (Filters) Type of the next hop.
  • instance-region - String - (Filters) Region of the next hop.
  • instance-id - String - (Filters) Next hop instance ID.

    • Example:View
    Offset No No Uint64 Offset
    Example: 0
    Limit No No Uint64 Returned quantity
    Example: 10

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of eligible objects.
    Example:
    RouteSet Array of CcnRoute CCN routing policy object.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    ResourceNotFound The resource does not exist
    InvalidParameter.Coexist The parameters must not be specified simultaneously.