帮你快速理解、总结文档立即下载
文档中心>腾讯云可观测平台

转发规则查询3.0

最近更新时间：2026-08-27 02:34:48
我的收藏

本页目录：

1. 接口描述

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

转发规则查询接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDispenseExternalRule。
Version 是 String 公共参数，本接口取值：2023-06-16。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-shanghai 。
RuleId 是 Integer 规则id
示例值：1

3. 输出参数

参数名称 类型 描述
Rule Rule 规则
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 转发规则查询，指定id

输入示例

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

{
    "RuleId": 8388612
}

输出示例

{
    "Response": {
        "Rule": {
            "DispenseConditions": [
                {
                    "ConditionId": 8388609,
                    "DispenseFilters": [
                        {
                            "Expression": "=",
                            "Key": "appid2",
                            "Values": [
                                "1258344701"
                            ]
                        }
                    ],
                    "ExtMetric": "DiskUsage"
                }
            ],
            "DispenseRegions": [
                "gz"
            ],
            "ExtMetric": [],
            "ExtNamespace": "QCE/CVM",
            "Name": "hyzev-test",
            "Period": [
                60
            ],
            "Producer": {
                "Brokers": "11.150.215.105:9092",
                "Merge": 1,
                "Password": "***",
                "ProtocolType": 2,
                "Topic": "Barad_Hyzevtest",
                "Type": "Kafka",
                "Username": "hyzev"
            },
            "RuleId": 8388612,
            "Status": 1,
            "UpdateTime": 1755228861
        },
        "RequestId": "a61604bc-cae2-495e-980f-0f61fbd40218"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.Db FailedOperation.Db
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。
中国站