---
title: "Diagnose alert"
method: POST
path: "/api/v1/alarm/alert/diagnose"
tags: ["Alarm"]
---

# Diagnose alert

`POST /api/v1/alarm/alert/diagnose`

Diagnose alert, trigger a job to do data collection and analization on background.

## Request body

- AlertAnalyzeParam
  - `endsAt` integer, required
  - `instance` OceanbaseOBInstance, required
    - `obcluster` string
    - `observer` string
    - `obtenant` string
    - `obzone` string — obzone may exist in labels
    - `type` 'unknown' | 'obcluster' | 'obzone' | 'obtenant' | 'observer', required
  - `rule` string, required
  - `startsAt` integer, required

## Response `200`

OK

- object
  - `data` JobJob, required
    - `finishTime` integer
    - `name` string, required
    - `namespace` string, required
    - `result` JobJobResult
      - `attachmentId` string
      - `exitCode` integer, required
      - `output` string
    - `startTime` integer
    - `status` 'successful' | 'failed' | 'running' | 'pending', required
  - `message` string, required
  - `successful` boolean, required

## Other responses

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

## Changes

- **2024-09-05** `c8473517a401` — 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/alert/diagnose/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)