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

1. 接口描述

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

查询高优路由表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeHighPriorityRouteTables。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	过滤条件，参数不支持同时指定HighPriorityRouteTableIds和Filters。 high-priority-route-table-id - String - （过滤条件）高优路由表实例ID。 name - String - （过滤条件）高优路由表名称。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 tag-key - String -是否必填：否 - （过滤条件）按照标签键进行过滤。 next-hop-type - String - 是否必填：否 - （过滤条件）按下一跳类型进行过滤。使用next-hop-type进行过滤时，必须同时携带route-table-id与vpc-id。目前我们支持的类型有： HAVIP：高可用虚拟IP； NORMAL_CVM：普通云服务器；示例值：[{"Name":"high-priority-route-table-id", "Values": ["hprtb-18mot1fm]}]
HighPriorityRouteTableIds.N	否	Array of String	高优路由表实例ID，例如：hprtb-18mot1fm。
Offset	否	String	偏移量。示例值：0
Limit	否	String	返回数量，默认为20，最大值为100。示例值：1
NeedRouterInfo	否	Boolean	是否需要获取路由策略信息，默认获取，当控制台不需要拉取路由策略信息时，改为False。示例值：True

3. 输出参数

参数名称	类型	描述
HighPriorityRouteTableSet	Array of HighPriorityRouteTable	高优路由表对象。
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: DescribeHighPriorityRouteTables
<公共请求参数>

{
    "HighPriorityRouteTableIds": [
        "hprtb-hd4tl8cg"
    ],
    "NeedRouterInfo": true
}

输出示例

{
    "Response": {
        "HighPriorityRouteTableSet": [
            {
                "CreatedTime": "2024-07-10 21:16:50",
                "HighPriorityRouteSet": [
                    {
                        "CdcId": "",
                        "CreatedTime": "2024-07-11 17:07:03",
                        "Description": "test",
                        "DestinationCidrBlock": "172.20.0.0/18",
                        "GatewayId": "172.16.0.11",
                        "GatewayType": "NORMAL_CVM",
                        "HighPriorityRouteId": "hprti-hd4tl8cr",
                        "IsCdc": false,
                        "SubnetRouteAlgorithm": "ECMP_QUINTUPLE_HASH"
                    },
                    {
                        "CdcId": "",
                        "CreatedTime": "2024-07-11 17:14:14",
                        "Description": "ivan_test",
                        "DestinationCidrBlock": "192.168.0.0/20",
                        "GatewayId": "172.16.0.11",
                        "GatewayType": "NORMAL_CVM",
                        "HighPriorityRouteId": "hprti-f9qln349",
                        "IsCdc": false,
                        "SubnetRouteAlgorithm": "ECMP_QUINTUPLE_HASH"
                    }
                ],
                "HighPriorityRouteTableId": "hprtb-hd4tl8cg",
                "Name": "ivan_hprtb",
                "SubnetSet": [
                    "subnet-a9pjzfq0"
                ],
                "VpcId": "vpc-mcqaoy0f"
            }
        ],
        "RequestId": "98c77fa8-578c-4190-a613-43a4cd4ea7a0",
        "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.NotUtf8EncodingError	不是UTF8编码。
InvalidParameterValue.Range	参数值不在指定范围。
InvalidParameterValue.ResourceNotFound	未查询到该资源。
ResourceNotFound	资源不存在。