DescribeRoutePolicyEntries

Last updated:2025-11-13 20:42:37

DescribeRoutePolicyEntries

Last updated: 2025-11-13 20:42:37

1. API Description

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

This API is used to query the route reception policy entry list.

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: DescribeRoutePolicyEntries.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
Filters.N	No	Array of Filter	Filter criteria. RoutePolicyEntryIds and Filters cannot be specified at the same time. route-policy-id - String - (filter condition) specifies the instance id of the route reception policy, such as rrp-f49l6u0z. . cidr-block - String - (filter condition) cidr (subnet part before the mask), such as 10.0.0.0/8. . priority - Integer - filter condition. specifies the priority, such as 20. . gateway-type - String - (filter criteria) next hop type, such as CVM. . GatewayId - String - specifies the unique id of the next hop instance, such as ccn-f49l6u0z. . route-type - String - (filter condition) routing type. valid values: USER (USER route), NETD (route issued by network probe), CCN (CCN route). . action - String - (filter condition) specifies the action. valid values: DROP (DROP), DISABLE (receive and DISABLE), ACCEPT (receive and enable). . description - String - specifies the filter condition description, such as TEST. . route-policy-item-id - String - (filter condition) specifies the entry unique id of the route reception policy, such as rrpi-dq782kw7. .
Offset	No	Integer	Offset.
Limit	No	Integer	Number of request objects.
OrderField	No	String	Sorting field. currently only supports the priority field.
OrderDirection	No	String	Specifies the sorting order. ASC: ascending order. DESC: descending order.
RoutePolicyEntryIds.N	No	Array of String	Specifies the routing strategy entry ID.

3. Output Parameters

Parameter Name	Type	Description
RoutePolicyEntrySet	Array of RoutePolicyEntry	Route reception policy entry list.
TotalCount	Integer	Number of eligible instances.
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 Routing Strategy Rule List

This example shows you how to query the rule list of a routing strategy.

Input Example

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

{
    "Filters": [
        {
            "Name": "route-policy-id",
            "Values": [
                "rrp-fcrulzf8"
            ]
        }
    ],
    "Offset": 1,
    "Limit": 1,
    "OrderField": "abc",
    "OrderDirection": "abc"
}

Output Example

{
    "Response": {
        "RoutePolicyEntrySet": [
            {
                "RoutePolicyEntryId": "rrpi-5j5wut37",
                "Description": "",
                "GatewayType": "PVGW",
                "GatewayId": "172.16.16.37",
                "Priority": 1113,
                "Action": "DROP",
                "RouteType": "ANY",
                "CidrBlock": "10.0.0.0/16",
                "CreatedTime": "2021-09-08 15:20:14",
                "Region": "ap-guangtzhou"
            }
        ],
        "TotalCount": 1,
        "RequestId": "2cd67e99-9376-421d-a5bb-044a10c9d744"
    }
}

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

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud