---
title: "List alarm rules"
method: POST
path: "/api/v1/alarm/rule/rules"
tags: ["Alarm"]
---

# List alarm rules

`POST /api/v1/alarm/rule/rules`

List alarm rules, filter with alarm objects type, severity and keywords.

## Request body

- RuleRuleFilter
  - `instanceType` 'unknown' | 'obcluster' | 'obzone' | 'obtenant' | 'observer'
  - `keyword` string
  - `severity` 'critical' | 'warning' | 'caution' | 'info'

## Response `200`

OK

- object
  - `data` RuleRuleResponse[], required
    - `description` string, required
    - `duration` integer, required
    - `evaluationTime` number, required
    - `health` 'unknown' | 'ok' | 'error', required
    - `instanceType` 'unknown' | 'obcluster' | 'obzone' | 'obtenant' | 'observer', required
    - `keepFiringFor` integer, required
    - `labels` CommonKVPair[], required
      - `key` string, required
      - `value` string, required
    - `lastError` string
    - `lastEvaluation` integer, required
    - `name` string, required
    - `query` string, required
    - `severity` 'critical' | 'warning' | 'caution' | 'info', required
    - `state` 'active' | 'inactive', required
    - `summary` string, required
    - `type` 'builtin' | 'customized'
  - `message` string, required
  - `successful` boolean, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

## Changes

- **2024-04-29** `5e1f25f76011` — 1 info
  - endpoint added
- **2024-02-27** `643ae3c8d824` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/changes/api/v1/alarm/rule/rules/post.md)

---

[API](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api.md) · [All operations](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oceanbase/oceanbase-dashboard-api/revisions/fa579fa6f72d/schema)