文档首页/ 应用运维管理 AOM/ API参考/ API/ Prometheus实例/ 创建Prometheus实例的预聚合规则
更新时间:2024-07-23 GMT+08:00

创建Prometheus实例的预聚合规则

功能介绍

该接口用于给Prometheus实例创建预聚合规则。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/{prometheus_instance}/aom/api/v1/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的projectid,一般为32位字符串。

prometheus_instance

String

prometheus实例id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

Content-Type

String

指定类型为application/json。

表3 请求Body参数

参数

是否必选

参数类型

描述

recording_rule

String

预聚合规则。

响应参数

状态码: 500

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

error_type

String

错误类型。

trace_id

String

链路id。

请求示例

给Prometheus实例创建预聚合规则。

https://{Endpoint}/v1/{project_id}/{prometheus_instance}/aom/api/v1/rules

{
  "recording_rule" : "groups:\n    - name: apiserver_request_total\n      interval: 60s\n      rules:\n        - record: job_instance_mode:apiserver_request_total:avg_rate5m\n          expr: avg by (job, instance, mode) (rate(apiserver_request_total[5m]))\n          labels:\n            team: operations\n        - record: job:apiserver_request_total:sum_rate10m\n          expr: sum by (job)(rate(apiserver_request_total[10m]))\n          labels:\n            team: operations"
}

响应示例

状态码: 204

OK 请求响应成功。

""

状态码: 500

预聚合规则已经存在。

{
  "error_code" : "AOM.5001019",
  "error_msg" : "recording rule exist for the prometheus instance"
}

状态码

状态码

描述

204

OK 请求响应成功。

500

预聚合规则已经存在。

错误码

请参见错误码