tencent cloud

应用性能监控

文档应用性能监控API 文档业务系统相关接口修改 APM 业务系统与 Prometheus 实例的指标匹配规则

修改 APM 业务系统与 Prometheus 实例的指标匹配规则

Download
聚焦模式
字号
最后更新时间: 2026-05-14 20:28:46

1. 接口描述

接口请求域名: apm.intl.tencentcloudapi.com 。

用于修改apm业务系统与Prometheus实例的指标匹配规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyApmPrometheusRule。
Version String 公共参数,本接口取值:2021-06-22。
Region String 公共参数,详见产品支持的 地域列表
Id Integer 规则ID
InstanceId String 业务系统ID
Name String 所要修改的规则名
Status Integer 规则状态:1(启用)、2(不启用)、3(删除)
ServiceName String 规则生效的应用。生效于全部应用就传空(这个如果不修改也要传旧的规则)
MetricMatchType Integer 匹配类型:0精准匹配,1前缀匹配,2后缀匹配(这个如果不修改也要传旧的规则)
MetricNameRule String 客户定义的命中指标名规则。

3. 输出参数

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

4. 示例

示例1 修改apm业务系统与Prometheus实例的指标匹配规则

修改apm业务系统与Prometheus实例的指标匹配规则

输入示例

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

{
    "Id": 2,
    "Name": "MyRule",
    "Status": 2,
    "ServiceName": "profile-service",
    "MetricMatchType": 0,
    "MetricNameRule": "task.duration",
    "InstanceId": "apm-059oXBfTL"
}

输出示例

{
    "Response": {
        "RequestId": "be4c9cea-5b0f-4b96-93d6-59c840a4c096"
    }
}

5. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.PromRuleConflict Prometheus指标匹配规则冲突,有相同的指标匹配规则
FailedOperation.PromRuleIsEmptyErr Prometheus指标匹配规则为空
FailedOperation.PromRuleRequestNotValidError Prometheus指标匹配规则请求有误

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈