转发规则修改3.0

1. 接口描述

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

转发规则更新接口

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyDispenseExternalRule。
Version	是	String	公共参数，本接口取值：2023-06-16。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-shanghai 。
Name	是	String	规则名称示例值：honor-qce/lb-lb_vip
ExtNamespace	是	String	云监控对外命名空间示例值：QCE/LB
Producer	是	Producer	转发目标消信息
RuleId	是	Integer	规则ID 示例值：8388612
DispenseRegions.N	否	Array of String	转发部署地域列表示例值：["gz"]
ExtMetrics.N	否	Array of String	云监控对外指标示例值：["VConnum","VNewConn"]
Period.N	否	Array of Integer	指标统计周期示例值：[60]
DispenseConditions.N	否	Array of DispenseCondition	转发过滤信息

3. 输出参数

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

4. 示例

示例1 转发规则修改

输入示例

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

{
    "Name": "hyzev-test",
    "ExtNamespace": "QCE/CVM",
    "Producer": {
        "ProtocolType": 2,
        "Type": "Kafka",
        "Brokers": "11.150.215.105:9092",
        "Topic": "Barad_Hyzevtest",
        "Username": "hyzev",
        "Password": "***"
    },
    "RuleId": 8388612,
    "DispenseRegions": [],
    "ExtMetrics": [],
    "Period": [
        60
    ],
    "DispenseConditions": [
        {
            "ExtMetric": "DiskUsage",
            "DispenseFilters": [
                {
                    "Key": "appid2",
                    "Values": [
                        "1258344701"
                    ],
                    "Expression": "="
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "a7acc9ea-585c-4c6d-b482-d919e431b82c"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.Db	FailedOperation.Db
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。