1. 接口描述
接口请求域名: apm.tencentcloudapi.com 。
用于创建apm业务系统与Prometheus实例的指标匹配规则
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateApmPrometheusRule。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Name | 是 | String | 指标匹配规则名 示例值:MyRule |
| ServiceName | 是 | String | 规则生效的应用。作用全部应用就传空字符串 示例值:java-market-service |
| MetricMatchType | 是 | Integer | 指标匹配类型:0精准匹配,1前缀匹配,2后缀匹配 示例值:1 |
| MetricNameRule | 是 | String | 客户定义的命中指标名规则。 示例值:task.duration |
| InstanceId | 是 | String | 业务系统ID 示例值:apm-059oXBfTL |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleId | Integer | 指标匹配规则的ID 示例值:438 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建apm业务系统与Prometheus实例的指标匹配规则
创建apm业务系统与Prometheus实例的指标匹配规则
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApmPrometheusRule
<公共请求参数>
{
"Name": "MyRuleTest",
"ServiceName": "java-market-service",
"MetricMatchType": 1,
"MetricNameRule": "task.duration",
"InstanceId": "apm-059oXBfTL"
}
输出示例
{
"Response": {
"RequestId": "72159d4a-265c-43e8-b653-c62358f1e17b"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.PromRuleConflict | Prometheus指标匹配规则冲突,有相同的指标匹配规则 |
| FailedOperation.PromRuleIsEmptyErr | Prometheus指标匹配规则为空 |
| FailedOperation.PromRuleNameConflict | Prometheus指标匹配规则名已存在 |
| FailedOperation.PromRuleRequestNotValidError | Prometheus指标匹配规则请求有误 |