Creating a Recording Rule for a Prometheus Instance

Updated on 2025-01-07 GMT+08:00

View PDF

Function

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

Calling Method

For details, see Calling APIs.

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.

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.

Response Parameters

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: 204

OK: The request is successful.

""

Status code: 500

The recording rule already exists.

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

Status Codes

Status Code	Description
204	OK: The request is successful.
500	The recording rule already exists.

Error Codes

See Error Codes.

Parent topic: Prometheus Instance

Previous topic: Adding a Prometheus Instance

Next topic: Obtaining the Credential for Calling a Prometheus Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel