管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>私有网络>私有网络相关接口>查询全局路由列表。

查询全局路由列表。

最近更新时间：2025-04-25 02:10:29

我的收藏

本页目录：

1. 接口描述

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

查询全局路由列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeGlobalRoutes。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
Filters.N 否 Array of Filter 过滤条件。
  • global-route-id - String - （过滤条件）如全局路由唯一 Id，形如：gr-bmenrwu2。
  • vpc-id - String - （过滤条件）VPC唯一Id， 形如： vpc-mcqaoy0f。
  • gateway-id - String - （过滤条件）下一跳对象。
  • gateway-type - String - 是否必填：否 - （过滤条件）按下一跳类型进行过滤。支持 NORMAL_CVM
  • cdc-id - String - （过滤条件）CDC实例ID，形如：cluster-gbo27yc4。
  • description - String - （过滤条件）描述。
  • dest-cidr - String - （过滤条件）Ipv4目标网段。
  • subnet-route-algorithm - String - （过滤条件）支持的 ECMP算法有：

    - ECMP_QUINTUPLE_HASH：五元组hash
    - ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash
    - ECMP_DESTINATION_IP_HASH：目的IP hash
    - ECMP_SOURCE_IP_HASH：源IP hash


    • 示例值：[{ "Name": "vpc-id", "Values": ["vpc-mcqaoy0f"]} ]}
    Offset 否 Integer 偏移量。
    示例值：0
    Limit 否 Integer 请求对象个数。
    示例值：10
    GlobalRouteIds.N 否 Array of String 全局路由唯一Id列表。
    示例值：["gr-bmenrwu2"]

    3. 输出参数

    参数名称 类型 描述
    GlobalRouteSet Array of GlobalRoute 全局路由对象。
    TotalCount Integer 符合条件的实例数量。
    示例值：1
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询Ipv4全局路由

    查询Ipv4全局路由

    输入示例

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

{
    "GlobalRouteIds": [
        "gr-remsfl8e"
    ]
}

    输出示例

    {
    "Response": {
        "GlobalRouteSet": [
            {
                "CreatedTime": "2025-02-21 16:32:36",
                "Description": "ivan_gr",
                "DestinationCidrBlock": "192.168.0.0/16",
                "GatewayId": "10.0.16.4",
                "GatewayType": "NORMAL_CVM",
                "GlobalRouteId": "gr-remsfl8e",
                "SubnetRouteAlgorithm": "ECMP_QUINTUPLE_HASH",
                "VpcId": "vpc-mcqaoy0f"
            }
        ],
        "RequestId": "1c76c527-aa4e-45cc-9b0b-25dbe81072e4",
        "TotalCount": 1
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.NotUtf8EncodingError 不是UTF8编码。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。
    中国站
    目录