查询Prometheus实例的预聚合规则 - ListRecordingRule
功能介绍
该接口用于查询Prometheus实例创建预聚合规则。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
aom:metric:list
List
-
-
- aom:metric:get
-
URI
GET /v1/{project_id}/{prometheus_instance}/aom/api/v1/rules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 |
|
prometheus_instance |
是 |
String |
prometheus实例id。当前仅支持Prometheus实例类型为Prometheus for CCE 和通用实例。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
|
Content-Type |
是 |
String |
指定类型为application/json。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
recording_rule |
String |
Prometheus实例下的预汇聚规则。 |
|
rule_id |
String |
Prometheus实例下的预汇聚规则id。 |
请求示例
-
查询Pormetheus实例下的预汇聚规则。
https://{Endpoint}/v1/{project_id}/{prometheus_instance}/aom/api/v1/rules { "recording_rule" : "", "rule_id" : "" } -
查询Pormetheus实例下的预汇聚规则。
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", "rule_id" : "2095****1202****67" }
响应示例
状态码:200
OK 请求响应成功。
{
"recording_rule" : "",
"rule_id" : ""
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功。 |
错误码
请参见错误码。