文档首页/ 应用运维管理 AOM/ API参考/ API/ Prometheus实例/ 创建Prometheus实例的预聚合规则
更新时间:2024-08-21 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"
}

SDK代码示例

SDK代码示例如下。

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.aom.v2.region.AomRegion;
import com.huaweicloud.sdk.aom.v2.*;
import com.huaweicloud.sdk.aom.v2.model.*;


public class CreateRecordingRuleSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateRecordingRuleRequest request = new CreateRecordingRuleRequest();
        RecordingRuleRequest body = new RecordingRuleRequest();
        body.withRecordingRule("groups:
    - name: apiserver_request_total
      interval: 60s
      rules:
        - record: job_instance_mode:apiserver_request_total:avg_rate5m
          expr: avg by (job, instance, mode) (rate(apiserver_request_total[5m]))
          labels:
            team: operations
        - record: job:apiserver_request_total:sum_rate10m
          expr: sum by (job)(rate(apiserver_request_total[10m]))
          labels:
            team: operations");
        request.withBody(body);
        try {
            CreateRecordingRuleResponse response = client.createRecordingRule(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v2.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateRecordingRuleRequest()
        request.body = RecordingRuleRequest(
            recording_rule="groups:
    - name: apiserver_request_total
      interval: 60s
      rules:
        - record: job_instance_mode:apiserver_request_total:avg_rate5m
          expr: avg by (job, instance, mode) (rate(apiserver_request_total[5m]))
          labels:
            team: operations
        - record: job:apiserver_request_total:sum_rate10m
          expr: sum by (job)(rate(apiserver_request_total[10m]))
          labels:
            team: operations"
        )
        response = client.create_recording_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateRecordingRuleRequest{}
	request.Body = &model.RecordingRuleRequest{
		RecordingRule: "groups:
    - name: apiserver_request_total
      interval: 60s
      rules:
        - record: job_instance_mode:apiserver_request_total:avg_rate5m
          expr: avg by (job, instance, mode) (rate(apiserver_request_total[5m]))
          labels:
            team: operations
        - record: job:apiserver_request_total:sum_rate10m
          expr: sum by (job)(rate(apiserver_request_total[10m]))
          labels:
            team: operations",
	}
	response, err := client.CreateRecordingRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

OK 请求响应成功。

500

预聚合规则已经存在。

错误码

请参见错误码