私有网络查询高优路由表条目-API 文档-文档中心-腾讯云

1. 接口描述

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

查询高优路由表条目信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeHighPriorityRoutes。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
HighPriorityRouteTableId	是	String	高优路由表唯一 ID。示例值：hprtb-18mot1fm
Filters.N	否	Array of Filter	gateway-id - String - （过滤条件）网关ID。 description - String - （过滤条件）路由描述。 dest-cidr - String - （过滤条件）目的端地址，支持模糊左匹配。 subnet-route-algorithm - String - （过滤条件）现在支持的算法有：ECMP_QUINTUPLE_HASH：五元组hash，ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash，ECMP_DESTINATION_IP_HASH：目的IP hash，ECMP_SOURCE_IP_HASH：源IP hash。 is-cdc - String - （过滤条件）CDC属性高优路由表。 cdc-id - String - （过滤条件）CDC 集群唯一 ID 。
Offset	否	Integer	偏移量。示例值：0
Limit	否	Integer	请求对象个数。示例值：20

3. 输出参数

参数名称	类型	描述
HighPriorityRouteSet	Array of HighPriorityRoute	高优路由表条目信息。
TotalCount	Integer	高优路由表条目个数。示例值：10
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询高优路由表条目

查询高优路由表条目

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHighPriorityRoutes
<公共请求参数>

{
    "HighPriorityRouteTableId": "hprtb-hd4tl8cg",
    "Filters": [
        {
            "Name": "gateway-id",
            "Values": [
                "172.16.0.11"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "HighPriorityRouteSet": [
            {
                "CdcId": "",
                "CreatedTime": "2024-07-11 17:34:48",
                "Description": "ivan_test",
                "DestinationCidrBlock": "192.168.0.0/24",
                "GatewayId": "172.16.0.11",
                "GatewayType": "NORMAL_CVM",
                "HighPriorityRouteId": "hprti-0sb1mbut",
                "HighPriorityRouteTableId": "hprtb-hd4tl8cg",
                "IsCdc": false,
                "SubnetRouteAlgorithm": "ECMP_QUINTUPLE_HASH"
            }
        ],
        "RequestId": "482a9736-73ed-4212-8b08-79403cd34cd3",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.ModuleError	内部模块错误。
InvalidParameter.Coexist	参数不支持同时指定。
InvalidParameter.FilterInvalidKey	指定过滤条件不存在。
InvalidParameter.FilterNotDict	指定过滤条件不是键值对。
InvalidParameterValue.LimitExceeded	参数值超出限制。
InvalidParameterValue.Malformed	入参格式不合法。
InvalidParameterValue.ResourceNotFound	未查询到该资源。
ResourceNotFound	资源不存在。