查看路由接收策略条目

最近更新时间:2025-10-21 03:25:51

我的收藏

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeRoutePolicyEntries)用于查询路由接收策略条目列表。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRoutePolicyEntries。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 过滤条件,参数不支持同时指定RoutePolicyEntryIds和Filters。
  • route-policy-id - String - (过滤条件)路由接收策略实例ID,形如:rrp-f49l6u0z。
  • cidr-block - String - (过滤条件)CIDR(只取掩码前的子网部分),形如:10.0.0.0/8。
  • priority - Integer - (过滤条件)优先级,形如:20。
  • gateway-type - String - (过滤条件)下一跳类型,形如:CVM。
  • gateway-id - String - (过滤条件)下一跳实例唯一ID,形如:ccn-f49l6u0z。
  • route-type - String - (过滤条件)路由类型,取值:USER(用户路由),NETD(网络探测下发的路由),CCN(云联网路由)。
  • action - String - (过滤条件)动作,取值:DROP(丢弃),DISABLE(接收且禁用),ACCEPT(接收且启用)。
  • description - String - (过滤条件)描述,形如:TEST。
  • route-policy-item-id - String - (过滤条件)路由接收策略条目唯一ID,形如:rrpi-dq782kw7。
  • Offset Integer 偏移量。
    示例值:0
    Limit Integer 请求对象个数。
    示例值:10
    OrderField String 排序字段。当前只支持优先级Prioriry字段。
    示例值:Priority
    OrderDirection String 排序方向。
    ASC:升序。
    DESC:降序。
    示例值:ASC
    RoutePolicyEntryIds.N Array of String 路由策略条目ID。

    3. 输出参数

    参数名称 类型 描述
    RoutePolicyEntrySet Array of RoutePolicyEntry 路由接收策略条目列表。
    TotalCount Integer 符合条件的实例数量。
    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询路由策略规则列表

    查询路由策略规则列表。

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeRoutePolicyEntries
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Name": "route-policy-id",
                "Values": [
                    "rrp-fcrulzf8"
                ]
            }
        ],
        "Offset": 1,
        "Limit": 1,
        "OrderField": "abc",
        "OrderDirection": "abc"
    }

    输出示例

    {
        "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. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。