帮你快速理解、总结文档立即下载

查看七层转发规则

最近更新时间:2026-09-15 02:08:59
我的收藏

1. 接口描述

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

查看七层转发规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeForwardingRule。
Version String 公共参数,本接口取值:2025-01-15。
Region String 公共参数,此参数为可选参数。
GlobalAcceleratorId String

全球加速实例ID。


示例值:ga-dz058gbb
ListenerId String

监听器ID。


示例值:lsr-dz058gbb
ForwardingPolicyId String

七层转发规则ID。


示例值:dm-io46vpu6
Offset Integer

偏移量,默认为0。


示例值:0
Limit Integer

返回数量,默认为20,最大值为100。


示例值:10
Filters.N Array of Filter

过滤条件。

  • forwarding-rule-id - String -(过滤条件)规则ID。
  • 3. 输出参数

    参数名称 类型 描述
    ForwardingRuleSet Array of ForwardingRuleSet

    符合条件的规则信息。

    TotalCount Integer

    符合条件的实例个数。


    示例值:10
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查看七层转发规则

    输入示例

    POST / HTTP/1.1
    Host: ga2.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeForwardingRule
    <公共请求参数>
    
    {
        "GlobalAcceleratorId": "ga-r0aukpq8",
        "ListenerId": "lsr-rk9g6p8x",
        "ForwardingPolicyId": "dm-9z3ue2yq"
    }

    输出示例

    {
        "Response": {
            "ForwardingRuleSet": [
                {
                    "EnableOriginSni": false,
                    "ForwardingPolicyId": "dm-9z3ue2yq",
                    "ForwardingRuleId": "rule-bydbpo9y",
                    "GlobalAcceleratorId": "ga-r0aukpq8",
                    "ListenerId": "lsr-rk9g6p8x",
                    "OriginHeaders": [],
                    "OriginHost": "",
                    "OriginSni": "",
                    "RuleAction": [
                        {
                            "RuleActionType": "ForwardGroup",
                            "RuleActionValue": "epg-hru0z2dc"
                        }
                    ],
                    "RuleCondition": [
                        {
                            "RuleConditionType": "Path",
                            "RuleConditionValue": [
                                ""
                            ]
                        }
                    ]
                }
            ],
            "RequestId": "c894e656-4f87-4d7d-a272-636c2de7633d",
            "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. 错误码

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

    错误码 描述
    ResourceNotFound 资源不存在。