Help Center/ Application Operations Management/ API Reference/ APIs/ Prometheus Instance/ Creating a Recording Rule for a Prometheus Instance
Updated on 2025-10-23 GMT+08:00

Creating a Recording Rule for a Prometheus Instance

Function

This API is used to create a recording rule for a Prometheus instance.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    aom:metric:put

    Write

    -

    -

    -

    -

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

prometheus_instance

Yes

String

Prometheus instance ID. Currently, only common Prometheus instances and Prometheus instances for CCE are supported.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Content-Type

Yes

String

Content type, which is application/json.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

recording_rule

Yes

String

Recording rule.

Details of the recording rule to be created. The following sub-parameters are supported:

  • groups: rule group. You can set multiple rule groups in one RecordingRule.yaml file.

  • name: rule group name. Each rule group name must be unique.

  • interval: execution interval of a rule group. The default value is 60s. (Optional)

  • rules: rules. A rule group can contain multiple rules.

  • record: rule name. Each recording rule name must comply with Prometheus metric name specifications.

  • expr: calculation expression. It is used to calculate metric values. The calculation expression must comply with PromQL.

  • labels: metric label. Each label must comply with Prometheus metric label specifications. (Optional)

Response Parameters

Status code: 204

No Content: The request is successful, but no content is returned.

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_type

String

Error type.

trace_id

String

Trace ID.

Example Requests

Create a recording rule for a Prometheus instance.

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"
}

Example Responses

Status code: 500

The recording rule already exists.

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

SDK Sample Code

The SDK sample code is as follows.

Java

Create a recording rule for a Prometheus instance.

 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
60
61
62
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");
        String projectId = "{project_id}";

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

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateRecordingRuleRequest request = new CreateRecordingRuleRequest();
        request.withPrometheusInstance("{prometheus_instance}");
        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());
        }
    }
}

Python

Create a recording rule for a Prometheus instance.

 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
# 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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = CreateRecordingRuleRequest()
        request.prometheus_instance = "{prometheus_instance}"
        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)

Go

Create a recording rule for a Prometheus instance.

 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
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")
    projectId := "{project_id}"

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

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

    request := &model.CreateRecordingRuleRequest{}
	request.PrometheusInstance = "{prometheus_instance}"
	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)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

204

No Content: The request is successful, but no content is returned.

500

The recording rule already exists.

Error Codes

See Error Codes.