From f1790df5b2f1057fb04bbcd8cf7d2b8d4fd824db Mon Sep 17 00:00:00 2001 From: Ulric Qin Date: Tue, 8 Sep 2026 19:40:32 +0800 Subject: [PATCH] docs(monit): remove retired API references and client guidance --- api-reference/monitors.openapi.en.json | 2921 ++++++------------------ api-reference/monitors.openapi.zh.json | 2919 ++++++----------------- api-reference/openapi.en.json | 1853 +-------------- api-reference/openapi.legacy.zh.json | 49 - api-reference/openapi.zh.json | 1851 +-------------- docs.json | 34 +- en/developer/cli.mdx | 20 +- en/developer/go-sdk.mdx | 3 +- en/openapi/api-catalog.mdx | 12 - zh/developer/cli.mdx | 18 +- zh/developer/go-sdk.mdx | 3 +- zh/openapi/api-catalog.mdx | 12 - 12 files changed, 1505 insertions(+), 8190 deletions(-) diff --git a/api-reference/monitors.openapi.en.json b/api-reference/monitors.openapi.en.json index 99830a51..ca9a4c39 100644 --- a/api-reference/monitors.openapi.en.json +++ b/api-reference/monitors.openapi.en.json @@ -25,10 +25,6 @@ "name": "Monitors/Data sources", "description": "Manage monitoring data sources used by alert rules to query metrics." }, - { - "name": "Monitors/Rule sets", - "description": "Manage shared rule sets (rulesets) in the Monitors rule repository. Rulesets can be shared publicly or within an account." - }, { "name": "Monitors/Diagnostics", "description": "Diagnostic and query endpoints used by Flashduty AI SRE — ad-hoc data source queries, log/metric diagnostics, and target-side tool invocation." @@ -39,84 +35,6 @@ } ], "paths": { - "/monit/store/ruleset/update": { - "post": { - "operationId": "monit-store-ruleset-update", - "summary": "Update ruleset", - "description": "Update the note, sharing flag, and payload of an existing ruleset.", - "tags": [ - "Monitors/Rule sets" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Manage** (`monit`) |\n\n## Usage\n\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-update", - "metadata": { - "sidebarTitle": "Update ruleset" - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StoreRulesetItem" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "id": 1, - "note": "Updated CPU alerts", - "open_flag": 2, - "updated_at": 1712100000 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreRulesetUpdateRequest" - }, - "example": { - "id": 1, - "note": "Updated CPU alerts", - "open_flag": 2, - "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.9\"}]" - } - } - } - } - } - }, "/monit/rule/counter/total": { "post": { "operationId": "monit-rule-read-counter-total", @@ -1676,19 +1594,19 @@ } } }, - "/monit/store/ruleset/list": { + "/monit/rule/list/basic": { "post": { - "operationId": "monit-store-ruleset-list", - "summary": "List rulesets", - "description": "Return all rulesets for a given datasource type that are accessible to the current user.", + "operationId": "monit-rule-read-list", + "summary": "List alert rules", + "description": "Return the basic information of all alert rules in a folder. For full rule details, call `POST /monit/rule/info`.", "tags": [ - "Monitors/Rule sets" + "Monitors/Alert rules" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Read** (`monit`) |\n\n## Usage\n\n- A ruleset is visible if its `open_flag` is `2` (public), if the current user is the creator (`open_flag=0`), or if it belongs to the same account (`open_flag=1`).\n- The list does not include the `payload` field. Call `/monit/store/ruleset/info` to get the full ruleset content.", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-list", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |\n\n## Usage\n\n- Set `folder_id` to `0` to list all rules across all folders visible to the current user.\n- The `triggered` field indicates whether the rule has any currently active alerts.", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-list", "metadata": { - "sidebarTitle": "List rulesets" + "sidebarTitle": "List alert rules" } }, "responses": { @@ -1705,7 +1623,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetListResponse" + "$ref": "#/components/schemas/RuleBasicListResponse" } } } @@ -1715,15 +1633,15 @@ "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", "data": [ { - "id": 1, - "type_ident": "prometheus", - "note": "CPU usage alerts", - "open_flag": 2, - "creator_account_id": 10023, - "creator_id": 80011, - "creator_name": "Alice", + "id": 50001, + "folder_id": 100, + "name": "CPU High", + "ds_type": "prometheus", + "enabled": true, + "triggered": true, "created_at": 1710000000, - "updated_at": 1712000000 + "active_alert_count": 2, + "runtime_state": "normal" } ] } @@ -1748,29 +1666,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StoreRulesetListRequest" + "$ref": "#/components/schemas/RuleListRequest" }, "example": { - "type_ident": "prometheus" + "folder_id": 100 } } } } } }, - "/monit/store/ruleset/delete": { + "/monit/datasource/list": { "post": { - "operationId": "monit-store-ruleset-delete", - "summary": "Delete ruleset", - "description": "Delete a ruleset from the rule repository by ID.", + "operationId": "monit-datasource-read-list", + "summary": "List datasources", + "description": "Return all data sources for the current account. Optionally filter by `type_ident`. Supports diagnostic types redis_node, redis_sentinel, mongodb_mongod, mongodb_mongos and kafka; enabled and alerting_enabled are independent.", "tags": [ - "Monitors/Rule sets" + "Monitors/Data sources" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Manage** (`monit`) |\n\n## Usage\n\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-delete", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Datasources Read** (`monit`) |\n\n## Usage\n\n- Omit `type_ident` to return all types.\n- Sensitive credential fields (passwords, keys) are not returned in the list response.\n\nSee the request/response schemas for all supported types and credential handling. Diagnostic-only types cannot enable alerting. On create omitted enabled defaults to true; on update omission preserves the current value. Explicit null for enabled or alerting_enabled is invalid. Diagnostic passwords and Kafka private keys are omitted from responses unless they are environment references; omit these secrets on update to preserve them, or send an empty string to clear. Other datasource credentials may be returned and must be handled as sensitive.", + "href": "/en/api-reference/monitors/data-sources/monit-datasource-read-list", "metadata": { - "sidebarTitle": "Delete ruleset" + "sidebarTitle": "List datasources" } }, "responses": { @@ -1787,7 +1705,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/EmptyResponse" + "$ref": "#/components/schemas/DataSourceListResponse" } } } @@ -1795,7 +1713,21 @@ }, "example": { "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": {} + "data": [ + { + "id": 10, + "account_id": 10023, + "type_ident": "prometheus", + "name": "Prometheus Prod", + "enabled": true, + "note": "Production Prometheus", + "address": "http://prometheus.example.com:9090", + "edge_cluster_name": "default", + "updated_at": 1712000000, + "payload": null, + "alerting_enabled": true + } + ] } } } @@ -1818,29 +1750,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IDRequest" + "$ref": "#/components/schemas/DataSourceListRequest" }, "example": { - "id": 1 + "type": "prometheus" } } } } } }, - "/monit/rule/counter/status": { + "/monit/rule/update/fields": { "post": { - "operationId": "monit-rule-read-counter-status", - "summary": "Get rule status counters for top-level folders", - "description": "Return trigger status summary for all top-level folder nodes — used for the overview dashboard.", + "operationId": "monit-rule-write-fields-update", + "summary": "Batch update rule fields", + "description": "Update specific fields across multiple alert rules at once. Only the fields listed in `fields` are applied.", "tags": [ "Monitors/Alert rules" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-counter-status", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Manage** (`monit`) |\n\n## Usage\n\n- Include the field names you want to update in the `fields` array, e.g. `[\"enabled\", \"channel_ids\"]`.\n- Only the specified fields are updated; others are left unchanged.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-write-fields-update", "metadata": { - "sidebarTitle": "Get rule status counters for top-level folders" + "sidebarTitle": "Batch update rule fields" } }, "responses": { @@ -1857,7 +1789,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleStatusResponse" + "$ref": "#/components/schemas/RuleNameMessageListResponse" } } } @@ -1867,10 +1799,12 @@ "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", "data": [ { - "folder_id": 100, - "folder_name": "Production", - "rule_total": 10, - "triggered_rule_count": 2 + "name": "CPU High", + "message": "" + }, + { + "name": "Disk High", + "message": "" } ] } @@ -1895,27 +1829,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RuleEmptyRequest" + "$ref": "#/components/schemas/RuleFieldsUpdateRequest" }, - "example": {} + "example": { + "ids": [ + 50001, + 50002 + ], + "fields": [ + "enabled" + ], + "enabled": false + } } } } } }, - "/monit/rule/list/basic": { + "/monit/rule/counter/channel": { "post": { - "operationId": "monit-rule-read-list", - "summary": "List alert rules", - "description": "Return the basic information of all alert rules in a folder. For full rule details, call `POST /monit/rule/info`.", + "operationId": "monit-rule-read-counter-channel", + "summary": "Get rule counts by channel", + "description": "Return an object mapping channel name to the number of rules routing alerts to that channel. If a channel name cannot be resolved, the channel ID (as a string) is used as the key.", "tags": [ "Monitors/Alert rules" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |\n\n## Usage\n\n- Set `folder_id` to `0` to list all rules across all folders visible to the current user.\n- The `triggered` field indicates whether the rule has any currently active alerts.", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-list", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-counter-channel", "metadata": { - "sidebarTitle": "List alert rules" + "sidebarTitle": "Get rule counts by channel" } }, "responses": { @@ -1932,7 +1875,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleBasicListResponse" + "$ref": "#/components/schemas/RuleCounterChannelResponse" } } } @@ -1940,19 +1883,9 @@ }, "example": { "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": [ - { - "id": 50001, - "folder_id": 100, - "name": "CPU High", - "ds_type": "prometheus", - "enabled": true, - "triggered": true, - "created_at": 1710000000, - "active_alert_count": 2, - "runtime_state": "normal" - } - ] + "data": { + "Production": 8 + } } } } @@ -1975,29 +1908,44 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RuleListRequest" + "$ref": "#/components/schemas/RuleEmptyRequest" }, - "example": { - "folder_id": 100 - } + "example": {} } } } } }, - "/monit/store/ruleset/info": { + "/monit/query/data": { "post": { - "operationId": "monit-store-ruleset-info", - "summary": "Get ruleset detail", - "description": "Retrieve the full details of a ruleset including its `payload` (the alert rule definitions as a JSON string).", + "operationId": "monit-read-query-data", + "summary": "Query structured data", + "description": "Run a synchronous ad-hoc query against a configured data source and return a stable `query_result.v1` result whose natural shape is frames, records, or samples. This public API requires monit-edge v0.65.0 or later.", "tags": [ - "Monitors/Rule sets" + "Monitors/Diagnostics" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Read** (`monit`) |", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-info", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **100 requests/minute**; **5 requests/second** per account |\n| Permissions | Any valid `app_key` (read-only; not gated by a specific permission class) |\n| Edge requirement | Supported deployments require **monit-edge v0.65.0 or later** |\n\n## Usage\n\n- Treat **monit-edge v0.65.0** as the minimum supported Edge version for this public API. WebAPI retains migration adapters for older Edge versions: query.v2 results may still preserve frames, records, or samples, while legacy rows can expose only the information they retained. These adapters do not change the support floor; older protocols lack query.v3 cancellation and error-lifecycle semantics, and data already lost by legacy rows cannot be recovered.\n- The public response format is always `query_result.v1` and is independent of the internal Edge query protocol. Dispatch on `result.kind` (`frames`, `records`, or `samples`); do not infer the result shape from `ds_type` or the Edge version.\n- A `frames` result may contain multiple table or time-series frames. Field values are columnar and all fields in one frame have the same length.\n- A `records` result may contain nested JSON and null records. Integer literals outside JavaScript's safe integer range are returned as decimal strings.\n- A `samples` result contains label sets and instant values. A value may be a number or one of the strings `NaN`, `+Inf`, and `-Inf`.\n- The final success response is limited to 8 MiB and query results are limited to 1,000 rows. Narrow the time range, reduce fields, or aggregate at the source when a request exceeds a limit.\n- Query failures use non-2xx HTTP status codes and the standard error envelope. Do not transparently fall back to the deprecated `/monit/query/rows` endpoint.\n- Query execution may take up to 35 seconds across WebAPI forwarding and Edge execution. Configure client timeouts to at least 40 seconds and propagate cancellation when the caller abandons a query.", + "href": "/en/api-reference/monitors/diagnostics/monit-read-query-data", "metadata": { - "sidebarTitle": "Get ruleset detail" + "sidebarTitle": "Query structured data" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueryDataRequest" + }, + "example": { + "ds_type": "prometheus", + "ds_name": "prod-prom", + "expr": "sum by (job) (rate(http_requests_total[5m]))", + "delay_seconds": 0, + "args": {} + } + } } }, "responses": { @@ -2014,7 +1962,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetItem" + "$ref": "#/components/schemas/QueryDataResponse" } } } @@ -2023,16 +1971,18 @@ "example": { "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", "data": { - "id": 1, - "type_ident": "prometheus", - "note": "CPU usage alerts", - "open_flag": 2, - "payload": "[{\"prom_ql\":\"...\"}]", - "creator_account_id": 10023, - "creator_id": 80011, - "creator_name": "Alice", - "created_at": 1710000000, - "updated_at": 1712000000 + "format": "query_result.v1", + "result": { + "kind": "samples", + "samples": [ + { + "labels": { + "job": "api" + }, + "value": 1.25 + } + ] + } } } } @@ -2044,848 +1994,246 @@ "401": { "$ref": "#/components/responses/Unauthorized" }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "413": { + "description": "The request or final response exceeds its size limit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "429": { "$ref": "#/components/responses/TooManyRequests" }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IDRequest" - }, - "example": { - "id": 1 + "499": { + "description": "The client canceled the query.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } - } - } - } - }, - "/monit/store/ruleset/create": { - "post": { - "operationId": "monit-store-ruleset-create", - "summary": "Create ruleset", - "description": "Create a new ruleset in the rule repository.", - "tags": [ - "Monitors/Rule sets" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Manage** (`monit`) |\n\n## Usage\n\n- `open_flag`: `0` = private (creator only), `1` = account-shared, `2` = public.\n- `payload` is a required JSON string containing the alert rule definitions.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-create", - "metadata": { - "sidebarTitle": "Create ruleset" - } - }, - "responses": { - "200": { - "description": "Success", + }, + "500": { + "$ref": "#/components/responses/ServerError" + }, + "503": { + "$ref": "#/components/responses/ServiceUnavailable" + }, + "504": { + "description": "The query timed out.", "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StoreRulesetItem" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "id": 1, - "type_ident": "prometheus", - "note": "CPU usage alerts", - "open_flag": 1, - "created_at": 1712000000, - "updated_at": 1712000000 - } + "$ref": "#/components/schemas/ErrorResponse" } } } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" } - }, + } + } + }, + "/monit/datasource/tools/invoke": { + "post": { + "description": "Execute one deterministic tool against a configured datasource. Requires all currently online routable Edge sessions in the cluster to support the v0.71.0 base invoke protocol; individual tools may require a newer implementation. No tool catalog, automatic replay, or fallback to Agent/legacy diagnose. Request body limit 128 KiB; complete success response limit 1 MiB; tool timeout at most 25 seconds.", + "operationId": "monit-datasource-tools-invoke", "requestBody": { - "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreRulesetUpsertRequest" - }, "example": { - "type_ident": "prometheus", - "note": "CPU usage alerts", - "open_flag": 1, - "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.8\"}]" + "datasource_id": 10, + "params": {}, + "tool": "mysql.overview" + }, + "schema": { + "$ref": "#/components/schemas/DatasourceToolInvokeRequest" } } - } - } - } - }, - "/monit/datasource/list": { - "post": { - "operationId": "monit-datasource-read-list", - "summary": "List datasources", - "description": "Return all data sources for the current account. Optionally filter by `type_ident`. Supports diagnostic types redis_node, redis_sentinel, mongodb_mongod, mongodb_mongos and kafka; enabled and alerting_enabled are independent.", - "tags": [ - "Monitors/Data sources" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Datasources Read** (`monit`) |\n\n## Usage\n\n- Omit `type_ident` to return all types.\n- Sensitive credential fields (passwords, keys) are not returned in the list response.\n\nSee the request/response schemas for all supported types and credential handling. Diagnostic-only types cannot enable alerting. On create omitted enabled defaults to true; on update omission preserves the current value. Explicit null for enabled or alerting_enabled is invalid. Diagnostic passwords and Kafka private keys are omitted from responses unless they are environment references; omit these secrets on update to preserve them, or send an empty string to clear. Other datasource credentials may be returned and must be handled as sensitive.", - "href": "/en/api-reference/monitors/data-sources/monit-datasource-read-list", - "metadata": { - "sidebarTitle": "List datasources" - } + }, + "required": true }, "responses": { "200": { - "description": "Success", "content": { "application/json": { + "example": { + "data": { + "data": { + "version": "8.0.36" + }, + "datasource_id": 10, + "summary": "MySQL overview", + "tool": "mysql.overview" + }, + "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" + }, "schema": { "allOf": [ { "$ref": "#/components/schemas/SuccessEnvelope" }, { - "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DataSourceListResponse" + "$ref": "#/components/schemas/DatasourceToolResult" } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": [ - { - "id": 10, - "account_id": 10023, - "type_ident": "prometheus", - "name": "Prometheus Prod", - "enabled": true, - "note": "Production Prometheus", - "address": "http://prometheus.example.com:9090", - "edge_cluster_name": "default", - "updated_at": 1712000000, - "payload": null, - "alerting_enabled": true + }, + "type": "object" } ] } } - } + }, + "description": "Success" }, "400": { - "$ref": "#/components/responses/BadRequest" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "Standard HTTP error; error.reason: invalid_request, tool_not_supported, datasource_error." }, "401": { "$ref": "#/components/responses/Unauthorized" }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceListRequest" - }, - "example": { - "type": "prometheus" + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - } - } - } - } - }, - "/monit/rule/update/fields": { - "post": { - "operationId": "monit-rule-write-fields-update", - "summary": "Batch update rule fields", - "description": "Update specific fields across multiple alert rules at once. Only the fields listed in `fields` are applied.", - "tags": [ - "Monitors/Alert rules" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Manage** (`monit`) |\n\n## Usage\n\n- Include the field names you want to update in the `fields` array, e.g. `[\"enabled\", \"channel_ids\"]`.\n- Only the specified fields are updated; others are left unchanged.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-write-fields-update", - "metadata": { - "sidebarTitle": "Batch update rule fields" - } - }, - "responses": { - "200": { - "description": "Success", + }, + "description": "Standard HTTP error; error.reason: access_denied." + }, + "404": { "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleNameMessageListResponse" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": [ - { - "name": "CPU High", - "message": "" - }, - { - "name": "Disk High", - "message": "" - } - ] + "$ref": "#/components/schemas/ErrorResponse" } } - } + }, + "description": "Standard HTTP error; error.reason: datasource_not_found." }, - "400": { - "$ref": "#/components/responses/BadRequest" + "409": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "Standard HTTP error; error.reason: datasource_disabled, datasource_in_use." }, - "401": { - "$ref": "#/components/responses/Unauthorized" + "413": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "Standard HTTP error; error.reason: source_too_large, result_too_large." }, "429": { - "$ref": "#/components/responses/TooManyRequests" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "Standard HTTP error; error.reason: overloaded." }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RuleFieldsUpdateRequest" - }, - "example": { - "ids": [ - 50001, - 50002 - ], - "fields": [ - "enabled" - ], - "enabled": false - } - } - } - } - } - }, - "/monit/rule/counter/channel": { - "post": { - "operationId": "monit-rule-read-counter-channel", - "summary": "Get rule counts by channel", - "description": "Return an object mapping channel name to the number of rules routing alerts to that channel. If a channel name cannot be resolved, the channel ID (as a string) is used as the key.", - "tags": [ - "Monitors/Alert rules" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-counter-channel", - "metadata": { - "sidebarTitle": "Get rule counts by channel" - } - }, - "responses": { - "200": { - "description": "Success", + "499": { "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCounterChannelResponse" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "Production": 8 - } + "$ref": "#/components/schemas/ErrorResponse" } } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" + }, + "description": "Standard HTTP error; error.reason: canceled." }, "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RuleEmptyRequest" - }, - "example": {} - } - } - } - } - }, - "/monit/query/data": { - "post": { - "operationId": "monit-read-query-data", - "summary": "Query structured data", - "description": "Run a synchronous ad-hoc query against a configured data source and return a stable `query_result.v1` result whose natural shape is frames, records, or samples. This public API requires monit-edge v0.65.0 or later.", - "tags": [ - "Monitors/Diagnostics" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **100 requests/minute**; **5 requests/second** per account |\n| Permissions | Any valid `app_key` (read-only; not gated by a specific permission class) |\n| Edge requirement | Supported deployments require **monit-edge v0.65.0 or later** |\n\n## Usage\n\n- Treat **monit-edge v0.65.0** as the minimum supported Edge version for this public API. WebAPI retains migration adapters for older Edge versions: query.v2 results may still preserve frames, records, or samples, while legacy rows can expose only the information they retained. These adapters do not change the support floor; older protocols lack query.v3 cancellation and error-lifecycle semantics, and data already lost by legacy rows cannot be recovered.\n- The public response format is always `query_result.v1` and is independent of the internal Edge query protocol. Dispatch on `result.kind` (`frames`, `records`, or `samples`); do not infer the result shape from `ds_type` or the Edge version.\n- A `frames` result may contain multiple table or time-series frames. Field values are columnar and all fields in one frame have the same length.\n- A `records` result may contain nested JSON and null records. Integer literals outside JavaScript's safe integer range are returned as decimal strings.\n- A `samples` result contains label sets and instant values. A value may be a number or one of the strings `NaN`, `+Inf`, and `-Inf`.\n- The final success response is limited to 8 MiB and query results are limited to 1,000 rows. Narrow the time range, reduce fields, or aggregate at the source when a request exceeds a limit.\n- Query failures use non-2xx HTTP status codes and the standard error envelope. Do not transparently fall back to the deprecated `/monit/query/rows` endpoint.\n- Query execution may take up to 35 seconds across WebAPI forwarding and Edge execution. Configure client timeouts to at least 40 seconds and propagate cancellation when the caller abandons a query.", - "href": "/en/api-reference/monitors/diagnostics/monit-read-query-data", - "metadata": { - "sidebarTitle": "Query structured data" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QueryDataRequest" - }, - "example": { - "ds_type": "prometheus", - "ds_name": "prod-prom", - "expr": "sum by (job) (rate(http_requests_total[5m]))", - "delay_seconds": 0, - "args": {} - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QueryDataResponse" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "format": "query_result.v1", - "result": { - "kind": "samples", - "samples": [ - { - "labels": { - "job": "api" - }, - "value": 1.25 - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "413": { - "description": "The request or final response exceeds its size limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } - } - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" + }, + "description": "Standard HTTP error; error.reason: internal." }, - "499": { - "description": "The client canceled the query.", + "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } - } - }, - "500": { - "$ref": "#/components/responses/ServerError" - }, - "503": { - "$ref": "#/components/responses/ServiceUnavailable" + }, + "description": "Standard HTTP error; error.reason: no_active_edge, edge_upgrade_required, mixed_edge_versions." }, "504": { - "description": "The query timed out.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } - } + }, + "description": "Standard HTTP error; error.reason: timeout." } - } - } - }, - "/monit/query/diagnose": { - "post": { - "operationId": "monit-read-query-diagnose", - "summary": "Diagnose data source", - "description": "Run a synchronous diagnostic query (`log_patterns` for Loki/VictoriaLogs, `metric_trends` for Prometheus). Used by Flashduty AI SRE for log-pattern clustering and time-series trend analysis. Long-running — up to 35 s.\n\nDeprecated: migrate to /monit/datasource/tools/invoke with prometheus.metric_trends, loki.log_patterns or victorialogs.log_patterns. Retained for existing consumers; the legacy request and response remain unchanged.", + }, + "summary": "Invoke datasource tool", "tags": [ - "Monitors/Diagnostics" + "Monitors/Data sources" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **600 requests/minute**; **10 requests/second** per account |\n| Permissions | Any valid `app_key` (read-only; not gated by a specific permission class) |\n\n## Usage\n\n- This is a diagnostic / RCA endpoint, not a raw data query — pair it with `/monit/query/data` when you need the underlying data.\n- Only three `ds_type` and `operation` pairs are supported: `loki` / `victorialogs` → `log_patterns`, and `prometheus` → `metric_trends`. Every other datasource is rejected, even when `operation` is explicit.\n- `methods` selects the analyses to run; when omitted, `log_patterns` defaults to `pattern_snapshot + pattern_compare(previous_window)` and `metric_trends` defaults to `single_window_shape + window_compare(previous_window)`.\n- `time_range` is in Unix seconds; missing or invalid values default to the last 15 minutes; a window wider than 6 hours is rejected.\n- The request is forwarded over WebSocket to `monit-edge`. Long-running: the request may take up to ~30 s on the edge side plus webapi overhead. Set client timeouts to **at least 35 s**.\n- `options.*` are upper-bounded by edge (`max_logs_scanned` ≤ 50 000, `max_patterns` ≤ 50, `examples_per_pattern` ≤ 3, `step_seconds` ∈ [15, 300], `max_series` ≤ 200, `topk` ≤ 50, `timeout_seconds` ≤ 30).\n- The success body is a raw `{\"data\": ...}` object WITHOUT the usual `request_id` wrapper field (raw passthrough from the edge).\n- Two error layers: request-level failures return a non-200 status with the standard `error` envelope, while edge-level execution errors come back as HTTP 200 with an `error` object in the body — check both.\n- Log examples are basic-redacted before being returned; expect `warnings: [\"examples redacted\"]`. Do not treat them as raw logs.", - "href": "/en/api-reference/monitors/diagnostics/monit-read-query-diagnose", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **2,000 requests/minute**; **32 requests/second** per account |\n| Permissions | **Datasources Read** (`monit`) |\n\nUse datasource IDs from `/monit/datasource/list`. Disabled datasources return `datasource_disabled`; `alerting_enabled=false` does not block tools. Errors use non-2xx HTTP status and `error.code`, `error.message`, `error.reason`. `tool_not_supported` indicates the selected executor does not provide this tool; it is not a vendor permission error. Never retry through another Edge or the legacy diagnose endpoint automatically.", + "href": "/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke", "metadata": { - "sidebarTitle": "Diagnose data source" + "sidebarTitle": "Invoke datasource tool" } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DiagnoseRequest" - }, - "example": { - "account_id": 10001, - "ds_type": "victorialogs", - "ds_name": "vmlogs-read", - "operation": "log_patterns", - "time_range": { - "start": 1776847544, - "end": 1776849344 - }, - "methods": [ - { - "name": "pattern_snapshot" - }, - { - "name": "pattern_compare", - "baseline": "same_window_yesterday" - } - ], - "input": { - "query": "_stream:{status='500'}" - }, - "options": { - "max_logs_scanned": 10000, - "max_patterns": 20, - "examples_per_pattern": 2, - "timeout_seconds": 25 - } - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DiagnoseResponse" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "schema_version": "2", - "operation": "log_patterns", - "ds_type": "loki", - "ds_name": "prod-loki", - "query": "{service=\"checkout\"}", - "window": { - "start": "2026-07-14T06:00:00Z", - "end": "2026-07-14T07:00:00Z" - }, - "data_handling": { - "log_redaction_applied": true, - "log_redaction_coverage": "best_effort", - "untrusted_data_fields": [ - "pattern_template", - "current_window.sources[].value", - "redacted_log_examples[]" - ] - }, - "results": [ - { - "method": "pattern_compare", - "baseline": "previous_window", - "window": { - "start": "2026-07-14T06:00:00Z", - "end": "2026-07-14T07:00:00Z" - }, - "baseline_window": { - "start": "2026-07-14T05:00:00Z", - "end": "2026-07-14T06:00:00Z" - }, - "summary": { - "current_sample": { - "logs_scanned": 10000, - "patterns_aggregated": 18, - "logs_not_aggregated_due_to_cluster_limit": 0, - "pattern_matching_limited": false, - "truncated": false - }, - "baseline_sample": { - "logs_scanned": 8000, - "patterns_aggregated": 20, - "logs_not_aggregated_due_to_cluster_limit": 0, - "pattern_matching_limited": false, - "truncated": false - }, - "patterns_aggregated_only_in_baseline_sample": 2, - "aggregated_pattern_evidence_total": 20, - "pattern_evidence_returned": 1, - "pattern_evidence_truncated_by_max_patterns": true, - "evidence_summary": "1 of 20 pattern evidence items are returned." - }, - "pattern_evidence": [ - { - "pattern_id": "8f1496a85df86ca1", - "pattern_template": "checkout request <*> failed", - "comparison_status": "comparable", - "current_window": { - "count": 12, - "share_of_scanned_logs": 0.0012, - "first_seen": "2026-07-14T06:03:00Z", - "last_seen": "2026-07-14T06:58:00Z", - "observed_severity_counts": { - "error": 12 - } - }, - "baseline_window": { - "count": 2, - "share_of_scanned_logs": 0.00025, - "first_seen": "2026-07-14T05:11:00Z", - "last_seen": "2026-07-14T05:44:00Z", - "observed_severity_counts": { - "error": 2 - } - }, - "observations": [ - "The current-sample count was 12 and the baseline-sample count was 2." - ], - "redacted_log_examples": [ - "checkout request failed" - ] - } - ], - "warnings": [] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "deprecated": true - } - }, - "/monit/datasource/tools/invoke": { - "post": { - "description": "Execute one deterministic tool against a configured datasource. Requires all currently online routable Edge sessions in the cluster to support the v0.71.0 base invoke protocol; individual tools may require a newer implementation. No tool catalog, automatic replay, or fallback to Agent/legacy diagnose. Request body limit 128 KiB; complete success response limit 1 MiB; tool timeout at most 25 seconds.", - "operationId": "monit-datasource-tools-invoke", - "requestBody": { - "content": { - "application/json": { - "example": { - "datasource_id": 10, - "params": {}, - "tool": "mysql.overview" - }, - "schema": { - "$ref": "#/components/schemas/DatasourceToolInvokeRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "data": { - "version": "8.0.36" - }, - "datasource_id": 10, - "summary": "MySQL overview", - "tool": "mysql.overview" - }, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/DatasourceToolResult" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "Success" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: invalid_request, tool_not_supported, datasource_error." - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: access_denied." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: datasource_not_found." - }, - "409": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: datasource_disabled, datasource_in_use." - }, - "413": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: source_too_large, result_too_large." - }, - "429": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: overloaded." - }, - "499": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: canceled." - }, - "500": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: internal." - }, - "503": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: no_active_edge, edge_upgrade_required, mixed_edge_versions." - }, - "504": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "Standard HTTP error; error.reason: timeout." - } - }, - "summary": "Invoke datasource tool", - "tags": [ - "Monitors/Data sources" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **2,000 requests/minute**; **32 requests/second** per account |\n| Permissions | **Datasources Read** (`monit`) |\n\nUse datasource IDs from `/monit/datasource/list`. Disabled datasources return `datasource_disabled`; `alerting_enabled=false` does not block tools. Errors use non-2xx HTTP status and `error.code`, `error.message`, `error.reason`. `tool_not_supported` indicates the selected executor does not provide this tool; it is not a vendor permission error. Never retry through another Edge or the legacy diagnose endpoint automatically.", - "href": "/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke", - "metadata": { - "sidebarTitle": "Invoke datasource tool" - } - } - } - } - }, - "components": { - "securitySchemes": { - "AppKeyAuth": { - "type": "apiKey", - "in": "query", - "name": "app_key", - "description": "App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account." - } - }, - "responses": { - "BadRequest": { - "description": "Invalid request — usually a missing or malformed parameter.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - }, - "examples": { - "missingParameter": { - "value": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "error": { - "code": "InvalidParameter", - "message": "The specified parameter is not valid." + } + } + } + }, + "components": { + "securitySchemes": { + "AppKeyAuth": { + "type": "apiKey", + "in": "query", + "name": "app_key", + "description": "App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account." + } + }, + "responses": { + "BadRequest": { + "description": "Invalid request — usually a missing or malformed parameter.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "missingParameter": { + "value": { + "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", + "error": { + "code": "InvalidParameter", + "message": "The specified parameter is not valid." } } } @@ -3561,36 +2909,6 @@ "updated_at" ] }, - "AlertRuleStatus": { - "type": "object", - "description": "Rule trigger status for a folder node.", - "required": [ - "folder_id", - "rule_total", - "triggered_rule_count" - ], - "properties": { - "folder_id": { - "type": "integer", - "format": "uint64", - "description": "ID of the folder (grouping node)." - }, - "folder_name": { - "type": "string", - "description": "Folder name; omitted by some endpoints (`omitempty`)." - }, - "rule_total": { - "type": "integer", - "format": "int64", - "description": "Total rules in the folder family." - }, - "triggered_rule_count": { - "type": "integer", - "format": "int64", - "description": "Rules with active alerts." - } - } - }, "DSClickHouseConfig": { "type": "object", "description": "ClickHouse datasource configuration. TLS fields are inherited from TLSClientConfig.", @@ -4290,7 +3608,7 @@ }, "name": { "type": "string", - "description": "Datasource display name. This is the name referenced as `ds_name` in query and diagnose APIs." + "description": "Datasource display name. This is the name referenced as `ds_name` in query APIs." }, "note": { "type": "string", @@ -4854,1489 +4172,532 @@ "enabled_times": { "type": "array", "items": { - "$ref": "#/components/schemas/EnabledTime" - }, - "description": "Time windows during which the rule is in effect; element structure see `EnabledTime`. Effective only when `fields` includes `enabled_times`." - }, - "annotations": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Annotation key-value pairs delivered with alert events; keys must not start with `$` (reserved for query fields). Effective only when `fields` includes `annotations`." - }, - "description": { - "type": "string", - "description": "Rule description (Markdown). Effective only when `fields` includes `description`." - }, - "channel_ids": { - "type": "array", - "items": { - "type": "integer", - "format": "uint64" - }, - "description": "IDs of the collaboration spaces alerts are sent to; may be empty. Effective only when `fields` includes `channel_ids`." - }, - "repeat_interval": { - "type": "integer", - "format": "int64", - "description": "Interval in seconds between repeated alert notifications. Effective only when `fields` includes `repeat_interval`." - }, - "repeat_total": { - "type": "integer", - "format": "int64", - "description": "Maximum number of repeated notifications. Effective only when `fields` includes `repeat_total`." - }, - "labels_patch": { - "$ref": "#/components/schemas/StringMapPatch", - "description": "Partial label update. Effective only when `fields` includes `labels`; takes precedence over `labels` when both are sent." - }, - "annotations_patch": { - "$ref": "#/components/schemas/StringMapPatch", - "description": "Partial annotation update. Effective only when `fields` includes `annotations`; takes precedence over `annotations` when both are sent." - } - } - }, - "RuleIDRequest": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "Alert rule ID. Obtainable per folder via `POST /monit/rule/list/basic`." - } - } - }, - "AuditRecordIDRequest": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "Audit record ID — the `id` of an audit row returned by `POST /monit/rule/audits`, NOT the rule ID. Passing a rule ID returns HTTP 400." - } - } - }, - "RuleIDsRequest": { - "type": "object", - "required": [ - "ids" - ], - "properties": { - "ids": { - "type": "array", - "items": { - "type": "integer", - "format": "uint64" - }, - "description": "Rule IDs." - } - } - }, - "RuleImportRequest": { - "type": "array", - "description": "Array of alert rule export objects to import.", - "items": { - "$ref": "#/components/schemas/AlertRule" - } - }, - "RuleImportResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NameMessage" - }, - "description": "Import result for each rule." - }, - "RuleListRequest": { - "type": "object", - "description": "Filter parameter for listing rules in a folder.", - "properties": { - "folder_id": { - "type": "integer", - "format": "uint64", - "description": "Folder ID. Must be an existing folder; `0` is rejected with a `folder_not_found` error." - }, - "include_descendants": { - "type": "boolean", - "description": "Also include rules from all descendant folders. When `true`, each returned item carries only `id`, `folder_id` and `name`; combine with `query` / `limit` for rule-picker scenarios." - }, - "query": { - "type": "string", - "description": "Rule name fuzzy filter; only effective when `include_descendants` is `true`." - }, - "limit": { - "type": "integer", - "default": 50, - "maximum": 100, - "description": "Max number of rules returned; only effective when `include_descendants` is `true`. Defaults to 50, capped at 100." - } - } - }, - "RuleMoveRequest": { - "type": "object", - "required": [ - "ids", - "dest_folder_id" - ], - "properties": { - "ids": { - "type": "array", - "items": { - "type": "integer", - "format": "uint64" - }, - "description": "Rule IDs to move." - }, - "dest_folder_id": { - "type": "integer", - "format": "uint64", - "description": "Destination folder ID. Obtainable via `POST /monit/folder/list`." - } - } - }, - "RuleNameMessageListResponse": { - "type": "array", - "description": "Per-rule batch-operation results.", - "items": { - "$ref": "#/components/schemas/NameMessage" - } - }, - "RuleStatusResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AlertRuleStatus" - } - }, - "SLSLogstoresRequest": { - "type": "object", - "description": "Parameters for listing SLS logstores.", - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "ID of an SLS-type datasource. Obtainable via `POST /monit/datasource/list`." - }, - "project": { - "type": "string", - "description": "SLS project name. Obtainable via `POST /monit/datasource/sls/projects`." - }, - "offset": { - "type": "integer", - "description": "Pagination offset." - }, - "size": { - "type": "integer", - "description": "Page size. Defaults to 200 server-side when 0." - } - }, - "required": [ - "id" - ] - }, - "SLSLogstoresResponse": { - "type": "array", - "description": "List of SLS logstore names.", - "items": { - "type": "string" - } - }, - "SLSProjectsRequest": { - "type": "object", - "description": "Parameters for listing SLS projects.", - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "ID of an SLS-type datasource. Obtainable via `POST /monit/datasource/list`." - }, - "query": { - "type": "string", - "description": "Fuzzy filter on project description (maps to the `description` parameter of Aliyun SLS ListProject). Leave empty to return all." - }, - "offset": { - "type": "integer", - "description": "Pagination offset." - }, - "size": { - "type": "integer", - "description": "Page size. Defaults to 200 server-side when 0." - } - }, - "required": [ - "id" - ] - }, - "SLSProjectsResponse": { - "type": "object", - "description": "A page of Aliyun SLS projects.", - "required": [ - "projects", - "count", - "total" - ], - "properties": { - "projects": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SLSProject" - }, - "description": "Projects in the current page." - }, - "count": { - "type": "integer", - "description": "Number of projects in this page." - }, - "total": { - "type": "integer", - "description": "Total number of projects matching `query`, independent of pagination." - } - } - }, - "StoreRulesetItem": { - "type": "object", - "description": "A rule repository ruleset.", - "required": [ - "id", - "type_ident", - "note", - "open_flag", - "creator_account_id", - "creator_id", - "creator_name", - "created_at", - "updated_at" - ], - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "Ruleset ID." - }, - "type_ident": { - "type": "string", - "description": "Datasource type identifier this ruleset applies to." - }, - "note": { - "type": "string", - "description": "Description or title of the ruleset." - }, - "open_flag": { - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "description": "Sharing scope. `0` = private (visible to the creator and the account owner), `1` = account-shared, `2` = public." - }, - "payload": { - "type": "string", - "description": "JSON string containing the alert rule definitions. Omitted in list responses." - }, - "creator_account_id": { - "type": "integer", - "format": "uint64", - "description": "Account ID of the creator." - }, - "creator_id": { - "type": "integer", - "format": "uint64", - "description": "Member ID of the creator." - }, - "creator_name": { - "type": "string", - "description": "Display name of the creator." - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "Creation timestamp, Unix epoch seconds." - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "Last update timestamp, Unix epoch seconds." - } - } - }, - "StoreRulesetListRequest": { - "type": "object", - "required": [ - "type_ident" - ], - "description": "Filter rulesets by datasource type.", - "properties": { - "type_ident": { - "type": "string", - "description": "Datasource type identifier to filter by, e.g. `prometheus`." - } - } - }, - "StoreRulesetListResponse": { - "type": "array", - "description": "Rulesets accessible to the current user. The `payload` field is omitted.", - "items": { - "$ref": "#/components/schemas/StoreRulesetItem" - } - }, - "StoreRulesetUpdateRequest": { - "type": "object", - "required": [ - "id", - "note", - "payload" - ], - "description": "Parameters for updating a ruleset.", - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "Ruleset ID to update." - }, - "note": { - "type": "string", - "description": "New description." - }, - "open_flag": { - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "description": "New sharing scope. `0` = private (visible to the creator and the account owner), `1` = account-shared, `2` = public." - }, - "payload": { - "type": "string", - "description": "New JSON string of alert rule definitions." - } - } - }, - "StoreRulesetUpsertRequest": { - "type": "object", - "description": "Request body for creating a ruleset. All fields are validated by `Validate()` on the server.", - "required": [ - "type_ident", - "note", - "payload" - ], - "properties": { - "type_ident": { - "type": "string", - "description": "Datasource type identifier this ruleset applies to, e.g. `prometheus`." - }, - "note": { - "type": "string", - "description": "Description or title of the ruleset." - }, - "open_flag": { - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "description": "Sharing scope. `0` = private (visible to the creator and the account owner), `1` = account-shared, `2` = public. Defaults to `0` if omitted." - }, - "payload": { - "type": "string", - "description": "JSON string containing the alert rule definitions." - } - } - }, - "SuccessEnvelope": { - "type": "object", - "description": "Success response envelope. On every 2xx response, `request_id` identifies the call (also mirrored in the `Flashcat-Request-Id` header) and `data` holds the endpoint-specific payload. Failure responses use a different shape — see `ErrorResponse`.", - "properties": { - "request_id": { - "type": "string", - "description": "Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.", - "example": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "data": { - "description": "Endpoint-specific payload. See each operation's 200 response schema." - } - }, - "required": [ - "request_id", - "data" - ] - }, - "QueryDataRequest": { - "description": "Request for the stable structured query endpoint. It accepts the same query fields as the retired rows endpoint.", - "allOf": [ - { - "$ref": "#/components/schemas/QueryRowsRequest" - } - ] - }, - "QueryDataResponse": { - "type": "object", - "description": "Stable, Edge-version-independent structured query response.", - "required": [ - "format", - "result" - ], - "properties": { - "format": { - "type": "string", - "enum": [ - "query_result.v1" - ], - "description": "Public result-contract version. It is independent of the internal monit-edge query protocol version. Fixed at `query_result.v1`, which defines the structure of the `result` field." - }, - "result": { - "$ref": "#/components/schemas/QueryResult" - } - } - }, - "QueryResult": { - "description": "Exactly one natural result shape, selected by `kind`.", - "oneOf": [ - { - "$ref": "#/components/schemas/QueryFramesResult" - }, - { - "$ref": "#/components/schemas/QueryRecordsResult" - }, - { - "$ref": "#/components/schemas/QuerySamplesResult" - } - ], - "discriminator": { - "propertyName": "kind", - "mapping": { - "frames": "#/components/schemas/QueryFramesResult", - "records": "#/components/schemas/QueryRecordsResult", - "samples": "#/components/schemas/QuerySamplesResult" - } - } - }, - "QueryFramesResult": { - "type": "object", - "required": [ - "kind", - "frames" - ], - "properties": { - "kind": { - "type": "string", - "enum": [ - "frames" - ], - "description": "Result-kind discriminator, always `frames`, indicating the `frames` payload of typed table/time-series frames." - }, - "frames": { - "type": "array", - "description": "Typed table or time-series frames. A response can contain more than one frame.", - "items": { - "$ref": "#/components/schemas/QueryFrame" - } - } - } - }, - "QueryFrame": { - "type": "object", - "description": "A typed, columnar table or time-series frame. All fields in one frame have the same number of values. A `time_series` frame contains one time field and one float field; labels belong to the float field.", - "required": [ - "kind", - "fields" - ], - "properties": { - "kind": { - "type": "string", - "enum": [ - "table", - "time_series" - ], - "description": "Frame type: `table` for a generic table, `time_series` for a series (exactly one time field and one float field)." - }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryField" - }, - "description": "Columns of the frame; all fields share the same `values` length and row i is composed of each field's `values[i]`." - } - } - }, - "QueryField": { - "type": "object", - "description": "One typed column. `string` fields contain string or null values; `time` fields contain RFC 3339 Nano strings or null; `float` fields contain numbers, null, or the special strings `NaN`, `+Inf`, and `-Inf`.", - "required": [ - "name", - "type", - "values" - ], - "properties": { - "name": { - "type": "string", - "description": "Column name; on a time-series float field, series are distinguished by `labels` and `name` is usually the metric name." - }, - "type": { - "type": "string", - "enum": [ - "string", - "float", - "time" - ], - "description": "Value type governing `values` encoding: `string` = strings or null, `float` = numbers or `NaN`/`±Inf` strings or null, `time` = RFC 3339 Nano strings or null." + "$ref": "#/components/schemas/EnabledTime" + }, + "description": "Time windows during which the rule is in effect; element structure see `EnabledTime`. Effective only when `fields` includes `enabled_times`." }, - "labels": { + "annotations": { "type": "object", - "description": "Series labels. Present on the float field of a time-series frame.", "additionalProperties": { "type": "string" - } + }, + "description": "Annotation key-value pairs delivered with alert events; keys must not start with `$` (reserved for query fields). Effective only when `fields` includes `annotations`." }, - "values": { + "description": { + "type": "string", + "description": "Rule description (Markdown). Effective only when `fields` includes `description`." + }, + "channel_ids": { "type": "array", "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ] + "type": "integer", + "format": "uint64" }, - "description": "All values of this column in row order; length matches the other fields in the frame." + "description": "IDs of the collaboration spaces alerts are sent to; may be empty. Effective only when `fields` includes `channel_ids`." + }, + "repeat_interval": { + "type": "integer", + "format": "int64", + "description": "Interval in seconds between repeated alert notifications. Effective only when `fields` includes `repeat_interval`." + }, + "repeat_total": { + "type": "integer", + "format": "int64", + "description": "Maximum number of repeated notifications. Effective only when `fields` includes `repeat_total`." + }, + "labels_patch": { + "$ref": "#/components/schemas/StringMapPatch", + "description": "Partial label update. Effective only when `fields` includes `labels`; takes precedence over `labels` when both are sent." + }, + "annotations_patch": { + "$ref": "#/components/schemas/StringMapPatch", + "description": "Partial annotation update. Effective only when `fields` includes `annotations`; takes precedence over `annotations` when both are sent." } } }, - "QueryRecordsResult": { + "RuleIDRequest": { "type": "object", "required": [ - "kind", - "records" + "id" ], "properties": { - "kind": { - "type": "string", - "enum": [ - "records" - ], - "description": "Result-kind discriminator, always `records`, indicating the `records` payload of schemaless record objects." - }, - "records": { - "type": "array", - "description": "Schema-flexible records. Records may have different fields, contain nested JSON, or be null. Integers outside JavaScript's safe range are encoded as decimal strings.", - "items": { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "null" - } - ] - } + "id": { + "type": "integer", + "format": "uint64", + "description": "Alert rule ID. Obtainable per folder via `POST /monit/rule/list/basic`." } } }, - "QuerySamplesResult": { + "AuditRecordIDRequest": { "type": "object", "required": [ - "kind", - "samples" + "id" ], "properties": { - "kind": { - "type": "string", - "enum": [ - "samples" - ], - "description": "Result-kind discriminator, always `samples`, indicating the `samples` payload of labeled instant samples." - }, - "samples": { - "type": "array", - "description": "Instant samples with their complete label sets.", - "items": { - "$ref": "#/components/schemas/QuerySample" - } + "id": { + "type": "integer", + "format": "uint64", + "description": "Audit record ID — the `id` of an audit row returned by `POST /monit/rule/audits`, NOT the rule ID. Passing a rule ID returns HTTP 400." } } }, - "QuerySample": { + "RuleIDsRequest": { "type": "object", "required": [ - "labels", - "value" + "ids" ], "properties": { - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" + "ids": { + "type": "array", + "items": { + "type": "integer", + "format": "uint64" }, - "description": "The sample's full label set; may be an empty object but is always present." - }, - "value": { - "description": "Finite numeric value or a JSON-safe representation of a non-finite float.", - "oneOf": [ - { - "type": "number" - }, - { - "type": "string", - "enum": [ - "NaN", - "+Inf", - "-Inf" - ] - } - ] + "description": "Rule IDs." } } }, - "QueryRowsRequest": { - "type": "object", - "required": [ - "ds_type", - "ds_name", - "expr" - ], - "properties": { - "account_id": { - "type": "integer", - "format": "int64", - "description": "Optional consistency check. Must equal the authenticated account when supplied; mismatched values are rejected. Business execution always uses the authenticated account." - }, - "ds_type": { - "type": "string", - "description": "Data source type; must match a configured data source under the tenant. Examples: `prometheus`, `loki`, `victorialogs`, `sls`, `elasticsearch`, `mysql`, `postgres`, `oracle`, `clickhouse`." - }, - "ds_name": { - "type": "string", - "description": "Data source name; must match a configured data source under the tenant." - }, - "expr": { - "type": "string", - "description": "Query expression. Syntax depends on `ds_type` and is interpreted by the corresponding monit-edge client (PromQL for Prometheus, LogQL for Loki, SQL for SQL sources, etc.)." - }, - "delay_seconds": { - "type": "integer", - "description": "Look-back offset in seconds applied to point-in-time queries (Prometheus, Loki stats, VictoriaLogs stats). Ignored for raw / detail queries.", - "default": 0 - }, - "args": { - "type": "object", - "description": "Polymorphic key/value extension parameters forwarded verbatim to monit-edge. All values must be strings, and keys are always namespaced by source (e.g. `sls.project`, `loki.type`). Validation depends on `ds_type`: SLS requires `sls.project` + `sls.logstore`. Elasticsearch accepts `es.type` of `sql`, or omitted — any other value is rejected. Loki and VictoriaLogs accept `.type` of `stats`, `raw`, or omitted; `raw` additionally requires a time range, either `.start` + `.end` or `.timespan.value` + `.timespan.unit` (unit one of `s`, `m`, `h`, `d`). Prometheus and the remaining SQL sources ignore `args` entirely.", - "additionalProperties": { - "type": "string" - } - } + "RuleImportRequest": { + "type": "array", + "description": "Array of alert rule export objects to import.", + "items": { + "$ref": "#/components/schemas/AlertRule" } }, - "DiagnoseRequest": { + "RuleImportResponse": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NameMessage" + }, + "description": "Import result for each rule." + }, + "RuleListRequest": { "type": "object", - "required": [ - "ds_type", - "ds_name", - "input" - ], + "description": "Filter parameter for listing rules in a folder.", "properties": { - "account_id": { + "folder_id": { "type": "integer", - "format": "int64", - "description": "Optional consistency check. Must equal the authenticated account when supplied." - }, - "ds_type": { - "type": "string", - "description": "Data source type. `log_patterns` supports `loki` and `victorialogs`; `metric_trends` supports `prometheus`." - }, - "ds_name": { - "type": "string", - "description": "Data source name configured under the tenant." - }, - "operation": { - "type": "string", - "enum": [ - "log_patterns", - "metric_trends" - ], - "description": "Diagnostic operation. When omitted, inferred from `ds_type` (loki / victorialogs → `log_patterns`, prometheus → `metric_trends`). Other sources must specify explicitly." - }, - "time_range": { - "type": "object", - "description": "Diagnostic window in Unix seconds. Defaults to the last 15 minutes when missing or invalid; windows wider than 6 hours are rejected.", - "properties": { - "start": { - "type": "integer", - "format": "int64", - "description": "Window start, Unix seconds." - }, - "end": { - "type": "integer", - "format": "int64", - "description": "Window end, Unix seconds." - } - } - }, - "methods": { - "type": "array", - "description": "Diagnostic methods to run. When omitted, `log_patterns` defaults to `pattern_snapshot + pattern_compare(previous_window)` and `metric_trends` defaults to `single_window_shape + window_compare(previous_window)`.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "`log_patterns` supports `pattern_snapshot`, `pattern_compare`. `metric_trends` supports `single_window_shape`, `window_compare`." - }, - "baseline": { - "type": "string", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "description": "Only meaningful for compare-style methods. Defaults to `previous_window`. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days." - } - } - } - }, - "input": { - "type": "object", - "required": [ - "query" - ], - "properties": { - "query": { - "type": "string", - "description": "Query expression. LogQL / VictoriaLogs query syntax for `log_patterns`; PromQL for `metric_trends`." - } - }, - "description": "Diagnose input. `query` is required: LogQL / VictoriaLogs query syntax for `log_patterns`; PromQL for `metric_trends`." + "format": "uint64", + "description": "Folder ID. Must be an existing folder; `0` is rejected with a `folder_not_found` error." }, - "options": { - "type": "object", - "description": "Execution options, all upper-bounded by monit-edge.", - "properties": { - "max_logs_scanned": { - "type": "integer", - "description": "Per-window log scan cap. Default 10 000, hard max 50 000." - }, - "max_patterns": { - "type": "integer", - "description": "Max patterns returned. Default 20, hard max 50." - }, - "examples_per_pattern": { - "type": "integer", - "description": "Max redacted examples per pattern. Default 2, hard max 3." - }, - "step_seconds": { - "type": "integer", - "description": "`metric_trends` query_range step. Default 60, range [15, 300]." - }, - "max_series": { - "type": "integer", - "description": "`metric_trends` max series considered. Default 50, hard max 200." - }, - "topk": { - "type": "integer", - "description": "`metric_trends` max notable series returned. Default 10, hard max 50." - }, - "timeout_seconds": { - "type": "integer", - "description": "Edge-side diagnostic timeout in seconds. Default 25, hard max 30." - } - } - } - } - }, - "DiagnoseResponse": { - "description": "Schema v2 diagnostic evidence selected by `operation`. Inspect `operation` first, then handle the log-pattern or metric-trend evidence selected by each `results[].method`.", - "oneOf": [ - { - "$ref": "#/components/schemas/DiagnoseLogPatternResponse" + "include_descendants": { + "type": "boolean", + "description": "Also include rules from all descendant folders. When `true`, each returned item carries only `id`, `folder_id` and `name`; combine with `query` / `limit` for rule-picker scenarios." }, - { - "$ref": "#/components/schemas/DiagnoseMetricTrendResponse" - } - ], - "discriminator": { - "propertyName": "operation", - "mapping": { - "log_patterns": "#/components/schemas/DiagnoseLogPatternResponse", - "metric_trends": "#/components/schemas/DiagnoseMetricTrendResponse" + "query": { + "type": "string", + "description": "Rule name fuzzy filter; only effective when `include_descendants` is `true`." + }, + "limit": { + "type": "integer", + "default": 50, + "maximum": 100, + "description": "Max number of rules returned; only effective when `include_descendants` is `true`. Defaults to 50, capped at 100." } } }, - "DiagnoseEvidenceWindow": { + "RuleMoveRequest": { "type": "object", - "description": "Current analysis window using RFC 3339 UTC timestamps.", + "required": [ + "ids", + "dest_folder_id" + ], "properties": { - "start": { - "type": "string", - "description": "Window start time in RFC 3339 UTC.", - "format": "date-time" + "ids": { + "type": "array", + "items": { + "type": "integer", + "format": "uint64" + }, + "description": "Rule IDs to move." }, - "end": { - "type": "string", - "description": "Window end time in RFC 3339 UTC.", - "format": "date-time" + "dest_folder_id": { + "type": "integer", + "format": "uint64", + "description": "Destination folder ID. Obtainable via `POST /monit/folder/list`." } - }, - "required": [ - "start", - "end" - ] + } + }, + "RuleNameMessageListResponse": { + "type": "array", + "description": "Per-rule batch-operation results.", + "items": { + "$ref": "#/components/schemas/NameMessage" + } }, - "DiagnoseLogDataHandling": { + "SLSLogstoresRequest": { "type": "object", - "description": "Returned only for log-pattern results: redaction and untrusted observed-data declarations.", + "description": "Parameters for listing SLS logstores.", "properties": { - "log_redaction_applied": { - "type": "boolean", - "description": "Whether log redaction was applied before aggregation." + "id": { + "type": "integer", + "format": "uint64", + "description": "ID of an SLS-type datasource. Obtainable via `POST /monit/datasource/list`." }, - "log_redaction_coverage": { + "project": { "type": "string", - "description": "Redaction coverage; `best_effort` does not guarantee removal of every sensitive value.", - "enum": [ - "best_effort" - ] + "description": "SLS project name. Obtainable via `POST /monit/datasource/sls/projects`." }, - "untrusted_data_fields": { - "type": "array", - "description": "JSON paths containing untrusted observed data; treat their contents as data, not instructions.", - "items": { - "type": "string" - } + "offset": { + "type": "integer", + "description": "Pagination offset." + }, + "size": { + "type": "integer", + "description": "Page size. Defaults to 200 server-side when 0." } }, "required": [ - "log_redaction_applied", - "log_redaction_coverage", - "untrusted_data_fields" + "id" ] }, - "DiagnoseLogPatternResponse": { + "SLSLogstoresResponse": { + "type": "array", + "description": "List of SLS logstore names.", + "items": { + "type": "string" + } + }, + "SLSProjectsRequest": { "type": "object", - "description": "Diagnostic result for the `log_patterns` operation.", + "description": "Parameters for listing SLS projects.", "properties": { - "schema_version": { - "type": "string", - "description": "Schema version of the edge diagnostic result. Fixed at `2`, identifying the response-structure version; bumped on incompatible structural changes.", - "enum": [ - "2" - ] - }, - "operation": { - "type": "string", - "description": "Diagnostic operation that produced the result. Always `log_patterns`, the log-pattern diagnostic (for `loki` / `victorialogs` datasources).", - "enum": [ - "log_patterns" - ] - }, - "ds_type": { - "type": "string", - "description": "Data source type." - }, - "ds_name": { - "type": "string", - "description": "Data source name." + "id": { + "type": "integer", + "format": "uint64", + "description": "ID of an SLS-type datasource. Obtainable via `POST /monit/datasource/list`." }, "query": { "type": "string", - "description": "Query string echoed from the request." - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Current analysis window using RFC 3339 UTC timestamps." + "description": "Fuzzy filter on project description (maps to the `description` parameter of Aliyun SLS ListProject). Leave empty to return all." }, - "results": { - "type": "array", - "description": "Diagnostic evidence from one method; `method` determines the schema of the remaining fields.", - "items": { - "$ref": "#/components/schemas/DiagnoseResult" - } + "offset": { + "type": "integer", + "description": "Pagination offset." }, - "data_handling": { - "$ref": "#/components/schemas/DiagnoseLogDataHandling" + "size": { + "type": "integer", + "description": "Page size. Defaults to 200 server-side when 0." } }, "required": [ - "schema_version", - "operation", - "ds_type", - "ds_name", - "query", - "window", - "results", - "data_handling" + "id" ] }, - "DiagnoseLogPatternResult": { + "SLSProjectsResponse": { "type": "object", - "description": "Evidence from a log-pattern method.", + "description": "A page of Aliyun SLS projects.", + "required": [ + "projects", + "count", + "total" + ], "properties": { - "method": { - "type": "string", - "description": "Diagnostic method that produced this evidence. `pattern_snapshot` = pattern aggregation snapshot of the current window only, no baseline involved; `pattern_compare` = pattern comparison between the current window and the baseline window (see `baseline`).", - "enum": [ - "pattern_snapshot", - "pattern_compare" - ] - }, - "baseline": { - "type": "string", - "description": "Baseline window kind used by a comparison method. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days. Only present on `pattern_compare` results.", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "x-flashduty-preserve-absence": true - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Current analysis window using RFC 3339 UTC timestamps." - }, - "baseline_window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Baseline time window used by a comparison method.", - "x-flashduty-preserve-absence": true - }, - "summary": { - "$ref": "#/components/schemas/DiagnoseMethodSummary" - }, - "pattern_evidence": { + "projects": { "type": "array", - "description": "Log-pattern evidence ordered for RCA use.", "items": { - "$ref": "#/components/schemas/LogPatternEvidence" - } + "$ref": "#/components/schemas/SLSProject" + }, + "description": "Projects in the current page." }, - "warnings": { - "type": "array", - "description": "Non-fatal warnings produced during analysis.", - "items": { - "type": "string" - } - } - }, - "required": [ - "method", - "window", - "summary", - "pattern_evidence", - "warnings" - ] - }, - "DiagnoseMethodSummary": { - "description": "Summary returned by either a log-pattern or metric-trend method.", - "oneOf": [ - { - "$ref": "#/components/schemas/LogPatternDiagnoseSummary" + "count": { + "type": "integer", + "description": "Number of projects in this page." }, - { - "$ref": "#/components/schemas/MetricTrendDiagnoseSummary" + "total": { + "type": "integer", + "description": "Total number of projects matching `query`, independent of pagination." } - ] + } }, - "DiagnoseMetricTrendResponse": { + "SuccessEnvelope": { "type": "object", - "description": "Diagnostic result for the `metric_trends` operation.", + "description": "Success response envelope. On every 2xx response, `request_id` identifies the call (also mirrored in the `Flashcat-Request-Id` header) and `data` holds the endpoint-specific payload. Failure responses use a different shape — see `ErrorResponse`.", "properties": { - "schema_version": { - "type": "string", - "description": "Schema version of the edge diagnostic result. Fixed at `2`, identifying the response-structure version; bumped on incompatible structural changes.", - "enum": [ - "2" - ] - }, - "operation": { - "type": "string", - "description": "Diagnostic operation that produced the result. Always `metric_trends`, the metric-trend diagnostic (for `prometheus`-compatible datasources).", - "enum": [ - "metric_trends" - ] - }, - "ds_type": { - "type": "string", - "description": "Data source type." - }, - "ds_name": { - "type": "string", - "description": "Data source name." - }, - "query": { + "request_id": { "type": "string", - "description": "Query string echoed from the request." - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Current analysis window using RFC 3339 UTC timestamps." + "description": "Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.", + "example": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, - "results": { - "type": "array", - "description": "Diagnostic evidence from one method; `method` determines the schema of the remaining fields.", - "items": { - "$ref": "#/components/schemas/DiagnoseResult" - } + "data": { + "description": "Endpoint-specific payload. See each operation's 200 response schema." } }, "required": [ - "schema_version", - "operation", - "ds_type", - "ds_name", - "query", - "window", - "results" + "request_id", + "data" + ] + }, + "QueryDataRequest": { + "description": "Request for the stable structured query endpoint. It accepts the same query fields as the retired rows endpoint.", + "allOf": [ + { + "$ref": "#/components/schemas/QueryRowsRequest" + } ] }, - "DiagnoseMetricTrendResult": { + "QueryDataResponse": { "type": "object", - "description": "Evidence from a metric-trend method.", + "description": "Stable, Edge-version-independent structured query response.", + "required": [ + "format", + "result" + ], "properties": { - "method": { - "type": "string", - "description": "Diagnostic method that produced this evidence. `single_window_shape` = within-window trend/shape analysis only, no baseline involved; `window_compare` = per-series comparison between the current window and the baseline window (see `baseline`).", - "enum": [ - "single_window_shape", - "window_compare" - ] - }, - "baseline": { + "format": { "type": "string", - "description": "Baseline window kind used by a comparison method. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days. Only present on `window_compare` results.", "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" + "query_result.v1" ], - "x-flashduty-preserve-absence": true - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Current analysis window using RFC 3339 UTC timestamps." - }, - "baseline_window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Baseline time window used by a comparison method.", - "x-flashduty-preserve-absence": true - }, - "summary": { - "$ref": "#/components/schemas/DiagnoseMethodSummary" - }, - "series_evidence": { - "type": "array", - "description": "Metric evidence for each returned series.", - "items": { - "$ref": "#/components/schemas/MetricTrendSeriesEvidence" - } + "description": "Public result-contract version. It is independent of the internal monit-edge query protocol version. Fixed at `query_result.v1`, which defines the structure of the `result` field." }, - "warnings": { - "type": "array", - "description": "Non-fatal warnings produced during analysis.", - "items": { - "type": "string" - } + "result": { + "$ref": "#/components/schemas/QueryResult" } - }, - "required": [ - "method", - "window", - "summary", - "series_evidence", - "warnings" - ] + } }, - "DiagnoseResult": { - "description": "Diagnostic evidence from one method; `method` determines the schema of the remaining fields.", + "QueryResult": { + "description": "Exactly one natural result shape, selected by `kind`.", "oneOf": [ { - "$ref": "#/components/schemas/DiagnoseLogPatternResult" + "$ref": "#/components/schemas/QueryFramesResult" + }, + { + "$ref": "#/components/schemas/QueryRecordsResult" }, { - "$ref": "#/components/schemas/DiagnoseMetricTrendResult" + "$ref": "#/components/schemas/QuerySamplesResult" } ], "discriminator": { - "propertyName": "method", + "propertyName": "kind", "mapping": { - "pattern_snapshot": "#/components/schemas/DiagnoseLogPatternResult", - "pattern_compare": "#/components/schemas/DiagnoseLogPatternResult", - "single_window_shape": "#/components/schemas/DiagnoseMetricTrendResult", - "window_compare": "#/components/schemas/DiagnoseMetricTrendResult" + "frames": "#/components/schemas/QueryFramesResult", + "records": "#/components/schemas/QueryRecordsResult", + "samples": "#/components/schemas/QuerySamplesResult" + } + } + }, + "QueryFramesResult": { + "type": "object", + "required": [ + "kind", + "frames" + ], + "properties": { + "kind": { + "type": "string", + "enum": [ + "frames" + ], + "description": "Result-kind discriminator, always `frames`, indicating the `frames` payload of typed table/time-series frames." + }, + "frames": { + "type": "array", + "description": "Typed table or time-series frames. A response can contain more than one frame.", + "items": { + "$ref": "#/components/schemas/QueryFrame" + } } } }, - "LogPatternDiagnoseSummary": { + "QueryFrame": { "type": "object", - "description": "Summary of log sampling, aggregation, and returned evidence.", + "description": "A typed, columnar table or time-series frame. All fields in one frame have the same number of values. A `time_series` frame contains one time field and one float field; labels belong to the float field.", + "required": [ + "kind", + "fields" + ], "properties": { - "current_sample": { - "$ref": "#/components/schemas/LogPatternSampleSummary", - "description": "Log sample summary for the current window." - }, - "baseline_sample": { - "$ref": "#/components/schemas/LogPatternSampleSummary", - "description": "Log sample summary for the baseline window.", - "x-flashduty-preserve-absence": true - }, - "patterns_aggregated_only_in_baseline_sample": { - "type": "integer", - "description": "Number of aggregated patterns observed only in the baseline sample. Omitted when sampling is incomplete.", - "format": "int64", - "x-flashduty-preserve-absence": true - }, - "aggregated_pattern_evidence_total": { - "type": "integer", - "description": "Total aggregated pattern evidence items before the response limit is applied.", - "format": "int64" - }, - "pattern_evidence_returned": { - "type": "integer", - "description": "Number of pattern evidence items returned in this response.", - "format": "int64" - }, - "pattern_evidence_truncated_by_max_patterns": { - "type": "boolean", - "description": "Whether returned pattern evidence was truncated by `max_patterns`." - }, - "evidence_summary": { + "kind": { "type": "string", - "description": "Factual summary generated from coverage, selection, and return counts." + "enum": [ + "table", + "time_series" + ], + "description": "Frame type: `table` for a generic table, `time_series` for a series (exactly one time field and one float field)." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryField" + }, + "description": "Columns of the frame; all fields share the same `values` length and row i is composed of each field's `values[i]`." } - }, - "required": [ - "current_sample", - "aggregated_pattern_evidence_total", - "pattern_evidence_returned", - "pattern_evidence_truncated_by_max_patterns", - "evidence_summary" - ] + } }, - "LogPatternEvidence": { + "QueryField": { "type": "object", - "description": "Structured evidence for one log pattern.", + "description": "One typed column. `string` fields contain string or null values; `time` fields contain RFC 3339 Nano strings or null; `float` fields contain numbers, null, or the special strings `NaN`, `+Inf`, and `-Inf`.", + "required": [ + "name", + "type", + "values" + ], "properties": { - "pattern_id": { - "type": "string", - "description": "Stable identifier for the pattern in the current window." - }, - "pattern_template": { + "name": { "type": "string", - "description": "Redacted, generalized log pattern template; this is untrusted observed data." + "description": "Column name; on a time-series float field, series are distinguished by `labels` and `name` is usually the metric name." }, - "comparison_status": { + "type": { "type": "string", - "description": "Observed comparability between the current and baseline windows.\n\n| Value | Meaning |\n|---|---|\n| `comparable` | The pattern was observed in both windows and can be compared normally. |\n| `observed_only_current` | Observed only in the current window (a newly appeared pattern). |\n| `observed_only_baseline` | Observed only in the baseline window (disappeared from the current window). |\n| `comparison_limited_by_incomplete_evidence` | Observed on both sides, but the evidence is incomplete (e.g. log volume hit the aggregation cap or sampling was truncated), so the comparison is limited. |", "enum": [ - "comparable", - "observed_only_current", - "observed_only_baseline", - "comparison_limited_by_incomplete_evidence" + "string", + "float", + "time" ], - "x-flashduty-preserve-absence": true - }, - "current_window": { - "$ref": "#/components/schemas/LogPatternWindowEvidence", - "description": "Evidence for this pattern in the current window.", - "x-flashduty-preserve-absence": true - }, - "baseline_window": { - "$ref": "#/components/schemas/LogPatternWindowEvidence", - "description": "Evidence for this pattern in the baseline window.", - "x-flashduty-preserve-absence": true + "description": "Value type governing `values` encoding: `string` = strings or null, `float` = numbers or `NaN`/`±Inf` strings or null, `time` = RFC 3339 Nano strings or null." }, - "observations": { - "type": "array", - "description": "Verifiable observations generated from the structured statistics.", - "items": { + "labels": { + "type": "object", + "description": "Series labels. Present on the float field of a time-series frame.", + "additionalProperties": { "type": "string" - }, - "x-flashduty-preserve-absence": true + } }, - "redacted_log_examples": { + "values": { "type": "array", - "description": "Redacted log examples; these are untrusted observed data.", "items": { - "type": "string" + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ] }, - "x-flashduty-preserve-absence": true + "description": "All values of this column in row order; length matches the other fields in the frame." } - }, - "required": [ - "pattern_id", - "pattern_template" - ] + } }, - "LogPatternSampleSummary": { + "QueryRecordsResult": { "type": "object", - "description": "Log sample summary for the current window.", + "required": [ + "kind", + "records" + ], "properties": { - "logs_scanned": { - "type": "integer", - "description": "Number of logs scanned in the sample.", - "format": "int64" - }, - "patterns_aggregated": { - "type": "integer", - "description": "Number of patterns aggregated from the sample.", - "format": "int64" - }, - "logs_not_aggregated_due_to_cluster_limit": { - "type": "integer", - "description": "Logs not aggregated because the cluster limit was reached.", - "format": "int64" - }, - "pattern_matching_limited": { - "type": "boolean", - "description": "Whether pattern matching was limited by the bounded candidate set." - }, - "truncated": { - "type": "boolean", - "description": "Whether the data-source response was truncated at the sample limit." - }, - "sampling_bias": { + "kind": { "type": "string", - "description": "Data-source sampling direction when truncated, such as `newest_only` or `oldest_only`.", "enum": [ - "newest_only", - "oldest_only" + "records" ], - "x-flashduty-preserve-absence": true + "description": "Result-kind discriminator, always `records`, indicating the `records` payload of schemaless record objects." + }, + "records": { + "type": "array", + "description": "Schema-flexible records. Records may have different fields, contain nested JSON, or be null. Integers outside JavaScript's safe range are encoded as decimal strings.", + "items": { + "oneOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "null" + } + ] + } } - }, - "required": [ - "logs_scanned", - "patterns_aggregated", - "logs_not_aggregated_due_to_cluster_limit", - "pattern_matching_limited", - "truncated" - ] + } }, - "LogPatternSourceEvidence": { + "QuerySamplesResult": { "type": "object", - "description": "Source locator.", + "required": [ + "kind", + "samples" + ], "properties": { - "field": { - "type": "string", - "description": "Source field name." - }, - "value": { + "kind": { "type": "string", - "description": "Source field value." + "enum": [ + "samples" + ], + "description": "Result-kind discriminator, always `samples`, indicating the `samples` payload of labeled instant samples." }, - "count": { - "type": "integer", - "description": "Count of logs with this source field and value.", - "format": "int64" + "samples": { + "type": "array", + "description": "Instant samples with their complete label sets.", + "items": { + "$ref": "#/components/schemas/QuerySample" + } } - }, - "required": [ - "field", - "value", - "count" - ] + } }, - "LogPatternWindowEvidence": { + "QuerySample": { "type": "object", - "description": "Observed log-pattern evidence in one time window.", + "required": [ + "labels", + "value" + ], "properties": { - "count": { - "type": "integer", - "description": "Number of logs matching this pattern in the window.", - "format": "int64" - }, - "share_of_scanned_logs": { - "type": "number", - "description": "Share of scanned logs represented by this pattern.", - "format": "double" - }, - "first_seen": { - "type": "string", - "description": "First observed time for this pattern in RFC 3339 UTC.", - "format": "date-time" - }, - "last_seen": { - "type": "string", - "description": "Last observed time for this pattern in RFC 3339 UTC.", - "format": "date-time" - }, - "observed_severity_counts": { + "labels": { "type": "object", - "description": "Log counts grouped by observed severity.", "additionalProperties": { - "type": "integer", - "format": "int64" + "type": "string" }, - "x-flashduty-preserve-absence": true + "description": "The sample's full label set; may be an empty object but is always present." }, - "sources": { - "type": "array", - "description": "Low-cardinality source locators; field values are untrusted observed data.", - "items": { - "$ref": "#/components/schemas/LogPatternSourceEvidence" - }, - "x-flashduty-preserve-absence": true + "value": { + "description": "Finite numeric value or a JSON-safe representation of a non-finite float.", + "oneOf": [ + { + "type": "number" + }, + { + "type": "string", + "enum": [ + "NaN", + "+Inf", + "-Inf" + ] + } + ] } - }, - "required": [ - "count", - "share_of_scanned_logs", - "first_seen", - "last_seen" - ] + } }, - "MetricTrendDiagnoseSummary": { + "QueryRowsRequest": { "type": "object", - "description": "Coverage, selection, and return counts for metric series.", + "required": [ + "ds_type", + "ds_name", + "expr" + ], "properties": { - "series_total": { - "type": "integer", - "description": "Total input series; for comparisons, the union of current and baseline label sets.", - "format": "int64" - }, - "series_analyzed": { - "type": "integer", - "description": "Number of series analyzed after applying `max_series`.", - "format": "int64" - }, - "selected_series_total": { - "type": "integer", - "description": "Series matching internal selection rules before `topk` is applied.", - "format": "int64" - }, - "series_returned": { + "account_id": { "type": "integer", - "description": "Number of `series_evidence` items returned in this response.", - "format": "int64" - }, - "analysis_truncated": { - "type": "boolean", - "description": "Whether `max_series` prevented full analysis of all input series." + "format": "int64", + "description": "Optional consistency check. Must equal the authenticated account when supplied; mismatched values are rejected. Business execution always uses the authenticated account." }, - "evidence_summary": { + "ds_type": { "type": "string", - "description": "Factual summary generated from coverage, selection, and return counts." - } - }, - "required": [ - "series_total", - "series_analyzed", - "selected_series_total", - "series_returned", - "analysis_truncated", - "evidence_summary" - ] - }, - "MetricTrendSeriesEvidence": { - "type": "object", - "description": "Structured evidence for one metric series.", - "properties": { - "labels": { - "type": "object", - "description": "Series labels; treat values as untrusted observed data.", - "additionalProperties": { - "type": "string" - } + "description": "Data source type; must match a configured data source under the tenant. Examples: `prometheus`, `loki`, `victorialogs`, `sls`, `elasticsearch`, `mysql`, `postgres`, `oracle`, `clickhouse`." }, - "comparison_status": { + "ds_name": { "type": "string", - "description": "Comparability of the current and baseline series.\n\n| Value | Meaning |\n|---|---|\n| `comparable` | Both windows have enough finite samples for a normal comparison. |\n| `new_series` | The series exists only in the current window (new series). |\n| `disappeared_series` | The series exists only in the baseline window (gone from the current window). |\n| `insufficient_current_points` | Fewer than 3 finite samples in the current window; not comparable. |\n| `insufficient_baseline_points` | Fewer than 3 finite samples in the baseline window; not comparable. |", - "enum": [ - "comparable", - "new_series", - "disappeared_series", - "insufficient_current_points", - "insufficient_baseline_points" - ], - "x-flashduty-preserve-absence": true + "description": "Data source name; must match a configured data source under the tenant." }, - "current_window_stats": { - "$ref": "#/components/schemas/MetricTrendWindowStats", - "description": "Finite-sample statistics for the current window. Omitted when no finite samples exist.", - "x-flashduty-preserve-absence": true + "expr": { + "type": "string", + "description": "Query expression. Syntax depends on `ds_type` and is interpreted by the corresponding monit-edge client (PromQL for Prometheus, LogQL for Loki, SQL for SQL sources, etc.)." }, - "baseline_window_stats": { - "$ref": "#/components/schemas/MetricTrendWindowStats", - "description": "Finite-sample statistics for the baseline window. Omitted when no finite samples exist.", - "x-flashduty-preserve-absence": true + "delay_seconds": { + "type": "integer", + "description": "Look-back offset in seconds applied to point-in-time queries (Prometheus, Loki stats, VictoriaLogs stats). Ignored for raw / detail queries.", + "default": 0 }, - "observations": { - "type": "array", - "description": "Verifiable observations generated from the structured statistics.", - "items": { + "args": { + "type": "object", + "description": "Polymorphic key/value extension parameters forwarded verbatim to monit-edge. All values must be strings, and keys are always namespaced by source (e.g. `sls.project`, `loki.type`). Validation depends on `ds_type`: SLS requires `sls.project` + `sls.logstore`. Elasticsearch accepts `es.type` of `sql`, or omitted — any other value is rejected. Loki and VictoriaLogs accept `.type` of `stats`, `raw`, or omitted; `raw` additionally requires a time range, either `.start` + `.end` or `.timespan.value` + `.timespan.unit` (unit one of `s`, `m`, `h`, `d`). Prometheus and the remaining SQL sources ignore `args` entirely.", + "additionalProperties": { "type": "string" } } - }, - "required": [ - "labels", - "observations" - ] - }, - "MetricTrendWindowStats": { - "type": "object", - "description": "Finite-sample statistics for a metric time window.", - "properties": { - "points": { - "type": "integer", - "description": "Number of finite sample points used for the statistics.", - "format": "int64" - }, - "first": { - "type": "number", - "description": "First finite sample value in the window.", - "format": "double" - }, - "last": { - "type": "number", - "description": "Last finite sample value in the window.", - "format": "double" - }, - "min": { - "type": "number", - "description": "Minimum finite sample value in the window.", - "format": "double" - }, - "median": { - "type": "number", - "description": "Median of finite samples in the window.", - "format": "double" - }, - "avg": { - "type": "number", - "description": "Average of finite samples in the window.", - "format": "double" - }, - "p95": { - "type": "number", - "description": "95th percentile of finite samples in the window.", - "format": "double" - }, - "max": { - "type": "number", - "description": "Maximum finite sample value in the window.", - "format": "double" - } - }, - "required": [ - "points", - "first", - "last", - "min", - "median", - "avg", - "p95", - "max" - ] + } }, "DSTencentCLSConfig": { "type": "object", diff --git a/api-reference/monitors.openapi.zh.json b/api-reference/monitors.openapi.zh.json index 2cfefadf..da729118 100644 --- a/api-reference/monitors.openapi.zh.json +++ b/api-reference/monitors.openapi.zh.json @@ -25,10 +25,6 @@ "name": "Monitors/告警数据源", "description": "管理监控告警规则用于查询指标的数据源。" }, - { - "name": "Monitors/规则集", - "description": "管理 Monitors 规则仓库中的共享规则集，规则集可在账户内或公开共享。" - }, { "name": "Monitors/诊断分析", "description": "Flashduty AI SRE 使用的诊断与查询接口——数据源即席查询、日志/指标诊断,以及监控对象侧的工具调用。" @@ -39,84 +35,6 @@ } ], "paths": { - "/monit/store/ruleset/update": { - "post": { - "operationId": "monit-store-ruleset-update", - "summary": "更新规则集", - "description": "更新已有规则集的备注、共享标志及 payload。", - "tags": [ - "Monitors/规则集" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库管理**（`monit`） |\n\n## 使用说明\n\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-update", - "metadata": { - "sidebarTitle": "更新规则集" - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StoreRulesetItem" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "id": 1, - "note": "Updated CPU alerts", - "open_flag": 2, - "updated_at": 1712100000 - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreRulesetUpdateRequest" - }, - "example": { - "id": 1, - "note": "Updated CPU alerts", - "open_flag": 2, - "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.9\"}]" - } - } - } - } - } - }, "/monit/rule/counter/total": { "post": { "operationId": "monit-rule-read-counter-total", @@ -1676,19 +1594,19 @@ } } }, - "/monit/store/ruleset/list": { + "/monit/rule/list/basic": { "post": { - "operationId": "monit-store-ruleset-list", - "summary": "查询规则集列表", - "description": "返回指定数据源类型下当前用户有权访问的所有规则集。", + "operationId": "monit-rule-read-list", + "summary": "查询告警规则列表", + "description": "返回指定文件夹下所有告警规则的基础信息。如需完整规则详情，请调用 `POST /monit/rule/info`。", "tags": [ - "Monitors/规则集" + "Monitors/告警规则" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库查看**（`monit`） |\n\n## 使用说明\n\n- 当 `open_flag` 为 `2`（公开）、当前用户为创建者（`open_flag=0`）或与账户共享（`open_flag=1`）时，规则集对当前用户可见。\n- 列表不包含 `payload` 字段，完整内容请调用 `/monit/store/ruleset/info`。", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-list", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |\n\n## 使用说明\n\n- 将 `folder_id` 设为 `0` 可列出当前用户有权查看的所有文件夹下的规则。\n- `triggered` 字段表示该规则当前是否有活跃告警。", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-list", "metadata": { - "sidebarTitle": "查询规则集列表" + "sidebarTitle": "查询告警规则列表" } }, "responses": { @@ -1705,7 +1623,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetListResponse" + "$ref": "#/components/schemas/RuleBasicListResponse" } } } @@ -1715,15 +1633,15 @@ "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", "data": [ { - "id": 1, - "type_ident": "prometheus", - "note": "CPU usage alerts", - "open_flag": 2, - "creator_account_id": 10023, - "creator_id": 80011, - "creator_name": "Alice", + "id": 50001, + "folder_id": 100, + "name": "CPU High", + "ds_type": "prometheus", + "enabled": true, + "triggered": true, "created_at": 1710000000, - "updated_at": 1712000000 + "active_alert_count": 2, + "runtime_state": "normal" } ] } @@ -1748,29 +1666,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StoreRulesetListRequest" + "$ref": "#/components/schemas/RuleListRequest" }, "example": { - "type_ident": "prometheus" + "folder_id": 100 } } } } } }, - "/monit/store/ruleset/delete": { + "/monit/datasource/list": { "post": { - "operationId": "monit-store-ruleset-delete", - "summary": "删除规则集", - "description": "通过 ID 从规则仓库中删除规则集。", + "operationId": "monit-datasource-read-list", + "summary": "查询数据源列表", + "description": "返回当前账户下的所有数据源，可通过 `type_ident` 过滤类型。 支持诊断类型 redis_node、redis_sentinel、mongodb_mongod、mongodb_mongos 和 kafka；enabled 与 alerting_enabled 相互独立。", "tags": [ - "Monitors/规则集" + "Monitors/告警数据源" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库管理**（`monit`） |\n\n## 使用说明\n\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-delete", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **数据源查看**（`monit`） |\n\n## 使用说明\n\n- 省略 `type_ident` 可返回所有类型的数据源。\n- 列表响应中不返回敏感凭证字段（密码、密钥）。\n\n完整支持类型与凭据行为见请求/响应 Schema。仅诊断类型不能启用告警。创建时省略 enabled 默认为 true，更新时省略保留当前值；enabled 或 alerting_enabled 的显式 null 非法。诊断密码及 Kafka 私钥在响应中省略，环境变量引用除外；更新时省略秘密字段保留原值，空字符串清除。其他数据源凭据可能返回，应作为敏感数据处理。", + "href": "/zh/api-reference/monitors/data-sources/monit-datasource-read-list", "metadata": { - "sidebarTitle": "删除规则集" + "sidebarTitle": "查询数据源列表" } }, "responses": { @@ -1787,7 +1705,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/EmptyResponse" + "$ref": "#/components/schemas/DataSourceListResponse" } } } @@ -1795,7 +1713,21 @@ }, "example": { "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": {} + "data": [ + { + "id": 10, + "account_id": 10023, + "type_ident": "prometheus", + "name": "Prometheus Prod", + "enabled": true, + "note": "Production Prometheus", + "address": "http://prometheus.example.com:9090", + "edge_cluster_name": "default", + "updated_at": 1712000000, + "payload": null, + "alerting_enabled": true + } + ] } } } @@ -1818,29 +1750,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IDRequest" + "$ref": "#/components/schemas/DataSourceListRequest" }, "example": { - "id": 1 + "type": "prometheus" } } } } } }, - "/monit/rule/counter/status": { + "/monit/rule/update/fields": { "post": { - "operationId": "monit-rule-read-counter-status", - "summary": "查看顶层文件夹规则状态统计", - "description": "返回所有顶层文件夹节点的规则触发状态汇总，用于概览看板。", + "operationId": "monit-rule-write-fields-update", + "summary": "批量更新规则字段", + "description": "一次性更新多条告警规则的特定字段，仅应用 `fields` 列表中指定的字段。", "tags": [ "Monitors/告警规则" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-status", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则管理**（`monit`） |\n\n## 使用说明\n\n- 在 `fields` 数组中指定要更新的字段名，如 `[\"enabled\", \"channel_ids\"]`。\n- 仅更新指定字段，其他字段保持不变。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-write-fields-update", "metadata": { - "sidebarTitle": "查看顶层文件夹规则状态统计" + "sidebarTitle": "批量更新规则字段" } }, "responses": { @@ -1857,7 +1789,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleStatusResponse" + "$ref": "#/components/schemas/RuleNameMessageListResponse" } } } @@ -1867,10 +1799,12 @@ "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", "data": [ { - "folder_id": 100, - "folder_name": "Production", - "rule_total": 10, - "triggered_rule_count": 2 + "name": "CPU High", + "message": "" + }, + { + "name": "Disk High", + "message": "" } ] } @@ -1895,27 +1829,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RuleEmptyRequest" + "$ref": "#/components/schemas/RuleFieldsUpdateRequest" }, - "example": {} + "example": { + "ids": [ + 50001, + 50002 + ], + "fields": [ + "enabled" + ], + "enabled": false + } } } } } }, - "/monit/rule/list/basic": { + "/monit/rule/counter/channel": { "post": { - "operationId": "monit-rule-read-list", - "summary": "查询告警规则列表", - "description": "返回指定文件夹下所有告警规则的基础信息。如需完整规则详情，请调用 `POST /monit/rule/info`。", + "operationId": "monit-rule-read-counter-channel", + "summary": "按协作空间查询规则统计", + "description": "返回一个对象，key 为协作空间名称，value 为将告警路由到该协作空间的规则数量。若协作空间名称无法解析，则以协作空间 ID（字符串形式）作为 key。", "tags": [ "Monitors/告警规则" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |\n\n## 使用说明\n\n- 将 `folder_id` 设为 `0` 可列出当前用户有权查看的所有文件夹下的规则。\n- `triggered` 字段表示该规则当前是否有活跃告警。", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-list", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-channel", "metadata": { - "sidebarTitle": "查询告警规则列表" + "sidebarTitle": "按协作空间查询规则统计" } }, "responses": { @@ -1932,7 +1875,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleBasicListResponse" + "$ref": "#/components/schemas/RuleCounterChannelResponse" } } } @@ -1940,19 +1883,9 @@ }, "example": { "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": [ - { - "id": 50001, - "folder_id": 100, - "name": "CPU High", - "ds_type": "prometheus", - "enabled": true, - "triggered": true, - "created_at": 1710000000, - "active_alert_count": 2, - "runtime_state": "normal" - } - ] + "data": { + "Production": 8 + } } } } @@ -1975,29 +1908,44 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RuleListRequest" + "$ref": "#/components/schemas/RuleEmptyRequest" }, - "example": { - "folder_id": 100 - } + "example": {} } } } } }, - "/monit/store/ruleset/info": { + "/monit/query/data": { "post": { - "operationId": "monit-store-ruleset-info", - "summary": "查看规则集详情", - "description": "获取规则集的完整信息，包括 `payload`（JSON 字符串形式的告警规则定义）。", + "operationId": "monit-read-query-data", + "summary": "查询结构化数据", + "description": "对已配置的数据源执行同步即席查询，并返回稳定的 `query_result.v1` 结果；结果会按自然语义呈现为 frames、records 或 samples。此公开接口要求 monit-edge v0.65.0 或更高版本。", "tags": [ - "Monitors/规则集" + "Monitors/诊断分析" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库查看**（`monit`） |", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-info", + "content": "## 调用限制\n\n| 项 | 值 |\n| ------ | ----- |\n| 速率限制 | 每账户 **100 次/分钟**、**5 次/秒** |\n| 权限 | 任意有效的 `app_key`（只读，不受特定权限分类限制） |\n| Edge 版本要求 | 受支持的部署要求 **monit-edge v0.65.0 或更高版本** |\n\n## 使用说明\n\n- 此公开接口以 **monit-edge v0.65.0** 为最低受支持版本。迁移期间，WebAPI 仍保留旧版 Edge 适配器：query.v2 结果仍可能保留 frames、records 或 samples，而 legacy rows 只能提供其已保留的信息。这些适配器不会改变最低支持版本；旧协议缺少 query.v3 的取消和错误生命周期语义，legacy rows 已丢失的数据也无法恢复。\n- 公开响应格式固定为 `query_result.v1`，与 Edge 内部查询协议版本无关。必须根据 `result.kind`（`frames`、`records` 或 `samples`）分发结果，不要根据 `ds_type` 或 Edge 版本猜测结果形态。\n- `frames` 结果可以包含多个表格或时序 Frame。字段值按列组织，同一 Frame 中所有字段的值数量一致。\n- `records` 结果可以包含嵌套 JSON 和 null record。超出 JavaScript 安全整数范围的整数字面量会以十进制字符串返回。\n- `samples` 结果包含标签集合和瞬时值。值可以是数字，也可以是字符串 `NaN`、`+Inf` 或 `-Inf`。\n- 最终成功响应上限为 8 MiB，查询结果上限为 1,000 行。超限时请缩短时间范围、减少字段或在数据源侧聚合。\n- 查询失败使用非 2xx HTTP 状态码和标准错误 envelope。不要透明回退到已弃用的 `/monit/query/rows` 接口。\n- WebAPI 跨实例转发和 Edge 执行合计可能耗时 35 秒。客户端超时建议至少设为 40 秒，并在调用方放弃查询时向下传播取消信号。", + "href": "/zh/api-reference/monitors/diagnostics/monit-read-query-data", "metadata": { - "sidebarTitle": "查看规则集详情" + "sidebarTitle": "查询结构化数据" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/QueryDataRequest" + }, + "example": { + "ds_type": "prometheus", + "ds_name": "prod-prom", + "expr": "sum by (job) (rate(http_requests_total[5m]))", + "delay_seconds": 0, + "args": {} + } + } } }, "responses": { @@ -2014,7 +1962,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetItem" + "$ref": "#/components/schemas/QueryDataResponse" } } } @@ -2023,16 +1971,18 @@ "example": { "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", "data": { - "id": 1, - "type_ident": "prometheus", - "note": "CPU usage alerts", - "open_flag": 2, - "payload": "[{\"prom_ql\":\"...\"}]", - "creator_account_id": 10023, - "creator_id": 80011, - "creator_name": "Alice", - "created_at": 1710000000, - "updated_at": 1712000000 + "format": "query_result.v1", + "result": { + "kind": "samples", + "samples": [ + { + "labels": { + "job": "api" + }, + "value": 1.25 + } + ] + } } } } @@ -2044,848 +1994,246 @@ "401": { "$ref": "#/components/responses/Unauthorized" }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "413": { + "description": "请求或最终响应超过大小限制。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, "429": { "$ref": "#/components/responses/TooManyRequests" }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IDRequest" - }, - "example": { - "id": 1 + "499": { + "description": "客户端已取消查询。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } - } - } - } - }, - "/monit/store/ruleset/create": { - "post": { - "operationId": "monit-store-ruleset-create", - "summary": "创建规则集", - "description": "在规则仓库中创建新的规则集。", - "tags": [ - "Monitors/规则集" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库管理**（`monit`） |\n\n## 使用说明\n\n- `open_flag`：`0` 仅创建者可见，`1` 账户内共享，`2` 公开。\n- `payload` 为必填 JSON 字符串，包含告警规则定义。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-create", - "metadata": { - "sidebarTitle": "创建规则集" - } - }, - "responses": { - "200": { - "description": "成功", + }, + "500": { + "$ref": "#/components/responses/ServerError" + }, + "503": { + "$ref": "#/components/responses/ServiceUnavailable" + }, + "504": { + "description": "查询超时。", "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StoreRulesetItem" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "id": 1, - "type_ident": "prometheus", - "note": "CPU usage alerts", - "open_flag": 1, - "created_at": 1712000000, - "updated_at": 1712000000 - } + "$ref": "#/components/schemas/ErrorResponse" } } } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" } - }, + } + } + }, + "/monit/datasource/tools/invoke": { + "post": { + "description": "对已配置的数据源执行单个确定性工具。要求集群所有当前在线可路由 Edge 会话支持 v0.71.0 基础 invoke 协议；具体工具可能需要更新实现。不提供工具目录、自动重放或 Agent/旧 diagnose 回退。请求体上限 128 KiB，完整成功响应上限 1 MiB，工具超时最多 25 秒。", + "operationId": "monit-datasource-tools-invoke", "requestBody": { - "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreRulesetUpsertRequest" - }, "example": { - "type_ident": "prometheus", - "note": "CPU usage alerts", - "open_flag": 1, - "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.8\"}]" + "datasource_id": 10, + "params": {}, + "tool": "mysql.overview" + }, + "schema": { + "$ref": "#/components/schemas/DatasourceToolInvokeRequest" } } - } - } - } - }, - "/monit/datasource/list": { - "post": { - "operationId": "monit-datasource-read-list", - "summary": "查询数据源列表", - "description": "返回当前账户下的所有数据源，可通过 `type_ident` 过滤类型。 支持诊断类型 redis_node、redis_sentinel、mongodb_mongod、mongodb_mongos 和 kafka；enabled 与 alerting_enabled 相互独立。", - "tags": [ - "Monitors/告警数据源" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **数据源查看**（`monit`） |\n\n## 使用说明\n\n- 省略 `type_ident` 可返回所有类型的数据源。\n- 列表响应中不返回敏感凭证字段（密码、密钥）。\n\n完整支持类型与凭据行为见请求/响应 Schema。仅诊断类型不能启用告警。创建时省略 enabled 默认为 true，更新时省略保留当前值；enabled 或 alerting_enabled 的显式 null 非法。诊断密码及 Kafka 私钥在响应中省略，环境变量引用除外；更新时省略秘密字段保留原值，空字符串清除。其他数据源凭据可能返回，应作为敏感数据处理。", - "href": "/zh/api-reference/monitors/data-sources/monit-datasource-read-list", - "metadata": { - "sidebarTitle": "查询数据源列表" - } + }, + "required": true }, "responses": { "200": { - "description": "成功", "content": { "application/json": { + "example": { + "data": { + "data": { + "version": "8.0.36" + }, + "datasource_id": 10, + "summary": "MySQL overview", + "tool": "mysql.overview" + }, + "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" + }, "schema": { "allOf": [ { "$ref": "#/components/schemas/SuccessEnvelope" }, { - "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DataSourceListResponse" + "$ref": "#/components/schemas/DatasourceToolResult" } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": [ - { - "id": 10, - "account_id": 10023, - "type_ident": "prometheus", - "name": "Prometheus Prod", - "enabled": true, - "note": "Production Prometheus", - "address": "http://prometheus.example.com:9090", - "edge_cluster_name": "default", - "updated_at": 1712000000, - "payload": null, - "alerting_enabled": true + }, + "type": "object" } ] } } - } + }, + "description": "成功" }, "400": { - "$ref": "#/components/responses/BadRequest" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "标准 HTTP 错误；error.reason：invalid_request, tool_not_supported, datasource_error." }, "401": { "$ref": "#/components/responses/Unauthorized" }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceListRequest" - }, - "example": { - "type": "prometheus" + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - } - } - } - } - }, - "/monit/rule/update/fields": { - "post": { - "operationId": "monit-rule-write-fields-update", - "summary": "批量更新规则字段", - "description": "一次性更新多条告警规则的特定字段，仅应用 `fields` 列表中指定的字段。", - "tags": [ - "Monitors/告警规则" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则管理**（`monit`） |\n\n## 使用说明\n\n- 在 `fields` 数组中指定要更新的字段名，如 `[\"enabled\", \"channel_ids\"]`。\n- 仅更新指定字段，其他字段保持不变。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-write-fields-update", - "metadata": { - "sidebarTitle": "批量更新规则字段" - } - }, - "responses": { - "200": { - "description": "成功", + }, + "description": "标准 HTTP 错误；error.reason：access_denied." + }, + "404": { "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleNameMessageListResponse" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": [ - { - "name": "CPU High", - "message": "" - }, - { - "name": "Disk High", - "message": "" - } - ] + "$ref": "#/components/schemas/ErrorResponse" } } - } + }, + "description": "标准 HTTP 错误；error.reason：datasource_not_found." }, - "400": { - "$ref": "#/components/responses/BadRequest" + "409": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "标准 HTTP 错误；error.reason：datasource_disabled, datasource_in_use." }, - "401": { - "$ref": "#/components/responses/Unauthorized" + "413": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "标准 HTTP 错误；error.reason：source_too_large, result_too_large." }, "429": { - "$ref": "#/components/responses/TooManyRequests" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "标准 HTTP 错误；error.reason：overloaded." }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RuleFieldsUpdateRequest" - }, - "example": { - "ids": [ - 50001, - 50002 - ], - "fields": [ - "enabled" - ], - "enabled": false - } - } - } - } - } - }, - "/monit/rule/counter/channel": { - "post": { - "operationId": "monit-rule-read-counter-channel", - "summary": "按协作空间查询规则统计", - "description": "返回一个对象，key 为协作空间名称，value 为将告警路由到该协作空间的规则数量。若协作空间名称无法解析，则以协作空间 ID（字符串形式）作为 key。", - "tags": [ - "Monitors/告警规则" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-channel", - "metadata": { - "sidebarTitle": "按协作空间查询规则统计" - } - }, - "responses": { - "200": { - "description": "成功", + "499": { "content": { "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCounterChannelResponse" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "Production": 8 - } + "$ref": "#/components/schemas/ErrorResponse" } } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" + }, + "description": "标准 HTTP 错误；error.reason：canceled." }, "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RuleEmptyRequest" - }, - "example": {} - } - } - } - } - }, - "/monit/query/data": { - "post": { - "operationId": "monit-read-query-data", - "summary": "查询结构化数据", - "description": "对已配置的数据源执行同步即席查询，并返回稳定的 `query_result.v1` 结果；结果会按自然语义呈现为 frames、records 或 samples。此公开接口要求 monit-edge v0.65.0 或更高版本。", - "tags": [ - "Monitors/诊断分析" - ], - "x-mint": { - "content": "## 调用限制\n\n| 项 | 值 |\n| ------ | ----- |\n| 速率限制 | 每账户 **100 次/分钟**、**5 次/秒** |\n| 权限 | 任意有效的 `app_key`（只读，不受特定权限分类限制） |\n| Edge 版本要求 | 受支持的部署要求 **monit-edge v0.65.0 或更高版本** |\n\n## 使用说明\n\n- 此公开接口以 **monit-edge v0.65.0** 为最低受支持版本。迁移期间，WebAPI 仍保留旧版 Edge 适配器：query.v2 结果仍可能保留 frames、records 或 samples，而 legacy rows 只能提供其已保留的信息。这些适配器不会改变最低支持版本；旧协议缺少 query.v3 的取消和错误生命周期语义，legacy rows 已丢失的数据也无法恢复。\n- 公开响应格式固定为 `query_result.v1`，与 Edge 内部查询协议版本无关。必须根据 `result.kind`（`frames`、`records` 或 `samples`）分发结果，不要根据 `ds_type` 或 Edge 版本猜测结果形态。\n- `frames` 结果可以包含多个表格或时序 Frame。字段值按列组织，同一 Frame 中所有字段的值数量一致。\n- `records` 结果可以包含嵌套 JSON 和 null record。超出 JavaScript 安全整数范围的整数字面量会以十进制字符串返回。\n- `samples` 结果包含标签集合和瞬时值。值可以是数字，也可以是字符串 `NaN`、`+Inf` 或 `-Inf`。\n- 最终成功响应上限为 8 MiB，查询结果上限为 1,000 行。超限时请缩短时间范围、减少字段或在数据源侧聚合。\n- 查询失败使用非 2xx HTTP 状态码和标准错误 envelope。不要透明回退到已弃用的 `/monit/query/rows` 接口。\n- WebAPI 跨实例转发和 Edge 执行合计可能耗时 35 秒。客户端超时建议至少设为 40 秒，并在调用方放弃查询时向下传播取消信号。", - "href": "/zh/api-reference/monitors/diagnostics/monit-read-query-data", - "metadata": { - "sidebarTitle": "查询结构化数据" - } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QueryDataRequest" - }, - "example": { - "ds_type": "prometheus", - "ds_name": "prod-prom", - "expr": "sum by (job) (rate(http_requests_total[5m]))", - "delay_seconds": 0, - "args": {} - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QueryDataResponse" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "format": "query_result.v1", - "result": { - "kind": "samples", - "samples": [ - { - "labels": { - "job": "api" - }, - "value": 1.25 - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "413": { - "description": "请求或最终响应超过大小限制。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } - } - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" + }, + "description": "标准 HTTP 错误；error.reason：internal." }, - "499": { - "description": "客户端已取消查询。", + "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } - } - }, - "500": { - "$ref": "#/components/responses/ServerError" - }, - "503": { - "$ref": "#/components/responses/ServiceUnavailable" + }, + "description": "标准 HTTP 错误；error.reason：no_active_edge, edge_upgrade_required, mixed_edge_versions." }, "504": { - "description": "查询超时。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } - } + }, + "description": "标准 HTTP 错误；error.reason：timeout." } - } - } - }, - "/monit/query/diagnose": { - "post": { - "operationId": "monit-read-query-diagnose", - "summary": "数据源诊断", - "description": "执行同步诊断查询(Loki/VictoriaLogs 使用 `log_patterns`,Prometheus 使用 `metric_trends`)。Flashduty AI SRE 用于日志模式聚类与时间序列趋势分析。长耗时——最长可达 35 秒。 已弃用：迁移到 /monit/datasource/tools/invoke 的 prometheus.metric_trends、loki.log_patterns 或 victorialogs.log_patterns。为现有消费者保留，旧请求与响应保持不变。", + }, + "summary": "调用数据源工具", "tags": [ - "Monitors/诊断分析" + "Monitors/告警数据源" ], "x-mint": { - "content": "## 调用限制\n\n| 项 | 值 |\n| ------ | ----- |\n| 速率限制 | **600 次/分钟**;**10 次/秒** 每账户 |\n| 权限 | 任意有效的 `app_key`(只读;不受特定权限分类约束) |\n\n## 使用说明\n\n- 这是诊断 / RCA 接口,而非原始数据查询接口——如需查询底层数据,请配合 `/monit/query/data` 使用。\n- 仅支持三种 `ds_type` 与 `operation` 组合：`loki` / `victorialogs` → `log_patterns`，`prometheus` → `metric_trends`。即使显式传入 `operation`，其他数据源也会被拒绝。\n- `methods` 选择要执行的分析方法;省略时,`log_patterns` 默认为 `pattern_snapshot + pattern_compare(previous_window)`,`metric_trends` 默认为 `single_window_shape + window_compare(previous_window)`。\n- `time_range` 单位为 Unix 秒;缺失或无效时默认最近 15 分钟;窗口宽度超过 6 小时将被拒绝。\n- 请求通过 WebSocket 转发至 `monit-edge`。长耗时:边缘侧执行可能耗时约 30 秒,叠加 webapi 开销。客户端超时应至少设置为 **35 秒**。\n- `options.*` 由边缘侧设置上限(`max_logs_scanned` ≤ 50 000,`max_patterns` ≤ 50,`examples_per_pattern` ≤ 3,`step_seconds` ∈ [15, 300],`max_series` ≤ 200,`topk` ≤ 50,`timeout_seconds` ≤ 30)。\n- 成功响应体为原始 `{\"data\": ...}` 对象,不含通常的 `request_id` 包装字段（edge 侧原样透传）。\n- 存在两层错误:请求级失败返回非 200 状态码与标准 `error` 包装;边缘侧执行错误以 HTTP 200 返回,响应体中带 `error` 对象——务必同时检查两层。\n- 日志样例在返回前会经过基础脱敏处理,响应中会带 `warnings: [\"examples redacted\"]`。不可作为原始日志使用。", - "href": "/zh/api-reference/monitors/diagnostics/monit-read-query-diagnose", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **2,000 次/分钟**；**32 次/秒** |\n| 权限要求 | **数据源查看**（`monit`） |\n\n通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 diagnose 重试。", + "href": "/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke", "metadata": { - "sidebarTitle": "数据源诊断" + "sidebarTitle": "调用数据源工具" } - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DiagnoseRequest" - }, - "example": { - "account_id": 10001, - "ds_type": "victorialogs", - "ds_name": "vmlogs-read", - "operation": "log_patterns", - "time_range": { - "start": 1776847544, - "end": 1776849344 - }, - "methods": [ - { - "name": "pattern_snapshot" - }, - { - "name": "pattern_compare", - "baseline": "same_window_yesterday" - } - ], - "input": { - "query": "_stream:{status='500'}" - }, - "options": { - "max_logs_scanned": 10000, - "max_patterns": 20, - "examples_per_pattern": 2, - "timeout_seconds": 25 - } - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DiagnoseResponse" - } - } - } - ] - }, - "example": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "data": { - "schema_version": "2", - "operation": "log_patterns", - "ds_type": "loki", - "ds_name": "prod-loki", - "query": "{service=\"checkout\"}", - "window": { - "start": "2026-07-14T06:00:00Z", - "end": "2026-07-14T07:00:00Z" - }, - "data_handling": { - "log_redaction_applied": true, - "log_redaction_coverage": "best_effort", - "untrusted_data_fields": [ - "pattern_template", - "current_window.sources[].value", - "redacted_log_examples[]" - ] - }, - "results": [ - { - "method": "pattern_compare", - "baseline": "previous_window", - "window": { - "start": "2026-07-14T06:00:00Z", - "end": "2026-07-14T07:00:00Z" - }, - "baseline_window": { - "start": "2026-07-14T05:00:00Z", - "end": "2026-07-14T06:00:00Z" - }, - "summary": { - "current_sample": { - "logs_scanned": 10000, - "patterns_aggregated": 18, - "logs_not_aggregated_due_to_cluster_limit": 0, - "pattern_matching_limited": false, - "truncated": false - }, - "baseline_sample": { - "logs_scanned": 8000, - "patterns_aggregated": 20, - "logs_not_aggregated_due_to_cluster_limit": 0, - "pattern_matching_limited": false, - "truncated": false - }, - "patterns_aggregated_only_in_baseline_sample": 2, - "aggregated_pattern_evidence_total": 20, - "pattern_evidence_returned": 1, - "pattern_evidence_truncated_by_max_patterns": true, - "evidence_summary": "1 of 20 pattern evidence items are returned." - }, - "pattern_evidence": [ - { - "pattern_id": "8f1496a85df86ca1", - "pattern_template": "checkout request <*> failed", - "comparison_status": "comparable", - "current_window": { - "count": 12, - "share_of_scanned_logs": 0.0012, - "first_seen": "2026-07-14T06:03:00Z", - "last_seen": "2026-07-14T06:58:00Z", - "observed_severity_counts": { - "error": 12 - } - }, - "baseline_window": { - "count": 2, - "share_of_scanned_logs": 0.00025, - "first_seen": "2026-07-14T05:11:00Z", - "last_seen": "2026-07-14T05:44:00Z", - "observed_severity_counts": { - "error": 2 - } - }, - "observations": [ - "The current-sample count was 12 and the baseline-sample count was 2." - ], - "redacted_log_examples": [ - "checkout request failed" - ] - } - ], - "warnings": [] - } - ] - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "deprecated": true - } - }, - "/monit/datasource/tools/invoke": { - "post": { - "description": "对已配置的数据源执行单个确定性工具。要求集群所有当前在线可路由 Edge 会话支持 v0.71.0 基础 invoke 协议；具体工具可能需要更新实现。不提供工具目录、自动重放或 Agent/旧 diagnose 回退。请求体上限 128 KiB，完整成功响应上限 1 MiB，工具超时最多 25 秒。", - "operationId": "monit-datasource-tools-invoke", - "requestBody": { - "content": { - "application/json": { - "example": { - "datasource_id": 10, - "params": {}, - "tool": "mysql.overview" - }, - "schema": { - "$ref": "#/components/schemas/DatasourceToolInvokeRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "data": { - "version": "8.0.36" - }, - "datasource_id": 10, - "summary": "MySQL overview", - "tool": "mysql.overview" - }, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/DatasourceToolResult" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "成功" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：invalid_request, tool_not_supported, datasource_error." - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：access_denied." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：datasource_not_found." - }, - "409": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：datasource_disabled, datasource_in_use." - }, - "413": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：source_too_large, result_too_large." - }, - "429": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：overloaded." - }, - "499": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：canceled." - }, - "500": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：internal." - }, - "503": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：no_active_edge, edge_upgrade_required, mixed_edge_versions." - }, - "504": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - }, - "description": "标准 HTTP 错误；error.reason：timeout." - } - }, - "summary": "调用数据源工具", - "tags": [ - "Monitors/告警数据源" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **2,000 次/分钟**；**32 次/秒** |\n| 权限要求 | **数据源查看**（`monit`） |\n\n通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 diagnose 重试。", - "href": "/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke", - "metadata": { - "sidebarTitle": "调用数据源工具" - } - } - } - } - }, - "components": { - "securitySchemes": { - "AppKeyAuth": { - "type": "apiKey", - "in": "query", - "name": "app_key", - "description": "在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。" - } - }, - "responses": { - "BadRequest": { - "description": "请求非法 — 通常是参数缺失或格式不正确。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - }, - "examples": { - "missingParameter": { - "value": { - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", - "error": { - "code": "InvalidParameter", - "message": "The specified parameter is not valid." + } + } + } + }, + "components": { + "securitySchemes": { + "AppKeyAuth": { + "type": "apiKey", + "in": "query", + "name": "app_key", + "description": "在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。" + } + }, + "responses": { + "BadRequest": { + "description": "请求非法 — 通常是参数缺失或格式不正确。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + }, + "examples": { + "missingParameter": { + "value": { + "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4", + "error": { + "code": "InvalidParameter", + "message": "The specified parameter is not valid." } } } @@ -3561,36 +2909,6 @@ "updated_at" ] }, - "AlertRuleStatus": { - "type": "object", - "description": "文件夹节点的规则触发状态。", - "required": [ - "folder_id", - "rule_total", - "triggered_rule_count" - ], - "properties": { - "folder_id": { - "type": "integer", - "format": "uint64", - "description": "文件夹（分组节点）ID。" - }, - "folder_name": { - "type": "string", - "description": "文件夹名称；部分接口不返回该字段（`omitempty`）。" - }, - "rule_total": { - "type": "integer", - "format": "int64", - "description": "文件夹家族内规则总数。" - }, - "triggered_rule_count": { - "type": "integer", - "format": "int64", - "description": "有活跃告警的规则数量。" - } - } - }, "DSClickHouseConfig": { "type": "object", "description": "ClickHouse 数据源配置，TLS 字段继承自 TLSClientConfig。", @@ -4854,1489 +4172,532 @@ "enabled_times": { "type": "array", "items": { - "$ref": "#/components/schemas/EnabledTime" - }, - "description": "规则生效的时间窗口数组，元素结构见 `EnabledTime`。仅当 `fields` 包含 `enabled_times` 时生效。" - }, - "annotations": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "附加注解键值对，随告警事件下发；键不允许以 `$` 开头（该前缀保留给查询字段）。仅当 `fields` 包含 `annotations` 时生效。" - }, - "description": { - "type": "string", - "description": "规则描述（Markdown）。仅当 `fields` 包含 `description` 时生效。" - }, - "channel_ids": { - "type": "array", - "items": { - "type": "integer", - "format": "uint64" - }, - "description": "告警发送到的协作空间 ID 列表，可为空。仅当 `fields` 包含 `channel_ids` 时生效。" - }, - "repeat_interval": { - "type": "integer", - "format": "int64", - "description": "告警通知重复间隔（秒）。仅当 `fields` 包含 `repeat_interval` 时生效。" - }, - "repeat_total": { - "type": "integer", - "format": "int64", - "description": "最大重复通知次数。仅当 `fields` 包含 `repeat_total` 时生效。" - }, - "labels_patch": { - "$ref": "#/components/schemas/StringMapPatch", - "description": "标签的增量更新，仅在 `fields` 包含 `labels` 时生效；与 `labels` 同时发送时优先使用本字段。" - }, - "annotations_patch": { - "$ref": "#/components/schemas/StringMapPatch", - "description": "注解的增量更新，仅在 `fields` 包含 `annotations` 时生效；与 `annotations` 同时发送时优先使用本字段。" - } - } - }, - "RuleIDRequest": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "告警规则 ID，可通过 `POST /monit/rule/list/basic` 按文件夹查询获取。" - } - } - }, - "AuditRecordIDRequest": { - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "审计记录 ID——来自 `POST /monit/rule/audits` 返回行的 `id`，不是规则 ID。传规则 ID 会返回 HTTP 400。" - } - } - }, - "RuleIDsRequest": { - "type": "object", - "required": [ - "ids" - ], - "properties": { - "ids": { - "type": "array", - "items": { - "type": "integer", - "format": "uint64" - }, - "description": "规则 ID 列表。" - } - } - }, - "RuleImportRequest": { - "type": "array", - "description": "要导入的告警规则导出对象数组。", - "items": { - "$ref": "#/components/schemas/AlertRule" - } - }, - "RuleImportResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NameMessage" - }, - "description": "每条规则的导入结果。" - }, - "RuleListRequest": { - "type": "object", - "description": "按文件夹查询规则的过滤参数。", - "properties": { - "folder_id": { - "type": "integer", - "format": "uint64", - "description": "文件夹 ID，必须是已存在的文件夹；传 `0` 会返回 `folder_not_found` 错误。" - }, - "include_descendants": { - "type": "boolean", - "description": "是否同时包含所有子孙文件夹中的规则。为 `true` 时返回的每项仅包含 `id`、`folder_id`、`name` 三个字段；配合 `query` / `limit` 用于规则选择器场景。" - }, - "query": { - "type": "string", - "description": "规则名模糊过滤，仅在 `include_descendants` 为 `true` 时生效。" - }, - "limit": { - "type": "integer", - "default": 50, - "maximum": 100, - "description": "返回规则数量上限，仅在 `include_descendants` 为 `true` 时生效。默认 50，最大 100。" - } - } - }, - "RuleMoveRequest": { - "type": "object", - "required": [ - "ids", - "dest_folder_id" - ], - "properties": { - "ids": { - "type": "array", - "items": { - "type": "integer", - "format": "uint64" - }, - "description": "要移动的规则 ID 列表。" - }, - "dest_folder_id": { - "type": "integer", - "format": "uint64", - "description": "目标文件夹 ID，可通过 `POST /monit/folder/list` 获取。" - } - } - }, - "RuleNameMessageListResponse": { - "type": "array", - "description": "批量规则操作中每条规则的处理结果列表。", - "items": { - "$ref": "#/components/schemas/NameMessage" - } - }, - "RuleStatusResponse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AlertRuleStatus" - } - }, - "SLSLogstoresRequest": { - "type": "object", - "description": "查询 SLS 日志库列表的参数。", - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "SLS 类型数据源的 ID，可通过 `POST /monit/datasource/list` 获取。" - }, - "project": { - "type": "string", - "description": "SLS 项目名称，可通过 `POST /monit/datasource/sls/projects` 查询获取。" - }, - "offset": { - "type": "integer", - "description": "分页偏移量。" - }, - "size": { - "type": "integer", - "description": "每页大小，传 0 时服务端默认 200。" - } - }, - "required": [ - "id" - ] - }, - "SLSLogstoresResponse": { - "type": "array", - "description": "SLS 日志库名称列表。", - "items": { - "type": "string" - } - }, - "SLSProjectsRequest": { - "type": "object", - "description": "查询 SLS 项目列表的参数。", - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "SLS 类型数据源的 ID，可通过 `POST /monit/datasource/list` 获取。" - }, - "query": { - "type": "string", - "description": "按项目描述模糊过滤（对应阿里云 SLS ListProject 的 description 参数），留空返回全部。" - }, - "offset": { - "type": "integer", - "description": "分页偏移量。" - }, - "size": { - "type": "integer", - "description": "每页大小，传 0 时服务端默认 200。" - } - }, - "required": [ - "id" - ] - }, - "SLSProjectsResponse": { - "type": "object", - "description": "一页阿里云 SLS 项目。", - "required": [ - "projects", - "count", - "total" - ], - "properties": { - "projects": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SLSProject" - }, - "description": "当前页的项目列表。" - }, - "count": { - "type": "integer", - "description": "本页项目数量。" - }, - "total": { - "type": "integer", - "description": "匹配 `query` 的项目总数，与分页无关。" - } - } - }, - "StoreRulesetItem": { - "type": "object", - "description": "单个规则仓库规则集。", - "required": [ - "id", - "type_ident", - "note", - "open_flag", - "creator_account_id", - "creator_id", - "creator_name", - "created_at", - "updated_at" - ], - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "规则集 ID。" - }, - "type_ident": { - "type": "string", - "description": "该规则集适用的数据源类型标识符。" - }, - "note": { - "type": "string", - "description": "规则集描述或标题。" - }, - "open_flag": { - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "description": "共享范围：`0` 私有（创建者与账户管理员可见），`1` 账户内共享，`2` 公开。" - }, - "payload": { - "type": "string", - "description": "包含告警规则定义的 JSON 字符串，列表接口中省略。" - }, - "creator_account_id": { - "type": "integer", - "format": "uint64", - "description": "创建者的账户 ID。" - }, - "creator_id": { - "type": "integer", - "format": "uint64", - "description": "创建者的成员 ID。" - }, - "creator_name": { - "type": "string", - "description": "创建者显示名称。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间，Unix 时间戳（秒）。" - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "最后更新时间，Unix 时间戳（秒）。" - } - } - }, - "StoreRulesetListRequest": { - "type": "object", - "required": [ - "type_ident" - ], - "description": "按数据源类型过滤规则集。", - "properties": { - "type_ident": { - "type": "string", - "description": "数据源类型标识符，如 `prometheus`。" - } - } - }, - "StoreRulesetListResponse": { - "type": "array", - "description": "当前用户有权访问的规则集列表，不含 `payload` 字段。", - "items": { - "$ref": "#/components/schemas/StoreRulesetItem" - } - }, - "StoreRulesetUpdateRequest": { - "type": "object", - "required": [ - "id", - "note", - "payload" - ], - "description": "更新规则集的参数。", - "properties": { - "id": { - "type": "integer", - "format": "uint64", - "description": "要更新的规则集 ID。" - }, - "note": { - "type": "string", - "description": "新的描述。" - }, - "open_flag": { - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "description": "新的共享范围：`0` 私有（创建者与账户管理员可见），`1` 账户共享，`2` 公开。" - }, - "payload": { - "type": "string", - "description": "新的告警规则定义 JSON 字符串。" - } - } - }, - "StoreRulesetUpsertRequest": { - "type": "object", - "description": "创建规则集的请求体，所有字段均经服务端 `Validate()` 校验。", - "required": [ - "type_ident", - "note", - "payload" - ], - "properties": { - "type_ident": { - "type": "string", - "description": "该规则集适用的数据源类型标识符，如 `prometheus`。" - }, - "note": { - "type": "string", - "description": "规则集描述或标题。" - }, - "open_flag": { - "type": "integer", - "enum": [ - 0, - 1, - 2 - ], - "description": "共享范围：`0` 私有（创建者与账户管理员可见），`1` 账户内共享，`2` 公开。省略时默认为 `0`。" - }, - "payload": { - "type": "string", - "description": "包含告警规则定义的 JSON 字符串。" - } - } - }, - "SuccessEnvelope": { - "type": "object", - "description": "成功响应结构。2xx 响应中 `request_id` 标识本次调用（同时出现在 `Flashcat-Request-Id` 响应头中），`data` 为接口业务 payload。失败响应使用不同结构，参见 `ErrorResponse`。", - "properties": { - "request_id": { - "type": "string", - "description": "本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。", - "example": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "data": { - "description": "每个接口自己的业务 payload，详见各接口的 200 响应 schema。" - } - }, - "required": [ - "request_id", - "data" - ] - }, - "QueryDataRequest": { - "description": "稳定结构化查询接口的请求。字段与已下线的 rows 接口一致。", - "allOf": [ - { - "$ref": "#/components/schemas/QueryRowsRequest" - } - ] - }, - "QueryDataResponse": { - "type": "object", - "description": "与 Edge 版本无关的稳定结构化查询响应。", - "required": [ - "format", - "result" - ], - "properties": { - "format": { - "type": "string", - "enum": [ - "query_result.v1" - ], - "description": "公开结果契约版本，与 monit-edge 内部查询协议版本相互独立。固定为 `query_result.v1`，`result` 字段的结构由该契约定义。" - }, - "result": { - "$ref": "#/components/schemas/QueryResult" - } - } - }, - "QueryResult": { - "description": "由 `kind` 选择且严格互斥的自然结果形态。", - "oneOf": [ - { - "$ref": "#/components/schemas/QueryFramesResult" - }, - { - "$ref": "#/components/schemas/QueryRecordsResult" - }, - { - "$ref": "#/components/schemas/QuerySamplesResult" - } - ], - "discriminator": { - "propertyName": "kind", - "mapping": { - "frames": "#/components/schemas/QueryFramesResult", - "records": "#/components/schemas/QueryRecordsResult", - "samples": "#/components/schemas/QuerySamplesResult" - } - } - }, - "QueryFramesResult": { - "type": "object", - "required": [ - "kind", - "frames" - ], - "properties": { - "kind": { - "type": "string", - "enum": [ - "frames" - ], - "description": "结果类型判别字段，固定为 `frames`，表示 `frames` 载荷为类型化表格/时序 Frame。" - }, - "frames": { - "type": "array", - "description": "类型化表格或时序 Frame。一次响应可以包含多个 Frame。", - "items": { - "$ref": "#/components/schemas/QueryFrame" - } - } - } - }, - "QueryFrame": { - "type": "object", - "description": "类型化列式表格或时序 Frame。同一 Frame 的所有字段拥有相同数量的值。`time_series` Frame 包含一个 time 字段和一个 float 字段，序列标签位于 float 字段。", - "required": [ - "kind", - "fields" - ], - "properties": { - "kind": { - "type": "string", - "enum": [ - "table", - "time_series" - ], - "description": "Frame 类型：`table` 为通用表格，`time_series` 为时序（恰含一个 time 字段和一个 float 字段）。" - }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QueryField" - }, - "description": "Frame 的列集合；同一 Frame 内所有字段的 `values` 长度一致，第 i 行由各字段 `values[i]` 组成。" - } - } - }, - "QueryField": { - "type": "object", - "description": "一个类型化列。`string` 字段包含字符串或 null；`time` 字段包含 RFC 3339 Nano 字符串或 null；`float` 字段包含数字、null 或特殊字符串 `NaN`、`+Inf`、`-Inf`。", - "required": [ - "name", - "type", - "values" - ], - "properties": { - "name": { - "type": "string", - "description": "列名；时序 Frame 的 float 字段上以 `labels` 区分不同序列，`name` 通常为指标名。" - }, - "type": { - "type": "string", - "enum": [ - "string", - "float", - "time" - ], - "description": "列值类型，决定 `values` 元素的编码：`string` 为字符串或 null，`float` 为数值/`NaN`/`±Inf` 字符串或 null，`time` 为 RFC 3339 Nano 字符串或 null。" + "$ref": "#/components/schemas/EnabledTime" + }, + "description": "规则生效的时间窗口数组，元素结构见 `EnabledTime`。仅当 `fields` 包含 `enabled_times` 时生效。" }, - "labels": { + "annotations": { "type": "object", - "description": "序列标签，出现在时序 Frame 的 float 字段上。", "additionalProperties": { "type": "string" - } + }, + "description": "附加注解键值对，随告警事件下发；键不允许以 `$` 开头（该前缀保留给查询字段）。仅当 `fields` 包含 `annotations` 时生效。" }, - "values": { + "description": { + "type": "string", + "description": "规则描述（Markdown）。仅当 `fields` 包含 `description` 时生效。" + }, + "channel_ids": { "type": "array", "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "null" - } - ] + "type": "integer", + "format": "uint64" }, - "description": "该列的全部值，按行序排列；长度与 Frame 内其他字段一致。" + "description": "告警发送到的协作空间 ID 列表，可为空。仅当 `fields` 包含 `channel_ids` 时生效。" + }, + "repeat_interval": { + "type": "integer", + "format": "int64", + "description": "告警通知重复间隔（秒）。仅当 `fields` 包含 `repeat_interval` 时生效。" + }, + "repeat_total": { + "type": "integer", + "format": "int64", + "description": "最大重复通知次数。仅当 `fields` 包含 `repeat_total` 时生效。" + }, + "labels_patch": { + "$ref": "#/components/schemas/StringMapPatch", + "description": "标签的增量更新，仅在 `fields` 包含 `labels` 时生效；与 `labels` 同时发送时优先使用本字段。" + }, + "annotations_patch": { + "$ref": "#/components/schemas/StringMapPatch", + "description": "注解的增量更新，仅在 `fields` 包含 `annotations` 时生效；与 `annotations` 同时发送时优先使用本字段。" } } }, - "QueryRecordsResult": { + "RuleIDRequest": { "type": "object", "required": [ - "kind", - "records" + "id" ], "properties": { - "kind": { - "type": "string", - "enum": [ - "records" - ], - "description": "结果类型判别字段，固定为 `records`，表示 `records` 载荷为 schema 灵活的记录数组。" - }, - "records": { - "type": "array", - "description": "schema 灵活的 records。不同 record 可以拥有不同字段、包含嵌套 JSON 或为 null。超出 JavaScript 安全范围的整数会编码为十进制字符串。", - "items": { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "null" - } - ] - } + "id": { + "type": "integer", + "format": "uint64", + "description": "告警规则 ID，可通过 `POST /monit/rule/list/basic` 按文件夹查询获取。" } } }, - "QuerySamplesResult": { + "AuditRecordIDRequest": { "type": "object", "required": [ - "kind", - "samples" + "id" ], "properties": { - "kind": { - "type": "string", - "enum": [ - "samples" - ], - "description": "结果类型判别字段，固定为 `samples`，表示 `samples` 载荷为带标签的瞬时样本数组。" - }, - "samples": { - "type": "array", - "description": "带完整标签集合的瞬时样本。", - "items": { - "$ref": "#/components/schemas/QuerySample" - } + "id": { + "type": "integer", + "format": "uint64", + "description": "审计记录 ID——来自 `POST /monit/rule/audits` 返回行的 `id`，不是规则 ID。传规则 ID 会返回 HTTP 400。" } } }, - "QuerySample": { + "RuleIDsRequest": { "type": "object", "required": [ - "labels", - "value" + "ids" ], "properties": { - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" + "ids": { + "type": "array", + "items": { + "type": "integer", + "format": "uint64" }, - "description": "样本的完整标签集合；可为空对象但字段始终存在。" - }, - "value": { - "description": "有限数值，或非有限浮点数的 JSON 安全表示。", - "oneOf": [ - { - "type": "number" - }, - { - "type": "string", - "enum": [ - "NaN", - "+Inf", - "-Inf" - ] - } - ] + "description": "规则 ID 列表。" } } }, - "QueryRowsRequest": { - "type": "object", - "required": [ - "ds_type", - "ds_name", - "expr" - ], - "properties": { - "account_id": { - "type": "integer", - "format": "int64", - "description": "可选的一致性校验。若提供,必须等于已认证账户;不一致将被拒绝。业务执行始终使用已认证账户。" - }, - "ds_type": { - "type": "string", - "description": "数据源类型;必须匹配租户下已配置的数据源。示例:`prometheus`、`loki`、`victorialogs`、`sls`、`elasticsearch`、`mysql`、`postgres`、`oracle`、`clickhouse`。" - }, - "ds_name": { - "type": "string", - "description": "数据源名称;必须匹配租户下已配置的数据源。" - }, - "expr": { - "type": "string", - "description": "查询表达式。语法取决于 `ds_type`,由对应的 monit-edge 客户端解释(Prometheus 用 PromQL,Loki 用 LogQL,SQL 类数据源用 SQL,等等)。" - }, - "delay_seconds": { - "type": "integer", - "description": "应用于点查询(Prometheus、Loki stats、VictoriaLogs stats)的回看偏移,单位秒。明细 / raw 查询忽略该字段。", - "default": 0 - }, - "args": { - "type": "object", - "description": "透传给 monit-edge 的多态键值扩展参数。所有值必须是字符串，键一律按数据源加前缀（如 `sls.project`、`loki.type`）。校验规则取决于 `ds_type`：SLS 必须提供 `sls.project` 与 `sls.logstore`；Elasticsearch 的 `es.type` 只接受 `sql` 或不传，其他值一律拒绝；Loki 与 VictoriaLogs 的 `.type` 接受 `stats`、`raw` 或不传，其中 `raw` 还必须给出时间范围——`.start` + `.end`，或 `.timespan.value` + `.timespan.unit`（单位取 `s`/`m`/`h`/`d`）。Prometheus 及其余 SQL 类数据源完全忽略 `args`。", - "additionalProperties": { - "type": "string" - } - } + "RuleImportRequest": { + "type": "array", + "description": "要导入的告警规则导出对象数组。", + "items": { + "$ref": "#/components/schemas/AlertRule" } }, - "DiagnoseRequest": { + "RuleImportResponse": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NameMessage" + }, + "description": "每条规则的导入结果。" + }, + "RuleListRequest": { "type": "object", - "required": [ - "ds_type", - "ds_name", - "input" - ], + "description": "按文件夹查询规则的过滤参数。", "properties": { - "account_id": { + "folder_id": { "type": "integer", - "format": "int64", - "description": "可选的一致性校验。若提供,必须等于已认证账户。" - }, - "ds_type": { - "type": "string", - "description": "数据源类型。`log_patterns` 支持 `loki` 与 `victorialogs`;`metric_trends` 支持 `prometheus`。" - }, - "ds_name": { - "type": "string", - "description": "租户下已配置的数据源名称。" - }, - "operation": { - "type": "string", - "enum": [ - "log_patterns", - "metric_trends" - ], - "description": "诊断操作类型。省略时根据 `ds_type` 推断(loki / victorialogs → `log_patterns`,prometheus → `metric_trends`)。其他数据源必须显式指定。" - }, - "time_range": { - "type": "object", - "description": "诊断窗口,Unix 秒。缺失或无效时默认最近 15 分钟;窗口宽度超过 6 小时将被拒绝。", - "properties": { - "start": { - "type": "integer", - "format": "int64", - "description": "窗口起点,Unix 秒。" - }, - "end": { - "type": "integer", - "format": "int64", - "description": "窗口终点,Unix 秒。" - } - } - }, - "methods": { - "type": "array", - "description": "要执行的诊断方法。省略时,`log_patterns` 默认为 `pattern_snapshot + pattern_compare(previous_window)`,`metric_trends` 默认为 `single_window_shape + window_compare(previous_window)`。", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "`log_patterns` 支持 `pattern_snapshot`、`pattern_compare`。`metric_trends` 支持 `single_window_shape`、`window_compare`。" - }, - "baseline": { - "type": "string", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "description": "仅对 compare 类方法有意义。默认 `previous_window`。`previous_window` = 紧接当前窗口之前的等长窗口；`same_window_yesterday` = 当前窗口整体前移 24 小时；`same_window_last_week` = 当前窗口整体前移 7 天。" - } - } - } - }, - "input": { - "type": "object", - "required": [ - "query" - ], - "properties": { - "query": { - "type": "string", - "description": "查询表达式。`log_patterns` 使用 LogQL / VictoriaLogs 查询语法;`metric_trends` 使用 PromQL。" - } - }, - "description": "诊断输入。`query` 必填：`log_patterns` 使用 LogQL / VictoriaLogs 查询语法，`metric_trends` 使用 PromQL。" + "format": "uint64", + "description": "文件夹 ID，必须是已存在的文件夹；传 `0` 会返回 `folder_not_found` 错误。" }, - "options": { - "type": "object", - "description": "执行选项,所有值均受 monit-edge 上限约束。", - "properties": { - "max_logs_scanned": { - "type": "integer", - "description": "单窗口日志扫描上限。默认 10 000,硬上限 50 000。" - }, - "max_patterns": { - "type": "integer", - "description": "返回的最大模式数。默认 20,硬上限 50。" - }, - "examples_per_pattern": { - "type": "integer", - "description": "每个模式返回的脱敏样例最大条数。默认 2,硬上限 3。" - }, - "step_seconds": { - "type": "integer", - "description": "`metric_trends` 的 query_range 步长。默认 60,取值范围 [15, 300]。" - }, - "max_series": { - "type": "integer", - "description": "`metric_trends` 考察的最大序列数。默认 50,硬上限 200。" - }, - "topk": { - "type": "integer", - "description": "`metric_trends` 返回的显著序列最大数量。默认 10,硬上限 50。" - }, - "timeout_seconds": { - "type": "integer", - "description": "边缘侧诊断超时,单位秒。默认 25,硬上限 30。" - } - } - } - } - }, - "DiagnoseResponse": { - "description": "按 `operation` 返回 schema v2 诊断证据。先检查 `operation`，再按 `results[].method` 处理对应的日志模式或指标趋势证据。", - "oneOf": [ - { - "$ref": "#/components/schemas/DiagnoseLogPatternResponse" + "include_descendants": { + "type": "boolean", + "description": "是否同时包含所有子孙文件夹中的规则。为 `true` 时返回的每项仅包含 `id`、`folder_id`、`name` 三个字段；配合 `query` / `limit` 用于规则选择器场景。" }, - { - "$ref": "#/components/schemas/DiagnoseMetricTrendResponse" - } - ], - "discriminator": { - "propertyName": "operation", - "mapping": { - "log_patterns": "#/components/schemas/DiagnoseLogPatternResponse", - "metric_trends": "#/components/schemas/DiagnoseMetricTrendResponse" + "query": { + "type": "string", + "description": "规则名模糊过滤，仅在 `include_descendants` 为 `true` 时生效。" + }, + "limit": { + "type": "integer", + "default": 50, + "maximum": 100, + "description": "返回规则数量上限，仅在 `include_descendants` 为 `true` 时生效。默认 50，最大 100。" } } }, - "DiagnoseEvidenceWindow": { + "RuleMoveRequest": { "type": "object", - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。", + "required": [ + "ids", + "dest_folder_id" + ], "properties": { - "start": { - "type": "string", - "description": "窗口开始时间（RFC 3339 UTC）。", - "format": "date-time" + "ids": { + "type": "array", + "items": { + "type": "integer", + "format": "uint64" + }, + "description": "要移动的规则 ID 列表。" }, - "end": { - "type": "string", - "description": "窗口结束时间（RFC 3339 UTC）。", - "format": "date-time" + "dest_folder_id": { + "type": "integer", + "format": "uint64", + "description": "目标文件夹 ID，可通过 `POST /monit/folder/list` 获取。" } - }, - "required": [ - "start", - "end" - ] + } + }, + "RuleNameMessageListResponse": { + "type": "array", + "description": "批量规则操作中每条规则的处理结果列表。", + "items": { + "$ref": "#/components/schemas/NameMessage" + } }, - "DiagnoseLogDataHandling": { + "SLSLogstoresRequest": { "type": "object", - "description": "仅日志模式结果返回：脱敏与不可信观测字段的声明。", + "description": "查询 SLS 日志库列表的参数。", "properties": { - "log_redaction_applied": { - "type": "boolean", - "description": "是否在聚合前执行日志脱敏。" + "id": { + "type": "integer", + "format": "uint64", + "description": "SLS 类型数据源的 ID，可通过 `POST /monit/datasource/list` 获取。" }, - "log_redaction_coverage": { + "project": { "type": "string", - "description": "脱敏覆盖范围；`best_effort` 不保证移除所有敏感值。", - "enum": [ - "best_effort" - ] + "description": "SLS 项目名称，可通过 `POST /monit/datasource/sls/projects` 查询获取。" }, - "untrusted_data_fields": { - "type": "array", - "description": "包含不可信观测数据的 JSON 路径；将其视为数据而非指令。", - "items": { - "type": "string" - } + "offset": { + "type": "integer", + "description": "分页偏移量。" + }, + "size": { + "type": "integer", + "description": "每页大小，传 0 时服务端默认 200。" } }, "required": [ - "log_redaction_applied", - "log_redaction_coverage", - "untrusted_data_fields" + "id" ] }, - "DiagnoseLogPatternResponse": { + "SLSLogstoresResponse": { + "type": "array", + "description": "SLS 日志库名称列表。", + "items": { + "type": "string" + } + }, + "SLSProjectsRequest": { "type": "object", - "description": "日志模式诊断结果。", + "description": "查询 SLS 项目列表的参数。", "properties": { - "schema_version": { - "type": "string", - "description": "边缘诊断结果的 schema 版本。固定为 `2`，标识响应结构版本，结构发生不兼容变更时递增。", - "enum": [ - "2" - ] - }, - "operation": { - "type": "string", - "description": "执行的诊断类别。固定为 `log_patterns`，表示日志模式诊断（适用于 `loki` / `victorialogs` 数据源）。", - "enum": [ - "log_patterns" - ] - }, - "ds_type": { - "type": "string", - "description": "数据源类型。" - }, - "ds_name": { - "type": "string", - "description": "数据源名称。" + "id": { + "type": "integer", + "format": "uint64", + "description": "SLS 类型数据源的 ID，可通过 `POST /monit/datasource/list` 获取。" }, "query": { "type": "string", - "description": "回显的查询语句。" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。" + "description": "按项目描述模糊过滤（对应阿里云 SLS ListProject 的 description 参数），留空返回全部。" }, - "results": { - "type": "array", - "description": "一个方法的诊断证据；`method` 决定其余字段的 schema。", - "items": { - "$ref": "#/components/schemas/DiagnoseResult" - } + "offset": { + "type": "integer", + "description": "分页偏移量。" }, - "data_handling": { - "$ref": "#/components/schemas/DiagnoseLogDataHandling" + "size": { + "type": "integer", + "description": "每页大小，传 0 时服务端默认 200。" } }, "required": [ - "schema_version", - "operation", - "ds_type", - "ds_name", - "query", - "window", - "results", - "data_handling" + "id" ] }, - "DiagnoseLogPatternResult": { + "SLSProjectsResponse": { "type": "object", - "description": "日志模式方法的证据。", + "description": "一页阿里云 SLS 项目。", + "required": [ + "projects", + "count", + "total" + ], "properties": { - "method": { - "type": "string", - "description": "执行的诊断方法。`pattern_snapshot` = 仅对当前窗口做日志模式聚合快照，不涉及基线；`pattern_compare` = 当前窗口与基线窗口（见 `baseline`）之间的模式对比。", - "enum": [ - "pattern_snapshot", - "pattern_compare" - ] - }, - "baseline": { - "type": "string", - "description": "比较方法使用的基线窗口类型。`previous_window` = 紧接当前窗口之前的等长窗口；`same_window_yesterday` = 当前窗口整体前移 24 小时；`same_window_last_week` = 当前窗口整体前移 7 天。仅 `pattern_compare` 结果携带该字段。", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "x-flashduty-preserve-absence": true - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。" - }, - "baseline_window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "比较方法使用的基线时间窗口。", - "x-flashduty-preserve-absence": true - }, - "summary": { - "$ref": "#/components/schemas/DiagnoseMethodSummary" - }, - "pattern_evidence": { + "projects": { "type": "array", - "description": "按 RCA 相关性排序的日志模式证据。", "items": { - "$ref": "#/components/schemas/LogPatternEvidence" - } + "$ref": "#/components/schemas/SLSProject" + }, + "description": "当前页的项目列表。" }, - "warnings": { - "type": "array", - "description": "执行期间产生的非致命告警。", - "items": { - "type": "string" - } - } - }, - "required": [ - "method", - "window", - "summary", - "pattern_evidence", - "warnings" - ] - }, - "DiagnoseMethodSummary": { - "description": "日志模式和指标趋势方法使用的摘要。", - "oneOf": [ - { - "$ref": "#/components/schemas/LogPatternDiagnoseSummary" + "count": { + "type": "integer", + "description": "本页项目数量。" }, - { - "$ref": "#/components/schemas/MetricTrendDiagnoseSummary" + "total": { + "type": "integer", + "description": "匹配 `query` 的项目总数，与分页无关。" } - ] + } }, - "DiagnoseMetricTrendResponse": { + "SuccessEnvelope": { "type": "object", - "description": "指标趋势诊断结果。", + "description": "成功响应结构。2xx 响应中 `request_id` 标识本次调用（同时出现在 `Flashcat-Request-Id` 响应头中），`data` 为接口业务 payload。失败响应使用不同结构，参见 `ErrorResponse`。", "properties": { - "schema_version": { - "type": "string", - "description": "边缘诊断结果的 schema 版本。固定为 `2`，标识响应结构版本，结构发生不兼容变更时递增。", - "enum": [ - "2" - ] - }, - "operation": { - "type": "string", - "description": "执行的诊断类别。固定为 `metric_trends`，表示指标趋势诊断（适用于 `prometheus` 兼容数据源）。", - "enum": [ - "metric_trends" - ] - }, - "ds_type": { - "type": "string", - "description": "数据源类型。" - }, - "ds_name": { - "type": "string", - "description": "数据源名称。" - }, - "query": { + "request_id": { "type": "string", - "description": "回显的查询语句。" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。" + "description": "本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。", + "example": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, - "results": { - "type": "array", - "description": "一个方法的诊断证据；`method` 决定其余字段的 schema。", - "items": { - "$ref": "#/components/schemas/DiagnoseResult" - } + "data": { + "description": "每个接口自己的业务 payload，详见各接口的 200 响应 schema。" } }, "required": [ - "schema_version", - "operation", - "ds_type", - "ds_name", - "query", - "window", - "results" + "request_id", + "data" + ] + }, + "QueryDataRequest": { + "description": "稳定结构化查询接口的请求。字段与已下线的 rows 接口一致。", + "allOf": [ + { + "$ref": "#/components/schemas/QueryRowsRequest" + } ] }, - "DiagnoseMetricTrendResult": { + "QueryDataResponse": { "type": "object", - "description": "指标趋势方法的证据。", + "description": "与 Edge 版本无关的稳定结构化查询响应。", + "required": [ + "format", + "result" + ], "properties": { - "method": { - "type": "string", - "description": "执行的诊断方法。`single_window_shape` = 仅分析当前窗口内指标的形态（趋势与形状），不涉及基线；`window_compare` = 当前窗口与基线窗口（见 `baseline`）之间的逐序列对比。", - "enum": [ - "single_window_shape", - "window_compare" - ] - }, - "baseline": { + "format": { "type": "string", - "description": "比较方法使用的基线窗口类型。`previous_window` = 紧接当前窗口之前的等长窗口；`same_window_yesterday` = 当前窗口整体前移 24 小时；`same_window_last_week` = 当前窗口整体前移 7 天。仅 `window_compare` 结果携带该字段。", "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" + "query_result.v1" ], - "x-flashduty-preserve-absence": true - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。" - }, - "baseline_window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "比较方法使用的基线时间窗口。", - "x-flashduty-preserve-absence": true - }, - "summary": { - "$ref": "#/components/schemas/DiagnoseMethodSummary" - }, - "series_evidence": { - "type": "array", - "description": "每条返回序列的指标证据。", - "items": { - "$ref": "#/components/schemas/MetricTrendSeriesEvidence" - } + "description": "公开结果契约版本，与 monit-edge 内部查询协议版本相互独立。固定为 `query_result.v1`，`result` 字段的结构由该契约定义。" }, - "warnings": { - "type": "array", - "description": "执行期间产生的非致命告警。", - "items": { - "type": "string" - } + "result": { + "$ref": "#/components/schemas/QueryResult" } - }, - "required": [ - "method", - "window", - "summary", - "series_evidence", - "warnings" - ] + } }, - "DiagnoseResult": { - "description": "一个方法的诊断证据；`method` 决定其余字段的 schema。", + "QueryResult": { + "description": "由 `kind` 选择且严格互斥的自然结果形态。", "oneOf": [ { - "$ref": "#/components/schemas/DiagnoseLogPatternResult" + "$ref": "#/components/schemas/QueryFramesResult" + }, + { + "$ref": "#/components/schemas/QueryRecordsResult" }, { - "$ref": "#/components/schemas/DiagnoseMetricTrendResult" + "$ref": "#/components/schemas/QuerySamplesResult" } ], "discriminator": { - "propertyName": "method", + "propertyName": "kind", "mapping": { - "pattern_snapshot": "#/components/schemas/DiagnoseLogPatternResult", - "pattern_compare": "#/components/schemas/DiagnoseLogPatternResult", - "single_window_shape": "#/components/schemas/DiagnoseMetricTrendResult", - "window_compare": "#/components/schemas/DiagnoseMetricTrendResult" + "frames": "#/components/schemas/QueryFramesResult", + "records": "#/components/schemas/QueryRecordsResult", + "samples": "#/components/schemas/QuerySamplesResult" + } + } + }, + "QueryFramesResult": { + "type": "object", + "required": [ + "kind", + "frames" + ], + "properties": { + "kind": { + "type": "string", + "enum": [ + "frames" + ], + "description": "结果类型判别字段，固定为 `frames`，表示 `frames` 载荷为类型化表格/时序 Frame。" + }, + "frames": { + "type": "array", + "description": "类型化表格或时序 Frame。一次响应可以包含多个 Frame。", + "items": { + "$ref": "#/components/schemas/QueryFrame" + } } } }, - "LogPatternDiagnoseSummary": { + "QueryFrame": { "type": "object", - "description": "日志采样、聚合与返回范围的摘要。", + "description": "类型化列式表格或时序 Frame。同一 Frame 的所有字段拥有相同数量的值。`time_series` Frame 包含一个 time 字段和一个 float 字段，序列标签位于 float 字段。", + "required": [ + "kind", + "fields" + ], "properties": { - "current_sample": { - "$ref": "#/components/schemas/LogPatternSampleSummary", - "description": "当前窗口的日志采样摘要。" - }, - "baseline_sample": { - "$ref": "#/components/schemas/LogPatternSampleSummary", - "description": "基线窗口的日志采样摘要。", - "x-flashduty-preserve-absence": true - }, - "patterns_aggregated_only_in_baseline_sample": { - "type": "integer", - "description": "只在基线采样中观测到的已聚合模式数量。采样不完整时省略。", - "format": "int64", - "x-flashduty-preserve-absence": true - }, - "aggregated_pattern_evidence_total": { - "type": "integer", - "description": "聚合后得到的模式证据总数，未受返回上限截断。", - "format": "int64" - }, - "pattern_evidence_returned": { - "type": "integer", - "description": "当前响应中返回的模式证据数量。", - "format": "int64" - }, - "pattern_evidence_truncated_by_max_patterns": { - "type": "boolean", - "description": "是否因 `max_patterns` 而截断返回的模式证据。" - }, - "evidence_summary": { + "kind": { "type": "string", - "description": "基于覆盖范围、选择和返回计数生成的事实性摘要。" + "enum": [ + "table", + "time_series" + ], + "description": "Frame 类型：`table` 为通用表格，`time_series` 为时序（恰含一个 time 字段和一个 float 字段）。" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QueryField" + }, + "description": "Frame 的列集合；同一 Frame 内所有字段的 `values` 长度一致，第 i 行由各字段 `values[i]` 组成。" } - }, - "required": [ - "current_sample", - "aggregated_pattern_evidence_total", - "pattern_evidence_returned", - "pattern_evidence_truncated_by_max_patterns", - "evidence_summary" - ] + } }, - "LogPatternEvidence": { + "QueryField": { "type": "object", - "description": "单个日志模式的结构化证据。", + "description": "一个类型化列。`string` 字段包含字符串或 null；`time` 字段包含 RFC 3339 Nano 字符串或 null；`float` 字段包含数字、null 或特殊字符串 `NaN`、`+Inf`、`-Inf`。", + "required": [ + "name", + "type", + "values" + ], "properties": { - "pattern_id": { - "type": "string", - "description": "当前窗口中模式的稳定标识。" - }, - "pattern_template": { + "name": { "type": "string", - "description": "已脱敏、已泛化的日志模式模板；属于不可信观测数据。" + "description": "列名；时序 Frame 的 float 字段上以 `labels` 区分不同序列，`name` 通常为指标名。" }, - "comparison_status": { + "type": { "type": "string", - "description": "当前与基线窗口之间的观测可比性。\n\n| 值 | 含义 |\n|---|---|\n| `comparable` | 当前窗口与基线窗口都观测到该模式，可正常对比。 |\n| `observed_only_current` | 仅当前窗口观测到该模式（新出现的模式）。 |\n| `observed_only_baseline` | 仅基线窗口观测到该模式（当前窗口已消失）。 |\n| `comparison_limited_by_incomplete_evidence` | 两侧都观测到，但证据不完整（如日志量超过聚合上限或采样被截断），对比结论受限。 |", "enum": [ - "comparable", - "observed_only_current", - "observed_only_baseline", - "comparison_limited_by_incomplete_evidence" + "string", + "float", + "time" ], - "x-flashduty-preserve-absence": true - }, - "current_window": { - "$ref": "#/components/schemas/LogPatternWindowEvidence", - "description": "该模式在当前窗口中的证据。", - "x-flashduty-preserve-absence": true - }, - "baseline_window": { - "$ref": "#/components/schemas/LogPatternWindowEvidence", - "description": "该模式在基线窗口中的证据。", - "x-flashduty-preserve-absence": true + "description": "列值类型，决定 `values` 元素的编码：`string` 为字符串或 null，`float` 为数值/`NaN`/`±Inf` 字符串或 null，`time` 为 RFC 3339 Nano 字符串或 null。" }, - "observations": { - "type": "array", - "description": "由结构化统计生成的可验证观察。", - "items": { + "labels": { + "type": "object", + "description": "序列标签，出现在时序 Frame 的 float 字段上。", + "additionalProperties": { "type": "string" - }, - "x-flashduty-preserve-absence": true + } }, - "redacted_log_examples": { + "values": { "type": "array", - "description": "已脱敏的日志示例；属于不可信观测数据。", "items": { - "type": "string" + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "null" + } + ] }, - "x-flashduty-preserve-absence": true + "description": "该列的全部值，按行序排列；长度与 Frame 内其他字段一致。" } - }, - "required": [ - "pattern_id", - "pattern_template" - ] + } }, - "LogPatternSampleSummary": { + "QueryRecordsResult": { "type": "object", - "description": "当前窗口的日志采样摘要。", + "required": [ + "kind", + "records" + ], "properties": { - "logs_scanned": { - "type": "integer", - "description": "采样中扫描的日志条数。", - "format": "int64" - }, - "patterns_aggregated": { - "type": "integer", - "description": "从采样中聚合出的模式数量。", - "format": "int64" - }, - "logs_not_aggregated_due_to_cluster_limit": { - "type": "integer", - "description": "因聚类上限而未被聚合的日志条数。", - "format": "int64" - }, - "pattern_matching_limited": { - "type": "boolean", - "description": "模式匹配是否因有界候选集而受限。" - }, - "truncated": { - "type": "boolean", - "description": "数据源响应是否在达到采样上限时被截断。" - }, - "sampling_bias": { + "kind": { "type": "string", - "description": "截断时的数据源返回方向，例如 `newest_only` 或 `oldest_only`。", "enum": [ - "newest_only", - "oldest_only" + "records" ], - "x-flashduty-preserve-absence": true + "description": "结果类型判别字段，固定为 `records`，表示 `records` 载荷为 schema 灵活的记录数组。" + }, + "records": { + "type": "array", + "description": "schema 灵活的 records。不同 record 可以拥有不同字段、包含嵌套 JSON 或为 null。超出 JavaScript 安全范围的整数会编码为十进制字符串。", + "items": { + "oneOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "null" + } + ] + } } - }, - "required": [ - "logs_scanned", - "patterns_aggregated", - "logs_not_aggregated_due_to_cluster_limit", - "pattern_matching_limited", - "truncated" - ] + } }, - "LogPatternSourceEvidence": { + "QuerySamplesResult": { "type": "object", - "description": "来源定位字段。", + "required": [ + "kind", + "samples" + ], "properties": { - "field": { - "type": "string", - "description": "来源字段名。" - }, - "value": { + "kind": { "type": "string", - "description": "来源字段值。" + "enum": [ + "samples" + ], + "description": "结果类型判别字段，固定为 `samples`，表示 `samples` 载荷为带标签的瞬时样本数组。" }, - "count": { - "type": "integer", - "description": "具有该来源字段和值的日志数量。", - "format": "int64" + "samples": { + "type": "array", + "description": "带完整标签集合的瞬时样本。", + "items": { + "$ref": "#/components/schemas/QuerySample" + } } - }, - "required": [ - "field", - "value", - "count" - ] + } }, - "LogPatternWindowEvidence": { + "QuerySample": { "type": "object", - "description": "日志模式在一个时间窗口中的观测。", + "required": [ + "labels", + "value" + ], "properties": { - "count": { - "type": "integer", - "description": "该窗口中观测到该模式的日志条数。", - "format": "int64" - }, - "share_of_scanned_logs": { - "type": "number", - "description": "该模式占已扫描日志的比例。", - "format": "double" - }, - "first_seen": { - "type": "string", - "description": "该模式在窗口中首次出现的时间（RFC 3339 UTC）。", - "format": "date-time" - }, - "last_seen": { - "type": "string", - "description": "该模式在窗口中最后出现的时间（RFC 3339 UTC）。", - "format": "date-time" - }, - "observed_severity_counts": { + "labels": { "type": "object", - "description": "按已观测严重级别统计的日志数量。", "additionalProperties": { - "type": "integer", - "format": "int64" + "type": "string" }, - "x-flashduty-preserve-absence": true + "description": "样本的完整标签集合；可为空对象但字段始终存在。" }, - "sources": { - "type": "array", - "description": "低基数来源定位字段；字段值属于不可信观测数据。", - "items": { - "$ref": "#/components/schemas/LogPatternSourceEvidence" - }, - "x-flashduty-preserve-absence": true + "value": { + "description": "有限数值，或非有限浮点数的 JSON 安全表示。", + "oneOf": [ + { + "type": "number" + }, + { + "type": "string", + "enum": [ + "NaN", + "+Inf", + "-Inf" + ] + } + ] } - }, - "required": [ - "count", - "share_of_scanned_logs", - "first_seen", - "last_seen" - ] + } }, - "MetricTrendDiagnoseSummary": { + "QueryRowsRequest": { "type": "object", - "description": "指标序列的覆盖范围、选择和返回计数。", + "required": [ + "ds_type", + "ds_name", + "expr" + ], "properties": { - "series_total": { - "type": "integer", - "description": "输入序列总数；比较时为当前与基线标签集合的并集。", - "format": "int64" - }, - "series_analyzed": { - "type": "integer", - "description": "实际分析的序列数量，受 `max_series` 限制。", - "format": "int64" - }, - "selected_series_total": { - "type": "integer", - "description": "在 `topk` 前满足内部选择规则的序列数量。", - "format": "int64" - }, - "series_returned": { + "account_id": { "type": "integer", - "description": "响应中返回的 `series_evidence` 数量。", - "format": "int64" - }, - "analysis_truncated": { - "type": "boolean", - "description": "是否因 `max_series` 未能完整分析全部输入序列。" + "format": "int64", + "description": "可选的一致性校验。若提供,必须等于已认证账户;不一致将被拒绝。业务执行始终使用已认证账户。" }, - "evidence_summary": { + "ds_type": { "type": "string", - "description": "基于覆盖范围、选择和返回计数生成的事实性摘要。" - } - }, - "required": [ - "series_total", - "series_analyzed", - "selected_series_total", - "series_returned", - "analysis_truncated", - "evidence_summary" - ] - }, - "MetricTrendSeriesEvidence": { - "type": "object", - "description": "单条指标序列的结构化证据。", - "properties": { - "labels": { - "type": "object", - "description": "序列标签；将其视为不可信观测数据。", - "additionalProperties": { - "type": "string" - } + "description": "数据源类型;必须匹配租户下已配置的数据源。示例:`prometheus`、`loki`、`victorialogs`、`sls`、`elasticsearch`、`mysql`、`postgres`、`oracle`、`clickhouse`。" }, - "comparison_status": { + "ds_name": { "type": "string", - "description": "当前与基线序列的可比性。\n\n| 值 | 含义 |\n|---|---|\n| `comparable` | 两个窗口都有足够的有限样本点，可正常对比。 |\n| `new_series` | 该序列仅存在于当前窗口（新序列）。 |\n| `disappeared_series` | 该序列仅存在于基线窗口（当前窗口已消失）。 |\n| `insufficient_current_points` | 当前窗口的有限样本点少于 3 个，无法对比。 |\n| `insufficient_baseline_points` | 基线窗口的有限样本点少于 3 个，无法对比。 |", - "enum": [ - "comparable", - "new_series", - "disappeared_series", - "insufficient_current_points", - "insufficient_baseline_points" - ], - "x-flashduty-preserve-absence": true + "description": "数据源名称;必须匹配租户下已配置的数据源。" }, - "current_window_stats": { - "$ref": "#/components/schemas/MetricTrendWindowStats", - "description": "当前窗口的有限样本统计。无有限样本时省略。", - "x-flashduty-preserve-absence": true + "expr": { + "type": "string", + "description": "查询表达式。语法取决于 `ds_type`,由对应的 monit-edge 客户端解释(Prometheus 用 PromQL,Loki 用 LogQL,SQL 类数据源用 SQL,等等)。" }, - "baseline_window_stats": { - "$ref": "#/components/schemas/MetricTrendWindowStats", - "description": "基线窗口的有限样本统计。无有限样本时省略。", - "x-flashduty-preserve-absence": true + "delay_seconds": { + "type": "integer", + "description": "应用于点查询(Prometheus、Loki stats、VictoriaLogs stats)的回看偏移,单位秒。明细 / raw 查询忽略该字段。", + "default": 0 }, - "observations": { - "type": "array", - "description": "由结构化统计生成的可验证观察。", - "items": { + "args": { + "type": "object", + "description": "透传给 monit-edge 的多态键值扩展参数。所有值必须是字符串，键一律按数据源加前缀（如 `sls.project`、`loki.type`）。校验规则取决于 `ds_type`：SLS 必须提供 `sls.project` 与 `sls.logstore`；Elasticsearch 的 `es.type` 只接受 `sql` 或不传，其他值一律拒绝；Loki 与 VictoriaLogs 的 `.type` 接受 `stats`、`raw` 或不传，其中 `raw` 还必须给出时间范围——`.start` + `.end`，或 `.timespan.value` + `.timespan.unit`（单位取 `s`/`m`/`h`/`d`）。Prometheus 及其余 SQL 类数据源完全忽略 `args`。", + "additionalProperties": { "type": "string" } } - }, - "required": [ - "labels", - "observations" - ] - }, - "MetricTrendWindowStats": { - "type": "object", - "description": "指标时间窗口的有限样本统计。", - "properties": { - "points": { - "type": "integer", - "description": "用于统计的有限样本点数。", - "format": "int64" - }, - "first": { - "type": "number", - "description": "窗口中的第一个有限样本值。", - "format": "double" - }, - "last": { - "type": "number", - "description": "窗口中的最后一个有限样本值。", - "format": "double" - }, - "min": { - "type": "number", - "description": "窗口中的最小有限样本值。", - "format": "double" - }, - "median": { - "type": "number", - "description": "窗口中有限样本的中位数。", - "format": "double" - }, - "avg": { - "type": "number", - "description": "窗口中有限样本的平均值。", - "format": "double" - }, - "p95": { - "type": "number", - "description": "窗口中有限样本的第 95 百分位。", - "format": "double" - }, - "max": { - "type": "number", - "description": "窗口中的最大有限样本值。", - "format": "double" - } - }, - "required": [ - "points", - "first", - "last", - "min", - "median", - "avg", - "p95", - "max" - ] + } }, "DSTencentCLSConfig": { "type": "object", diff --git a/api-reference/openapi.en.json b/api-reference/openapi.en.json index a7dd3c89..2cb4760c 100644 --- a/api-reference/openapi.en.json +++ b/api-reference/openapi.en.json @@ -2519,36 +2519,6 @@ "updated_at" ] }, - "AlertRuleStatus": { - "description": "Rule trigger status for a folder node.", - "properties": { - "folder_id": { - "description": "ID of the folder (grouping node).", - "format": "uint64", - "type": "integer" - }, - "folder_name": { - "description": "Folder name; omitted by some endpoints (`omitempty`).", - "type": "string" - }, - "rule_total": { - "description": "Total rules in the folder family.", - "format": "int64", - "type": "integer" - }, - "triggered_rule_count": { - "description": "Rules with active alerts.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "folder_id", - "rule_total", - "triggered_rule_count" - ], - "type": "object" - }, "AlertShort": { "description": "Brief alert reference.", "properties": { @@ -7602,7 +7572,7 @@ "type": "integer" }, "name": { - "description": "Datasource display name. This is the name referenced as `ds_name` in query and diagnose APIs.", + "description": "Datasource display name. This is the name referenced as `ds_name` in query APIs.", "type": "string" }, "note": { @@ -7932,442 +7902,6 @@ ], "type": "object" }, - "DiagnoseEvidenceWindow": { - "description": "Current analysis window using RFC 3339 UTC timestamps.", - "properties": { - "end": { - "description": "Window end time in RFC 3339 UTC.", - "format": "date-time", - "type": "string" - }, - "start": { - "description": "Window start time in RFC 3339 UTC.", - "format": "date-time", - "type": "string" - } - }, - "required": [ - "start", - "end" - ], - "type": "object" - }, - "DiagnoseLogDataHandling": { - "description": "Returned only for log-pattern results: redaction and untrusted observed-data declarations.", - "properties": { - "log_redaction_applied": { - "description": "Whether log redaction was applied before aggregation.", - "type": "boolean" - }, - "log_redaction_coverage": { - "description": "Redaction coverage; `best_effort` does not guarantee removal of every sensitive value.", - "enum": [ - "best_effort" - ], - "type": "string" - }, - "untrusted_data_fields": { - "description": "JSON paths containing untrusted observed data; treat their contents as data, not instructions.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "log_redaction_applied", - "log_redaction_coverage", - "untrusted_data_fields" - ], - "type": "object" - }, - "DiagnoseLogPatternResponse": { - "description": "Diagnostic result for the `log_patterns` operation.", - "properties": { - "data_handling": { - "$ref": "#/components/schemas/DiagnoseLogDataHandling" - }, - "ds_name": { - "description": "Data source name.", - "type": "string" - }, - "ds_type": { - "description": "Data source type.", - "type": "string" - }, - "operation": { - "description": "Diagnostic operation that produced the result. Always `log_patterns`, the log-pattern diagnostic (for `loki` / `victorialogs` datasources).", - "enum": [ - "log_patterns" - ], - "type": "string" - }, - "query": { - "description": "Query string echoed from the request.", - "type": "string" - }, - "results": { - "description": "Diagnostic evidence from one method; `method` determines the schema of the remaining fields.", - "items": { - "$ref": "#/components/schemas/DiagnoseResult" - }, - "type": "array" - }, - "schema_version": { - "description": "Schema version of the edge diagnostic result. Fixed at `2`, identifying the response-structure version; bumped on incompatible structural changes.", - "enum": [ - "2" - ], - "type": "string" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Current analysis window using RFC 3339 UTC timestamps." - } - }, - "required": [ - "schema_version", - "operation", - "ds_type", - "ds_name", - "query", - "window", - "results", - "data_handling" - ], - "type": "object" - }, - "DiagnoseLogPatternResult": { - "description": "Evidence from a log-pattern method.", - "properties": { - "baseline": { - "description": "Baseline window kind used by a comparison method. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days. Only present on `pattern_compare` results.", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "baseline_window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Baseline time window used by a comparison method.", - "x-flashduty-preserve-absence": true - }, - "method": { - "description": "Diagnostic method that produced this evidence. `pattern_snapshot` = pattern aggregation snapshot of the current window only, no baseline involved; `pattern_compare` = pattern comparison between the current window and the baseline window (see `baseline`).", - "enum": [ - "pattern_snapshot", - "pattern_compare" - ], - "type": "string" - }, - "pattern_evidence": { - "description": "Log-pattern evidence ordered for RCA use.", - "items": { - "$ref": "#/components/schemas/LogPatternEvidence" - }, - "type": "array" - }, - "summary": { - "$ref": "#/components/schemas/DiagnoseMethodSummary" - }, - "warnings": { - "description": "Non-fatal warnings produced during analysis.", - "items": { - "type": "string" - }, - "type": "array" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Current analysis window using RFC 3339 UTC timestamps." - } - }, - "required": [ - "method", - "window", - "summary", - "pattern_evidence", - "warnings" - ], - "type": "object" - }, - "DiagnoseMethodSummary": { - "description": "Summary returned by either a log-pattern or metric-trend method.", - "oneOf": [ - { - "$ref": "#/components/schemas/LogPatternDiagnoseSummary" - }, - { - "$ref": "#/components/schemas/MetricTrendDiagnoseSummary" - } - ] - }, - "DiagnoseMetricTrendResponse": { - "description": "Diagnostic result for the `metric_trends` operation.", - "properties": { - "ds_name": { - "description": "Data source name.", - "type": "string" - }, - "ds_type": { - "description": "Data source type.", - "type": "string" - }, - "operation": { - "description": "Diagnostic operation that produced the result. Always `metric_trends`, the metric-trend diagnostic (for `prometheus`-compatible datasources).", - "enum": [ - "metric_trends" - ], - "type": "string" - }, - "query": { - "description": "Query string echoed from the request.", - "type": "string" - }, - "results": { - "description": "Diagnostic evidence from one method; `method` determines the schema of the remaining fields.", - "items": { - "$ref": "#/components/schemas/DiagnoseResult" - }, - "type": "array" - }, - "schema_version": { - "description": "Schema version of the edge diagnostic result. Fixed at `2`, identifying the response-structure version; bumped on incompatible structural changes.", - "enum": [ - "2" - ], - "type": "string" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Current analysis window using RFC 3339 UTC timestamps." - } - }, - "required": [ - "schema_version", - "operation", - "ds_type", - "ds_name", - "query", - "window", - "results" - ], - "type": "object" - }, - "DiagnoseMetricTrendResult": { - "description": "Evidence from a metric-trend method.", - "properties": { - "baseline": { - "description": "Baseline window kind used by a comparison method. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days. Only present on `window_compare` results.", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "baseline_window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Baseline time window used by a comparison method.", - "x-flashduty-preserve-absence": true - }, - "method": { - "description": "Diagnostic method that produced this evidence. `single_window_shape` = within-window trend/shape analysis only, no baseline involved; `window_compare` = per-series comparison between the current window and the baseline window (see `baseline`).", - "enum": [ - "single_window_shape", - "window_compare" - ], - "type": "string" - }, - "series_evidence": { - "description": "Metric evidence for each returned series.", - "items": { - "$ref": "#/components/schemas/MetricTrendSeriesEvidence" - }, - "type": "array" - }, - "summary": { - "$ref": "#/components/schemas/DiagnoseMethodSummary" - }, - "warnings": { - "description": "Non-fatal warnings produced during analysis.", - "items": { - "type": "string" - }, - "type": "array" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "Current analysis window using RFC 3339 UTC timestamps." - } - }, - "required": [ - "method", - "window", - "summary", - "series_evidence", - "warnings" - ], - "type": "object" - }, - "DiagnoseRequest": { - "properties": { - "account_id": { - "description": "Optional consistency check. Must equal the authenticated account when supplied.", - "format": "int64", - "type": "integer" - }, - "ds_name": { - "description": "Data source name configured under the tenant.", - "type": "string" - }, - "ds_type": { - "description": "Data source type. `log_patterns` supports `loki` and `victorialogs`; `metric_trends` supports `prometheus`.", - "type": "string" - }, - "input": { - "description": "Diagnose input. `query` is required: LogQL / VictoriaLogs query syntax for `log_patterns`; PromQL for `metric_trends`.", - "properties": { - "query": { - "description": "Query expression. LogQL / VictoriaLogs query syntax for `log_patterns`; PromQL for `metric_trends`.", - "type": "string" - } - }, - "required": [ - "query" - ], - "type": "object" - }, - "methods": { - "description": "Diagnostic methods to run. When omitted, `log_patterns` defaults to `pattern_snapshot + pattern_compare(previous_window)` and `metric_trends` defaults to `single_window_shape + window_compare(previous_window)`.", - "items": { - "properties": { - "baseline": { - "description": "Only meaningful for compare-style methods. Defaults to `previous_window`. `previous_window` = the equal-length window immediately before the current window; `same_window_yesterday` = the current window shifted back 24 hours; `same_window_last_week` = the current window shifted back 7 days.", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "type": "string" - }, - "name": { - "description": "`log_patterns` supports `pattern_snapshot`, `pattern_compare`. `metric_trends` supports `single_window_shape`, `window_compare`.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "operation": { - "description": "Diagnostic operation. When omitted, inferred from `ds_type` (loki / victorialogs → `log_patterns`, prometheus → `metric_trends`). Other sources must specify explicitly.", - "enum": [ - "log_patterns", - "metric_trends" - ], - "type": "string" - }, - "options": { - "description": "Execution options, all upper-bounded by monit-edge.", - "properties": { - "examples_per_pattern": { - "description": "Max redacted examples per pattern. Default 2, hard max 3.", - "type": "integer" - }, - "max_logs_scanned": { - "description": "Per-window log scan cap. Default 10 000, hard max 50 000.", - "type": "integer" - }, - "max_patterns": { - "description": "Max patterns returned. Default 20, hard max 50.", - "type": "integer" - }, - "max_series": { - "description": "`metric_trends` max series considered. Default 50, hard max 200.", - "type": "integer" - }, - "step_seconds": { - "description": "`metric_trends` query_range step. Default 60, range [15, 300].", - "type": "integer" - }, - "timeout_seconds": { - "description": "Edge-side diagnostic timeout in seconds. Default 25, hard max 30.", - "type": "integer" - }, - "topk": { - "description": "`metric_trends` max notable series returned. Default 10, hard max 50.", - "type": "integer" - } - }, - "type": "object" - }, - "time_range": { - "description": "Diagnostic window in Unix seconds. Defaults to the last 15 minutes when missing or invalid; windows wider than 6 hours are rejected.", - "properties": { - "end": { - "description": "Window end, Unix seconds.", - "format": "int64", - "type": "integer" - }, - "start": { - "description": "Window start, Unix seconds.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "required": [ - "ds_type", - "ds_name", - "input" - ], - "type": "object" - }, - "DiagnoseResponse": { - "description": "Schema v2 diagnostic evidence selected by `operation`. Inspect `operation` first, then handle the log-pattern or metric-trend evidence selected by each `results[].method`.", - "discriminator": { - "mapping": { - "log_patterns": "#/components/schemas/DiagnoseLogPatternResponse", - "metric_trends": "#/components/schemas/DiagnoseMetricTrendResponse" - }, - "propertyName": "operation" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/DiagnoseLogPatternResponse" - }, - { - "$ref": "#/components/schemas/DiagnoseMetricTrendResponse" - } - ] - }, - "DiagnoseResult": { - "description": "Diagnostic evidence from one method; `method` determines the schema of the remaining fields.", - "discriminator": { - "mapping": { - "pattern_compare": "#/components/schemas/DiagnoseLogPatternResult", - "pattern_snapshot": "#/components/schemas/DiagnoseLogPatternResult", - "single_window_shape": "#/components/schemas/DiagnoseMetricTrendResult", - "window_compare": "#/components/schemas/DiagnoseMetricTrendResult" - }, - "propertyName": "method" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/DiagnoseLogPatternResult" - }, - { - "$ref": "#/components/schemas/DiagnoseMetricTrendResult" - } - ] - }, "DimensionInsightItem": { "allOf": [ { @@ -14357,225 +13891,6 @@ }, "type": "object" }, - "LogPatternDiagnoseSummary": { - "description": "Summary of log sampling, aggregation, and returned evidence.", - "properties": { - "aggregated_pattern_evidence_total": { - "description": "Total aggregated pattern evidence items before the response limit is applied.", - "format": "int64", - "type": "integer" - }, - "baseline_sample": { - "$ref": "#/components/schemas/LogPatternSampleSummary", - "description": "Log sample summary for the baseline window.", - "x-flashduty-preserve-absence": true - }, - "current_sample": { - "$ref": "#/components/schemas/LogPatternSampleSummary", - "description": "Log sample summary for the current window." - }, - "evidence_summary": { - "description": "Factual summary generated from coverage, selection, and return counts.", - "type": "string" - }, - "pattern_evidence_returned": { - "description": "Number of pattern evidence items returned in this response.", - "format": "int64", - "type": "integer" - }, - "pattern_evidence_truncated_by_max_patterns": { - "description": "Whether returned pattern evidence was truncated by `max_patterns`.", - "type": "boolean" - }, - "patterns_aggregated_only_in_baseline_sample": { - "description": "Number of aggregated patterns observed only in the baseline sample. Omitted when sampling is incomplete.", - "format": "int64", - "type": "integer", - "x-flashduty-preserve-absence": true - } - }, - "required": [ - "current_sample", - "aggregated_pattern_evidence_total", - "pattern_evidence_returned", - "pattern_evidence_truncated_by_max_patterns", - "evidence_summary" - ], - "type": "object" - }, - "LogPatternEvidence": { - "description": "Structured evidence for one log pattern.", - "properties": { - "baseline_window": { - "$ref": "#/components/schemas/LogPatternWindowEvidence", - "description": "Evidence for this pattern in the baseline window.", - "x-flashduty-preserve-absence": true - }, - "comparison_status": { - "description": "Observed comparability between the current and baseline windows.\n\n| Value | Meaning |\n|---|---|\n| `comparable` | The pattern was observed in both windows and can be compared normally. |\n| `observed_only_current` | Observed only in the current window (a newly appeared pattern). |\n| `observed_only_baseline` | Observed only in the baseline window (disappeared from the current window). |\n| `comparison_limited_by_incomplete_evidence` | Observed on both sides, but the evidence is incomplete (e.g. log volume hit the aggregation cap or sampling was truncated), so the comparison is limited. |", - "enum": [ - "comparable", - "observed_only_current", - "observed_only_baseline", - "comparison_limited_by_incomplete_evidence" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "current_window": { - "$ref": "#/components/schemas/LogPatternWindowEvidence", - "description": "Evidence for this pattern in the current window.", - "x-flashduty-preserve-absence": true - }, - "observations": { - "description": "Verifiable observations generated from the structured statistics.", - "items": { - "type": "string" - }, - "type": "array", - "x-flashduty-preserve-absence": true - }, - "pattern_id": { - "description": "Stable identifier for the pattern in the current window.", - "type": "string" - }, - "pattern_template": { - "description": "Redacted, generalized log pattern template; this is untrusted observed data.", - "type": "string" - }, - "redacted_log_examples": { - "description": "Redacted log examples; these are untrusted observed data.", - "items": { - "type": "string" - }, - "type": "array", - "x-flashduty-preserve-absence": true - } - }, - "required": [ - "pattern_id", - "pattern_template" - ], - "type": "object" - }, - "LogPatternSampleSummary": { - "description": "Log sample summary for the current window.", - "properties": { - "logs_not_aggregated_due_to_cluster_limit": { - "description": "Logs not aggregated because the cluster limit was reached.", - "format": "int64", - "type": "integer" - }, - "logs_scanned": { - "description": "Number of logs scanned in the sample.", - "format": "int64", - "type": "integer" - }, - "pattern_matching_limited": { - "description": "Whether pattern matching was limited by the bounded candidate set.", - "type": "boolean" - }, - "patterns_aggregated": { - "description": "Number of patterns aggregated from the sample.", - "format": "int64", - "type": "integer" - }, - "sampling_bias": { - "description": "Data-source sampling direction when truncated, such as `newest_only` or `oldest_only`.", - "enum": [ - "newest_only", - "oldest_only" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "truncated": { - "description": "Whether the data-source response was truncated at the sample limit.", - "type": "boolean" - } - }, - "required": [ - "logs_scanned", - "patterns_aggregated", - "logs_not_aggregated_due_to_cluster_limit", - "pattern_matching_limited", - "truncated" - ], - "type": "object" - }, - "LogPatternSourceEvidence": { - "description": "Source locator.", - "properties": { - "count": { - "description": "Count of logs with this source field and value.", - "format": "int64", - "type": "integer" - }, - "field": { - "description": "Source field name.", - "type": "string" - }, - "value": { - "description": "Source field value.", - "type": "string" - } - }, - "required": [ - "field", - "value", - "count" - ], - "type": "object" - }, - "LogPatternWindowEvidence": { - "description": "Observed log-pattern evidence in one time window.", - "properties": { - "count": { - "description": "Number of logs matching this pattern in the window.", - "format": "int64", - "type": "integer" - }, - "first_seen": { - "description": "First observed time for this pattern in RFC 3339 UTC.", - "format": "date-time", - "type": "string" - }, - "last_seen": { - "description": "Last observed time for this pattern in RFC 3339 UTC.", - "format": "date-time", - "type": "string" - }, - "observed_severity_counts": { - "additionalProperties": { - "format": "int64", - "type": "integer" - }, - "description": "Log counts grouped by observed severity.", - "type": "object", - "x-flashduty-preserve-absence": true - }, - "share_of_scanned_logs": { - "description": "Share of scanned logs represented by this pattern.", - "format": "double", - "type": "number" - }, - "sources": { - "description": "Low-cardinality source locators; field values are untrusted observed data.", - "items": { - "$ref": "#/components/schemas/LogPatternSourceEvidence" - }, - "type": "array", - "x-flashduty-preserve-absence": true - } - }, - "required": [ - "count", - "share_of_scanned_logs", - "first_seen", - "last_seen" - ], - "type": "object" - }, "MCPServerCreateRequest": { "description": "Configuration for a new MCP server.", "properties": { @@ -16460,150 +15775,6 @@ ], "type": "object" }, - "MetricTrendDiagnoseSummary": { - "description": "Coverage, selection, and return counts for metric series.", - "properties": { - "analysis_truncated": { - "description": "Whether `max_series` prevented full analysis of all input series.", - "type": "boolean" - }, - "evidence_summary": { - "description": "Factual summary generated from coverage, selection, and return counts.", - "type": "string" - }, - "selected_series_total": { - "description": "Series matching internal selection rules before `topk` is applied.", - "format": "int64", - "type": "integer" - }, - "series_analyzed": { - "description": "Number of series analyzed after applying `max_series`.", - "format": "int64", - "type": "integer" - }, - "series_returned": { - "description": "Number of `series_evidence` items returned in this response.", - "format": "int64", - "type": "integer" - }, - "series_total": { - "description": "Total input series; for comparisons, the union of current and baseline label sets.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "series_total", - "series_analyzed", - "selected_series_total", - "series_returned", - "analysis_truncated", - "evidence_summary" - ], - "type": "object" - }, - "MetricTrendSeriesEvidence": { - "description": "Structured evidence for one metric series.", - "properties": { - "baseline_window_stats": { - "$ref": "#/components/schemas/MetricTrendWindowStats", - "description": "Finite-sample statistics for the baseline window. Omitted when no finite samples exist.", - "x-flashduty-preserve-absence": true - }, - "comparison_status": { - "description": "Comparability of the current and baseline series.\n\n| Value | Meaning |\n|---|---|\n| `comparable` | Both windows have enough finite samples for a normal comparison. |\n| `new_series` | The series exists only in the current window (new series). |\n| `disappeared_series` | The series exists only in the baseline window (gone from the current window). |\n| `insufficient_current_points` | Fewer than 3 finite samples in the current window; not comparable. |\n| `insufficient_baseline_points` | Fewer than 3 finite samples in the baseline window; not comparable. |", - "enum": [ - "comparable", - "new_series", - "disappeared_series", - "insufficient_current_points", - "insufficient_baseline_points" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "current_window_stats": { - "$ref": "#/components/schemas/MetricTrendWindowStats", - "description": "Finite-sample statistics for the current window. Omitted when no finite samples exist.", - "x-flashduty-preserve-absence": true - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Series labels; treat values as untrusted observed data.", - "type": "object" - }, - "observations": { - "description": "Verifiable observations generated from the structured statistics.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "labels", - "observations" - ], - "type": "object" - }, - "MetricTrendWindowStats": { - "description": "Finite-sample statistics for a metric time window.", - "properties": { - "avg": { - "description": "Average of finite samples in the window.", - "format": "double", - "type": "number" - }, - "first": { - "description": "First finite sample value in the window.", - "format": "double", - "type": "number" - }, - "last": { - "description": "Last finite sample value in the window.", - "format": "double", - "type": "number" - }, - "max": { - "description": "Maximum finite sample value in the window.", - "format": "double", - "type": "number" - }, - "median": { - "description": "Median of finite samples in the window.", - "format": "double", - "type": "number" - }, - "min": { - "description": "Minimum finite sample value in the window.", - "format": "double", - "type": "number" - }, - "p95": { - "description": "95th percentile of finite samples in the window.", - "format": "double", - "type": "number" - }, - "points": { - "description": "Number of finite sample points used for the statistics.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "points", - "first", - "last", - "min", - "median", - "avg", - "p95", - "max" - ], - "type": "object" - }, "MetricsBase": { "description": "Shared dimension identifiers attached to every aggregated insight row.", "properties": { @@ -19597,12 +18768,6 @@ }, "type": "array" }, - "RuleStatusResponse": { - "items": { - "$ref": "#/components/schemas/AlertRuleStatus" - }, - "type": "array" - }, "RumApplicationAlerting": { "description": "Alert settings for the application.", "properties": { @@ -25944,158 +25109,6 @@ ], "type": "object" }, - "StoreRulesetItem": { - "description": "A rule repository ruleset.", - "properties": { - "created_at": { - "description": "Creation timestamp, Unix epoch seconds.", - "format": "int64", - "type": "integer" - }, - "creator_account_id": { - "description": "Account ID of the creator.", - "format": "uint64", - "type": "integer" - }, - "creator_id": { - "description": "Member ID of the creator.", - "format": "uint64", - "type": "integer" - }, - "creator_name": { - "description": "Display name of the creator.", - "type": "string" - }, - "id": { - "description": "Ruleset ID.", - "format": "uint64", - "type": "integer" - }, - "note": { - "description": "Description or title of the ruleset.", - "type": "string" - }, - "open_flag": { - "description": "Sharing scope. `0` = private (visible to the creator and the account owner), `1` = account-shared, `2` = public.", - "enum": [ - 0, - 1, - 2 - ], - "type": "integer" - }, - "payload": { - "description": "JSON string containing the alert rule definitions. Omitted in list responses.", - "type": "string" - }, - "type_ident": { - "description": "Datasource type identifier this ruleset applies to.", - "type": "string" - }, - "updated_at": { - "description": "Last update timestamp, Unix epoch seconds.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "id", - "type_ident", - "note", - "open_flag", - "creator_account_id", - "creator_id", - "creator_name", - "created_at", - "updated_at" - ], - "type": "object" - }, - "StoreRulesetListRequest": { - "description": "Filter rulesets by datasource type.", - "properties": { - "type_ident": { - "description": "Datasource type identifier to filter by, e.g. `prometheus`.", - "type": "string" - } - }, - "required": [ - "type_ident" - ], - "type": "object" - }, - "StoreRulesetListResponse": { - "description": "Rulesets accessible to the current user. The `payload` field is omitted.", - "items": { - "$ref": "#/components/schemas/StoreRulesetItem" - }, - "type": "array" - }, - "StoreRulesetUpdateRequest": { - "description": "Parameters for updating a ruleset.", - "properties": { - "id": { - "description": "Ruleset ID to update.", - "format": "uint64", - "type": "integer" - }, - "note": { - "description": "New description.", - "type": "string" - }, - "open_flag": { - "description": "New sharing scope. `0` = private (visible to the creator and the account owner), `1` = account-shared, `2` = public.", - "enum": [ - 0, - 1, - 2 - ], - "type": "integer" - }, - "payload": { - "description": "New JSON string of alert rule definitions.", - "type": "string" - } - }, - "required": [ - "id", - "note", - "payload" - ], - "type": "object" - }, - "StoreRulesetUpsertRequest": { - "description": "Request body for creating a ruleset. All fields are validated by `Validate()` on the server.", - "properties": { - "note": { - "description": "Description or title of the ruleset.", - "type": "string" - }, - "open_flag": { - "description": "Sharing scope. `0` = private (visible to the creator and the account owner), `1` = account-shared, `2` = public. Defaults to `0` if omitted.", - "enum": [ - 0, - 1, - 2 - ], - "type": "integer" - }, - "payload": { - "description": "JSON string containing the alert rule definitions.", - "type": "string" - }, - "type_ident": { - "description": "Datasource type identifier this ruleset applies to, e.g. `prometheus`.", - "type": "string" - } - }, - "required": [ - "type_ident", - "note", - "payload" - ], - "type": "object" - }, "StringMapPatch": { "description": "Partial update for a map field: keys in `set` are inserted or replaced, keys in `delete` are removed, all other keys are preserved.", "properties": { @@ -42995,188 +42008,6 @@ } } }, - "/monit/query/diagnose": { - "post": { - "deprecated": true, - "description": "Run a synchronous diagnostic query (`log_patterns` for Loki/VictoriaLogs, `metric_trends` for Prometheus). Used by Flashduty AI SRE for log-pattern clustering and time-series trend analysis. Long-running — up to 35 s.\n\nDeprecated: migrate to /monit/datasource/tools/invoke with prometheus.metric_trends, loki.log_patterns or victorialogs.log_patterns. Retained for existing consumers; the legacy request and response remain unchanged.", - "operationId": "monit-read-query-diagnose", - "requestBody": { - "content": { - "application/json": { - "example": { - "account_id": 10001, - "ds_name": "vmlogs-read", - "ds_type": "victorialogs", - "input": { - "query": "_stream:{status='500'}" - }, - "methods": [ - { - "name": "pattern_snapshot" - }, - { - "baseline": "same_window_yesterday", - "name": "pattern_compare" - } - ], - "operation": "log_patterns", - "options": { - "examples_per_pattern": 2, - "max_logs_scanned": 10000, - "max_patterns": 20, - "timeout_seconds": 25 - }, - "time_range": { - "end": 1776849344, - "start": 1776847544 - } - }, - "schema": { - "$ref": "#/components/schemas/DiagnoseRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "data_handling": { - "log_redaction_applied": true, - "log_redaction_coverage": "best_effort", - "untrusted_data_fields": [ - "pattern_template", - "current_window.sources[].value", - "redacted_log_examples[]" - ] - }, - "ds_name": "prod-loki", - "ds_type": "loki", - "operation": "log_patterns", - "query": "{service=\"checkout\"}", - "results": [ - { - "baseline": "previous_window", - "baseline_window": { - "end": "2026-07-14T06:00:00Z", - "start": "2026-07-14T05:00:00Z" - }, - "method": "pattern_compare", - "pattern_evidence": [ - { - "baseline_window": { - "count": 2, - "first_seen": "2026-07-14T05:11:00Z", - "last_seen": "2026-07-14T05:44:00Z", - "observed_severity_counts": { - "error": 2 - }, - "share_of_scanned_logs": 0.00025 - }, - "comparison_status": "comparable", - "current_window": { - "count": 12, - "first_seen": "2026-07-14T06:03:00Z", - "last_seen": "2026-07-14T06:58:00Z", - "observed_severity_counts": { - "error": 12 - }, - "share_of_scanned_logs": 0.0012 - }, - "observations": [ - "The current-sample count was 12 and the baseline-sample count was 2." - ], - "pattern_id": "8f1496a85df86ca1", - "pattern_template": "checkout request <*> failed", - "redacted_log_examples": [ - "checkout request failed" - ] - } - ], - "summary": { - "aggregated_pattern_evidence_total": 20, - "baseline_sample": { - "logs_not_aggregated_due_to_cluster_limit": 0, - "logs_scanned": 8000, - "pattern_matching_limited": false, - "patterns_aggregated": 20, - "truncated": false - }, - "current_sample": { - "logs_not_aggregated_due_to_cluster_limit": 0, - "logs_scanned": 10000, - "pattern_matching_limited": false, - "patterns_aggregated": 18, - "truncated": false - }, - "evidence_summary": "1 of 20 pattern evidence items are returned.", - "pattern_evidence_returned": 1, - "pattern_evidence_truncated_by_max_patterns": true, - "patterns_aggregated_only_in_baseline_sample": 2 - }, - "warnings": [], - "window": { - "end": "2026-07-14T07:00:00Z", - "start": "2026-07-14T06:00:00Z" - } - } - ], - "schema_version": "2", - "window": { - "end": "2026-07-14T07:00:00Z", - "start": "2026-07-14T06:00:00Z" - } - }, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/DiagnoseResponse" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "Success" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "Diagnose data source", - "tags": [ - "Monitors/Diagnostics" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **600 requests/minute**; **10 requests/second** per account |\n| Permissions | Any valid `app_key` (read-only; not gated by a specific permission class) |\n\n## Usage\n\n- This is a diagnostic / RCA endpoint, not a raw data query — pair it with `/monit/query/data` when you need the underlying data.\n- Only three `ds_type` and `operation` pairs are supported: `loki` / `victorialogs` → `log_patterns`, and `prometheus` → `metric_trends`. Every other datasource is rejected, even when `operation` is explicit.\n- `methods` selects the analyses to run; when omitted, `log_patterns` defaults to `pattern_snapshot + pattern_compare(previous_window)` and `metric_trends` defaults to `single_window_shape + window_compare(previous_window)`.\n- `time_range` is in Unix seconds; missing or invalid values default to the last 15 minutes; a window wider than 6 hours is rejected.\n- The request is forwarded over WebSocket to `monit-edge`. Long-running: the request may take up to ~30 s on the edge side plus webapi overhead. Set client timeouts to **at least 35 s**.\n- `options.*` are upper-bounded by edge (`max_logs_scanned` ≤ 50 000, `max_patterns` ≤ 50, `examples_per_pattern` ≤ 3, `step_seconds` ∈ [15, 300], `max_series` ≤ 200, `topk` ≤ 50, `timeout_seconds` ≤ 30).\n- The success body is a raw `{\"data\": ...}` object WITHOUT the usual `request_id` wrapper field (raw passthrough from the edge).\n- Two error layers: request-level failures return a non-200 status with the standard `error` envelope, while edge-level execution errors come back as HTTP 200 with an `error` object in the body — check both.\n- Log examples are basic-redacted before being returned; expect `warnings: [\"examples redacted\"]`. Do not treat them as raw logs.", - "href": "/en/api-reference/monitors/diagnostics/monit-read-query-diagnose", - "metadata": { - "sidebarTitle": "Diagnose data source" - } - } - } - }, "/monit/rule/audit/detail": { "post": { "description": "Return the audit record (including the `content` field, a JSON string of the rule snapshot at that point in time).", @@ -43393,94 +42224,23 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "Get rule counts by channel", - "tags": [ - "Monitors/Alert rules" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-counter-channel", - "metadata": { - "sidebarTitle": "Get rule counts by channel" - } - } - } - }, - "/monit/rule/counter/node": { - "post": { - "description": "Return an object mapping top-level folder name to the total number of rules under that folder and all its descendants.", - "operationId": "monit-rule-read-counter-node", - "requestBody": { - "content": { - "application/json": { - "example": {}, - "schema": { - "$ref": "#/components/schemas/RuleEmptyRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "Production": 10, - "Staging": 3 - }, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCounterNodeResponse" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "Success" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "Get rule counts by folder node", + "summary": "Get rule counts by channel", "tags": [ "Monitors/Alert rules" ], "x-mint": { "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-counter-node", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-counter-channel", "metadata": { - "sidebarTitle": "Get rule counts by folder node" + "sidebarTitle": "Get rule counts by channel" } } } }, - "/monit/rule/counter/status": { + "/monit/rule/counter/node": { "post": { - "description": "Return trigger status summary for all top-level folder nodes — used for the overview dashboard.", - "operationId": "monit-rule-read-counter-status", + "description": "Return an object mapping top-level folder name to the total number of rules under that folder and all its descendants.", + "operationId": "monit-rule-read-counter-node", "requestBody": { "content": { "application/json": { @@ -43497,14 +42257,10 @@ "content": { "application/json": { "example": { - "data": [ - { - "folder_id": 100, - "folder_name": "Production", - "rule_total": 10, - "triggered_rule_count": 2 - } - ], + "data": { + "Production": 10, + "Staging": 3 + }, "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, "schema": { @@ -43515,7 +42271,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/RuleStatusResponse" + "$ref": "#/components/schemas/RuleCounterNodeResponse" } }, "type": "object" @@ -43539,15 +42295,15 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "Get rule status counters for top-level folders", + "summary": "Get rule counts by folder node", "tags": [ "Monitors/Alert rules" ], "x-mint": { "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-counter-status", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-counter-node", "metadata": { - "sidebarTitle": "Get rule status counters for top-level folders" + "sidebarTitle": "Get rule counts by folder node" } } } @@ -44194,288 +42950,31 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "Get alert rule detail", - "tags": [ - "Monitors/Alert rules" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-info", - "metadata": { - "sidebarTitle": "Get alert rule detail" - } - } - } - }, - "/monit/rule/list/basic": { - "post": { - "description": "Return the basic information of all alert rules in a folder. For full rule details, call `POST /monit/rule/info`.", - "operationId": "monit-rule-read-list", - "requestBody": { - "content": { - "application/json": { - "example": { - "folder_id": 100 - }, - "schema": { - "$ref": "#/components/schemas/RuleListRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": [ - { - "active_alert_count": 2, - "created_at": 1710000000, - "ds_type": "prometheus", - "enabled": true, - "folder_id": 100, - "id": 50001, - "name": "CPU High", - "runtime_state": "normal", - "triggered": true - } - ], - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/RuleBasicListResponse" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "Success" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "List alert rules", - "tags": [ - "Monitors/Alert rules" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |\n\n## Usage\n\n- Set `folder_id` to `0` to list all rules across all folders visible to the current user.\n- The `triggered` field indicates whether the rule has any currently active alerts.", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-list", - "metadata": { - "sidebarTitle": "List alert rules" - } - } - } - }, - "/monit/rule/move": { - "post": { - "description": "Move one or more alert rules to a different folder.", - "operationId": "monit-rule-write-move", - "requestBody": { - "content": { - "application/json": { - "example": { - "dest_folder_id": 200, - "ids": [ - 50001, - 50002 - ] - }, - "schema": { - "$ref": "#/components/schemas/RuleMoveRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": [ - { - "message": "", - "name": "CPU High" - } - ], - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/RuleNameMessageListResponse" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "Success" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "Move alert rules to folder", - "tags": [ - "Monitors/Alert rules" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Manage** (`monit`) |\n\n## Usage\n\n- Rules whose names already exist in the destination folder are skipped. Inspect each result's `message` to identify conflicts.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-write-move", - "metadata": { - "sidebarTitle": "Move alert rules to folder" - } - } - } - }, - "/monit/rule/update": { - "post": { - "description": "Replace the full configuration of an existing alert rule. All fields are overwritten.", - "operationId": "monit-rule-write-update", - "requestBody": { - "content": { - "application/json": { - "example": { - "cron_pattern": "0 * * * * *", - "ds_list": [ - "prometheus*" - ], - "ds_type": "prometheus", - "enabled": true, - "folder_id": 100, - "id": 50001, - "name": "CPU High v2", - "rule_configs": { - "queries": [ - { - "expr": "avg(cpu_usage_idle) < 5", - "name": "A" - } - ] - } - }, - "schema": { - "$ref": "#/components/schemas/AlertRule" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "id": 50001, - "updated_at": 1712100000 - }, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/AlertRule" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "Success" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "Update alert rule", + "summary": "Get alert rule detail", "tags": [ "Monitors/Alert rules" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Manage** (`monit`) |\n\n## Usage\n\n- `id` is required. All other fields follow the same rules as `POST /monit/rule/create`.\n- The name must remain unique within its folder; a duplicate returns `InvalidParameter`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-write-update", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-info", "metadata": { - "sidebarTitle": "Update alert rule" + "sidebarTitle": "Get alert rule detail" } } } }, - "/monit/rule/update/fields": { + "/monit/rule/list/basic": { "post": { - "description": "Update specific fields across multiple alert rules at once. Only the fields listed in `fields` are applied.", - "operationId": "monit-rule-write-fields-update", + "description": "Return the basic information of all alert rules in a folder. For full rule details, call `POST /monit/rule/info`.", + "operationId": "monit-rule-read-list", "requestBody": { "content": { "application/json": { "example": { - "enabled": false, - "fields": [ - "enabled" - ], - "ids": [ - 50001, - 50002 - ] + "folder_id": 100 }, "schema": { - "$ref": "#/components/schemas/RuleFieldsUpdateRequest" + "$ref": "#/components/schemas/RuleListRequest" } } }, @@ -44488,12 +42987,15 @@ "example": { "data": [ { - "message": "", - "name": "CPU High" - }, - { - "message": "", - "name": "Disk High" + "active_alert_count": 2, + "created_at": 1710000000, + "ds_type": "prometheus", + "enabled": true, + "folder_id": 100, + "id": 50001, + "name": "CPU High", + "runtime_state": "normal", + "triggered": true } ], "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" @@ -44506,7 +43008,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/RuleNameMessageListResponse" + "$ref": "#/components/schemas/RuleBasicListResponse" } }, "type": "object" @@ -44530,34 +43032,35 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "Batch update rule fields", + "summary": "List alert rules", "tags": [ "Monitors/Alert rules" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Manage** (`monit`) |\n\n## Usage\n\n- Include the field names you want to update in the `fields` array, e.g. `[\"enabled\", \"channel_ids\"]`.\n- Only the specified fields are updated; others are left unchanged.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/alert-rules/monit-rule-write-fields-update", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |\n\n## Usage\n\n- Set `folder_id` to `0` to list all rules across all folders visible to the current user.\n- The `triggered` field indicates whether the rule has any currently active alerts.", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-read-list", "metadata": { - "sidebarTitle": "Batch update rule fields" + "sidebarTitle": "List alert rules" } } } }, - "/monit/store/ruleset/create": { + "/monit/rule/move": { "post": { - "description": "Create a new ruleset in the rule repository.", - "operationId": "monit-store-ruleset-create", + "description": "Move one or more alert rules to a different folder.", + "operationId": "monit-rule-write-move", "requestBody": { "content": { "application/json": { "example": { - "note": "CPU usage alerts", - "open_flag": 1, - "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.8\"}]", - "type_ident": "prometheus" + "dest_folder_id": 200, + "ids": [ + 50001, + 50002 + ] }, "schema": { - "$ref": "#/components/schemas/StoreRulesetUpsertRequest" + "$ref": "#/components/schemas/RuleMoveRequest" } } }, @@ -44568,14 +43071,12 @@ "content": { "application/json": { "example": { - "data": { - "created_at": 1712000000, - "id": 1, - "note": "CPU usage alerts", - "open_flag": 1, - "type_ident": "prometheus", - "updated_at": 1712000000 - }, + "data": [ + { + "message": "", + "name": "CPU High" + } + ], "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, "schema": { @@ -44586,7 +43087,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetItem" + "$ref": "#/components/schemas/RuleNameMessageListResponse" } }, "type": "object" @@ -44610,101 +43111,47 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "Create ruleset", + "summary": "Move alert rules to folder", "tags": [ - "Monitors/Rule sets" + "Monitors/Alert rules" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Manage** (`monit`) |\n\n## Usage\n\n- `open_flag`: `0` = private (creator only), `1` = account-shared, `2` = public.\n- `payload` is a required JSON string containing the alert rule definitions.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-create", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Manage** (`monit`) |\n\n## Usage\n\n- Rules whose names already exist in the destination folder are skipped. Inspect each result's `message` to identify conflicts.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-write-move", "metadata": { - "sidebarTitle": "Create ruleset" + "sidebarTitle": "Move alert rules to folder" } } } }, - "/monit/store/ruleset/delete": { + "/monit/rule/update": { "post": { - "description": "Delete a ruleset from the rule repository by ID.", - "operationId": "monit-store-ruleset-delete", + "description": "Replace the full configuration of an existing alert rule. All fields are overwritten.", + "operationId": "monit-rule-write-update", "requestBody": { "content": { "application/json": { "example": { - "id": 1 - }, - "schema": { - "$ref": "#/components/schemas/IDRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": {}, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, + "cron_pattern": "0 * * * * *", + "ds_list": [ + "prometheus*" + ], + "ds_type": "prometheus", + "enabled": true, + "folder_id": 100, + "id": 50001, + "name": "CPU High v2", + "rule_configs": { + "queries": [ { - "properties": { - "data": { - "$ref": "#/components/schemas/EmptyResponse" - } - }, - "type": "object" + "expr": "avg(cpu_usage_idle) < 5", + "name": "A" } ] } - } - }, - "description": "Success" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "Delete ruleset", - "tags": [ - "Monitors/Rule sets" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Manage** (`monit`) |\n\n## Usage\n\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-delete", - "metadata": { - "sidebarTitle": "Delete ruleset" - } - } - } - }, - "/monit/store/ruleset/info": { - "post": { - "description": "Retrieve the full details of a ruleset including its `payload` (the alert rule definitions as a JSON string).", - "operationId": "monit-store-ruleset-info", - "requestBody": { - "content": { - "application/json": { - "example": { - "id": 1 }, "schema": { - "$ref": "#/components/schemas/IDRequest" + "$ref": "#/components/schemas/AlertRule" } } }, @@ -44716,16 +43163,8 @@ "application/json": { "example": { "data": { - "created_at": 1710000000, - "creator_account_id": 10023, - "creator_id": 80011, - "creator_name": "Alice", - "id": 1, - "note": "CPU usage alerts", - "open_flag": 2, - "payload": "[{\"prom_ql\":\"...\"}]", - "type_ident": "prometheus", - "updated_at": 1712000000 + "id": 50001, + "updated_at": 1712100000 }, "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, @@ -44737,7 +43176,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetItem" + "$ref": "#/components/schemas/AlertRule" } }, "type": "object" @@ -44761,31 +43200,38 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "Get ruleset detail", + "summary": "Update alert rule", "tags": [ - "Monitors/Rule sets" + "Monitors/Alert rules" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Read** (`monit`) |", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-info", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Manage** (`monit`) |\n\n## Usage\n\n- `id` is required. All other fields follow the same rules as `POST /monit/rule/create`.\n- The name must remain unique within its folder; a duplicate returns `InvalidParameter`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-write-update", "metadata": { - "sidebarTitle": "Get ruleset detail" + "sidebarTitle": "Update alert rule" } } } }, - "/monit/store/ruleset/list": { + "/monit/rule/update/fields": { "post": { - "description": "Return all rulesets for a given datasource type that are accessible to the current user.", - "operationId": "monit-store-ruleset-list", + "description": "Update specific fields across multiple alert rules at once. Only the fields listed in `fields` are applied.", + "operationId": "monit-rule-write-fields-update", "requestBody": { "content": { "application/json": { "example": { - "type_ident": "prometheus" + "enabled": false, + "fields": [ + "enabled" + ], + "ids": [ + 50001, + 50002 + ] }, "schema": { - "$ref": "#/components/schemas/StoreRulesetListRequest" + "$ref": "#/components/schemas/RuleFieldsUpdateRequest" } } }, @@ -44798,95 +43244,14 @@ "example": { "data": [ { - "created_at": 1710000000, - "creator_account_id": 10023, - "creator_id": 80011, - "creator_name": "Alice", - "id": 1, - "note": "CPU usage alerts", - "open_flag": 2, - "type_ident": "prometheus", - "updated_at": 1712000000 - } - ], - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" + "message": "", + "name": "CPU High" }, { - "properties": { - "data": { - "$ref": "#/components/schemas/StoreRulesetListResponse" - } - }, - "type": "object" + "message": "", + "name": "Disk High" } - ] - } - } - }, - "description": "Success" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "List rulesets", - "tags": [ - "Monitors/Rule sets" - ], - "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Read** (`monit`) |\n\n## Usage\n\n- A ruleset is visible if its `open_flag` is `2` (public), if the current user is the creator (`open_flag=0`), or if it belongs to the same account (`open_flag=1`).\n- The list does not include the `payload` field. Call `/monit/store/ruleset/info` to get the full ruleset content.", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-list", - "metadata": { - "sidebarTitle": "List rulesets" - } - } - } - }, - "/monit/store/ruleset/update": { - "post": { - "description": "Update the note, sharing flag, and payload of an existing ruleset.", - "operationId": "monit-store-ruleset-update", - "requestBody": { - "content": { - "application/json": { - "example": { - "id": 1, - "note": "Updated CPU alerts", - "open_flag": 2, - "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.9\"}]" - }, - "schema": { - "$ref": "#/components/schemas/StoreRulesetUpdateRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "id": 1, - "note": "Updated CPU alerts", - "open_flag": 2, - "updated_at": 1712100000 - }, + ], "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, "schema": { @@ -44897,7 +43262,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetItem" + "$ref": "#/components/schemas/RuleNameMessageListResponse" } }, "type": "object" @@ -44921,15 +43286,15 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "Update ruleset", + "summary": "Batch update rule fields", "tags": [ - "Monitors/Rule sets" + "Monitors/Alert rules" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Rule Repository Manage** (`monit`) |\n\n## Usage\n\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", - "href": "/en/api-reference/monitors/rule-sets/monit-store-ruleset-update", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Alerting Rules Manage** (`monit`) |\n\n## Usage\n\n- Include the field names you want to update in the `fields` array, e.g. `[\"enabled\", \"channel_ids\"]`.\n- Only the specified fields are updated; others are left unchanged.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", + "href": "/en/api-reference/monitors/alert-rules/monit-rule-write-fields-update", "metadata": { - "sidebarTitle": "Update ruleset" + "sidebarTitle": "Batch update rule fields" } } } @@ -60332,10 +58697,6 @@ "description": "Manage monitoring data sources used by alert rules to query metrics.", "name": "Monitors/Data sources" }, - { - "description": "Manage shared rule sets (rulesets) in the Monitors rule repository. Rulesets can be shared publicly or within an account.", - "name": "Monitors/Rule sets" - }, { "description": "", "name": "Platform/Members" diff --git a/api-reference/openapi.legacy.zh.json b/api-reference/openapi.legacy.zh.json index 5cdacfcc..8a655bf6 100644 --- a/api-reference/openapi.legacy.zh.json +++ b/api-reference/openapi.legacy.zh.json @@ -24770,55 +24770,6 @@ ] } }, - "/monit/rule/counter/status": { - "post": { - "summary": "按顶级分组节点统计触发状态", - "deprecated": false, - "description": "首页统计接口：以每个顶级分组节点为维度，统计其家族下的规则总数和活跃告警规则数。", - "tags": [ - "Monitors/告警规则/统计" - ], - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "固定值 application/json。", - "required": true, - "example": "application/json", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmptyRequest" - } - } - } - }, - "responses": { - "200": { - "description": "data 为顶级分组节点触发状态列表。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AlertRuleStatusListResponse" - } - } - }, - "headers": {} - } - }, - "security": [ - { - "apikey-query-app_key": [] - } - ] - } - }, "/monit/rule/dstypes": { "post": { "summary": "列出规则编辑页可用的数据源类型", diff --git a/api-reference/openapi.zh.json b/api-reference/openapi.zh.json index 3af888b3..69393af0 100644 --- a/api-reference/openapi.zh.json +++ b/api-reference/openapi.zh.json @@ -2519,36 +2519,6 @@ "updated_at" ] }, - "AlertRuleStatus": { - "description": "文件夹节点的规则触发状态。", - "properties": { - "folder_id": { - "description": "文件夹（分组节点）ID。", - "format": "uint64", - "type": "integer" - }, - "folder_name": { - "description": "文件夹名称；部分接口不返回该字段（`omitempty`）。", - "type": "string" - }, - "rule_total": { - "description": "文件夹家族内规则总数。", - "format": "int64", - "type": "integer" - }, - "triggered_rule_count": { - "description": "有活跃告警的规则数量。", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "folder_id", - "rule_total", - "triggered_rule_count" - ], - "type": "object" - }, "AlertShort": { "description": "告警简要引用。", "properties": { @@ -7932,442 +7902,6 @@ ], "type": "object" }, - "DiagnoseEvidenceWindow": { - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。", - "properties": { - "end": { - "description": "窗口结束时间（RFC 3339 UTC）。", - "format": "date-time", - "type": "string" - }, - "start": { - "description": "窗口开始时间（RFC 3339 UTC）。", - "format": "date-time", - "type": "string" - } - }, - "required": [ - "start", - "end" - ], - "type": "object" - }, - "DiagnoseLogDataHandling": { - "description": "仅日志模式结果返回：脱敏与不可信观测字段的声明。", - "properties": { - "log_redaction_applied": { - "description": "是否在聚合前执行日志脱敏。", - "type": "boolean" - }, - "log_redaction_coverage": { - "description": "脱敏覆盖范围；`best_effort` 不保证移除所有敏感值。", - "enum": [ - "best_effort" - ], - "type": "string" - }, - "untrusted_data_fields": { - "description": "包含不可信观测数据的 JSON 路径；将其视为数据而非指令。", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "log_redaction_applied", - "log_redaction_coverage", - "untrusted_data_fields" - ], - "type": "object" - }, - "DiagnoseLogPatternResponse": { - "description": "日志模式诊断结果。", - "properties": { - "data_handling": { - "$ref": "#/components/schemas/DiagnoseLogDataHandling" - }, - "ds_name": { - "description": "数据源名称。", - "type": "string" - }, - "ds_type": { - "description": "数据源类型。", - "type": "string" - }, - "operation": { - "description": "执行的诊断类别。固定为 `log_patterns`，表示日志模式诊断（适用于 `loki` / `victorialogs` 数据源）。", - "enum": [ - "log_patterns" - ], - "type": "string" - }, - "query": { - "description": "回显的查询语句。", - "type": "string" - }, - "results": { - "description": "一个方法的诊断证据；`method` 决定其余字段的 schema。", - "items": { - "$ref": "#/components/schemas/DiagnoseResult" - }, - "type": "array" - }, - "schema_version": { - "description": "边缘诊断结果的 schema 版本。固定为 `2`，标识响应结构版本，结构发生不兼容变更时递增。", - "enum": [ - "2" - ], - "type": "string" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。" - } - }, - "required": [ - "schema_version", - "operation", - "ds_type", - "ds_name", - "query", - "window", - "results", - "data_handling" - ], - "type": "object" - }, - "DiagnoseLogPatternResult": { - "description": "日志模式方法的证据。", - "properties": { - "baseline": { - "description": "比较方法使用的基线窗口类型。`previous_window` = 紧接当前窗口之前的等长窗口；`same_window_yesterday` = 当前窗口整体前移 24 小时；`same_window_last_week` = 当前窗口整体前移 7 天。仅 `pattern_compare` 结果携带该字段。", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "baseline_window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "比较方法使用的基线时间窗口。", - "x-flashduty-preserve-absence": true - }, - "method": { - "description": "执行的诊断方法。`pattern_snapshot` = 仅对当前窗口做日志模式聚合快照，不涉及基线；`pattern_compare` = 当前窗口与基线窗口（见 `baseline`）之间的模式对比。", - "enum": [ - "pattern_snapshot", - "pattern_compare" - ], - "type": "string" - }, - "pattern_evidence": { - "description": "按 RCA 相关性排序的日志模式证据。", - "items": { - "$ref": "#/components/schemas/LogPatternEvidence" - }, - "type": "array" - }, - "summary": { - "$ref": "#/components/schemas/DiagnoseMethodSummary" - }, - "warnings": { - "description": "执行期间产生的非致命告警。", - "items": { - "type": "string" - }, - "type": "array" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。" - } - }, - "required": [ - "method", - "window", - "summary", - "pattern_evidence", - "warnings" - ], - "type": "object" - }, - "DiagnoseMethodSummary": { - "description": "日志模式和指标趋势方法使用的摘要。", - "oneOf": [ - { - "$ref": "#/components/schemas/LogPatternDiagnoseSummary" - }, - { - "$ref": "#/components/schemas/MetricTrendDiagnoseSummary" - } - ] - }, - "DiagnoseMetricTrendResponse": { - "description": "指标趋势诊断结果。", - "properties": { - "ds_name": { - "description": "数据源名称。", - "type": "string" - }, - "ds_type": { - "description": "数据源类型。", - "type": "string" - }, - "operation": { - "description": "执行的诊断类别。固定为 `metric_trends`，表示指标趋势诊断（适用于 `prometheus` 兼容数据源）。", - "enum": [ - "metric_trends" - ], - "type": "string" - }, - "query": { - "description": "回显的查询语句。", - "type": "string" - }, - "results": { - "description": "一个方法的诊断证据；`method` 决定其余字段的 schema。", - "items": { - "$ref": "#/components/schemas/DiagnoseResult" - }, - "type": "array" - }, - "schema_version": { - "description": "边缘诊断结果的 schema 版本。固定为 `2`，标识响应结构版本，结构发生不兼容变更时递增。", - "enum": [ - "2" - ], - "type": "string" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。" - } - }, - "required": [ - "schema_version", - "operation", - "ds_type", - "ds_name", - "query", - "window", - "results" - ], - "type": "object" - }, - "DiagnoseMetricTrendResult": { - "description": "指标趋势方法的证据。", - "properties": { - "baseline": { - "description": "比较方法使用的基线窗口类型。`previous_window` = 紧接当前窗口之前的等长窗口；`same_window_yesterday` = 当前窗口整体前移 24 小时；`same_window_last_week` = 当前窗口整体前移 7 天。仅 `window_compare` 结果携带该字段。", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "baseline_window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "比较方法使用的基线时间窗口。", - "x-flashduty-preserve-absence": true - }, - "method": { - "description": "执行的诊断方法。`single_window_shape` = 仅分析当前窗口内指标的形态（趋势与形状），不涉及基线；`window_compare` = 当前窗口与基线窗口（见 `baseline`）之间的逐序列对比。", - "enum": [ - "single_window_shape", - "window_compare" - ], - "type": "string" - }, - "series_evidence": { - "description": "每条返回序列的指标证据。", - "items": { - "$ref": "#/components/schemas/MetricTrendSeriesEvidence" - }, - "type": "array" - }, - "summary": { - "$ref": "#/components/schemas/DiagnoseMethodSummary" - }, - "warnings": { - "description": "执行期间产生的非致命告警。", - "items": { - "type": "string" - }, - "type": "array" - }, - "window": { - "$ref": "#/components/schemas/DiagnoseEvidenceWindow", - "description": "分析的当前时间窗口，使用 RFC 3339 UTC 时间戳。" - } - }, - "required": [ - "method", - "window", - "summary", - "series_evidence", - "warnings" - ], - "type": "object" - }, - "DiagnoseRequest": { - "properties": { - "account_id": { - "description": "可选的一致性校验。若提供,必须等于已认证账户。", - "format": "int64", - "type": "integer" - }, - "ds_name": { - "description": "租户下已配置的数据源名称。", - "type": "string" - }, - "ds_type": { - "description": "数据源类型。`log_patterns` 支持 `loki` 与 `victorialogs`;`metric_trends` 支持 `prometheus`。", - "type": "string" - }, - "input": { - "description": "诊断输入。`query` 必填：`log_patterns` 使用 LogQL / VictoriaLogs 查询语法，`metric_trends` 使用 PromQL。", - "properties": { - "query": { - "description": "查询表达式。`log_patterns` 使用 LogQL / VictoriaLogs 查询语法;`metric_trends` 使用 PromQL。", - "type": "string" - } - }, - "required": [ - "query" - ], - "type": "object" - }, - "methods": { - "description": "要执行的诊断方法。省略时,`log_patterns` 默认为 `pattern_snapshot + pattern_compare(previous_window)`,`metric_trends` 默认为 `single_window_shape + window_compare(previous_window)`。", - "items": { - "properties": { - "baseline": { - "description": "仅对 compare 类方法有意义。默认 `previous_window`。`previous_window` = 紧接当前窗口之前的等长窗口；`same_window_yesterday` = 当前窗口整体前移 24 小时；`same_window_last_week` = 当前窗口整体前移 7 天。", - "enum": [ - "previous_window", - "same_window_yesterday", - "same_window_last_week" - ], - "type": "string" - }, - "name": { - "description": "`log_patterns` 支持 `pattern_snapshot`、`pattern_compare`。`metric_trends` 支持 `single_window_shape`、`window_compare`。", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "operation": { - "description": "诊断操作类型。省略时根据 `ds_type` 推断(loki / victorialogs → `log_patterns`,prometheus → `metric_trends`)。其他数据源必须显式指定。", - "enum": [ - "log_patterns", - "metric_trends" - ], - "type": "string" - }, - "options": { - "description": "执行选项,所有值均受 monit-edge 上限约束。", - "properties": { - "examples_per_pattern": { - "description": "每个模式返回的脱敏样例最大条数。默认 2,硬上限 3。", - "type": "integer" - }, - "max_logs_scanned": { - "description": "单窗口日志扫描上限。默认 10 000,硬上限 50 000。", - "type": "integer" - }, - "max_patterns": { - "description": "返回的最大模式数。默认 20,硬上限 50。", - "type": "integer" - }, - "max_series": { - "description": "`metric_trends` 考察的最大序列数。默认 50,硬上限 200。", - "type": "integer" - }, - "step_seconds": { - "description": "`metric_trends` 的 query_range 步长。默认 60,取值范围 [15, 300]。", - "type": "integer" - }, - "timeout_seconds": { - "description": "边缘侧诊断超时,单位秒。默认 25,硬上限 30。", - "type": "integer" - }, - "topk": { - "description": "`metric_trends` 返回的显著序列最大数量。默认 10,硬上限 50。", - "type": "integer" - } - }, - "type": "object" - }, - "time_range": { - "description": "诊断窗口,Unix 秒。缺失或无效时默认最近 15 分钟;窗口宽度超过 6 小时将被拒绝。", - "properties": { - "end": { - "description": "窗口终点,Unix 秒。", - "format": "int64", - "type": "integer" - }, - "start": { - "description": "窗口起点,Unix 秒。", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "required": [ - "ds_type", - "ds_name", - "input" - ], - "type": "object" - }, - "DiagnoseResponse": { - "description": "按 `operation` 返回 schema v2 诊断证据。先检查 `operation`，再按 `results[].method` 处理对应的日志模式或指标趋势证据。", - "discriminator": { - "mapping": { - "log_patterns": "#/components/schemas/DiagnoseLogPatternResponse", - "metric_trends": "#/components/schemas/DiagnoseMetricTrendResponse" - }, - "propertyName": "operation" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/DiagnoseLogPatternResponse" - }, - { - "$ref": "#/components/schemas/DiagnoseMetricTrendResponse" - } - ] - }, - "DiagnoseResult": { - "description": "一个方法的诊断证据；`method` 决定其余字段的 schema。", - "discriminator": { - "mapping": { - "pattern_compare": "#/components/schemas/DiagnoseLogPatternResult", - "pattern_snapshot": "#/components/schemas/DiagnoseLogPatternResult", - "single_window_shape": "#/components/schemas/DiagnoseMetricTrendResult", - "window_compare": "#/components/schemas/DiagnoseMetricTrendResult" - }, - "propertyName": "method" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/DiagnoseLogPatternResult" - }, - { - "$ref": "#/components/schemas/DiagnoseMetricTrendResult" - } - ] - }, "DimensionInsightItem": { "allOf": [ { @@ -14357,225 +13891,6 @@ }, "type": "object" }, - "LogPatternDiagnoseSummary": { - "description": "日志采样、聚合与返回范围的摘要。", - "properties": { - "aggregated_pattern_evidence_total": { - "description": "聚合后得到的模式证据总数，未受返回上限截断。", - "format": "int64", - "type": "integer" - }, - "baseline_sample": { - "$ref": "#/components/schemas/LogPatternSampleSummary", - "description": "基线窗口的日志采样摘要。", - "x-flashduty-preserve-absence": true - }, - "current_sample": { - "$ref": "#/components/schemas/LogPatternSampleSummary", - "description": "当前窗口的日志采样摘要。" - }, - "evidence_summary": { - "description": "基于覆盖范围、选择和返回计数生成的事实性摘要。", - "type": "string" - }, - "pattern_evidence_returned": { - "description": "当前响应中返回的模式证据数量。", - "format": "int64", - "type": "integer" - }, - "pattern_evidence_truncated_by_max_patterns": { - "description": "是否因 `max_patterns` 而截断返回的模式证据。", - "type": "boolean" - }, - "patterns_aggregated_only_in_baseline_sample": { - "description": "只在基线采样中观测到的已聚合模式数量。采样不完整时省略。", - "format": "int64", - "type": "integer", - "x-flashduty-preserve-absence": true - } - }, - "required": [ - "current_sample", - "aggregated_pattern_evidence_total", - "pattern_evidence_returned", - "pattern_evidence_truncated_by_max_patterns", - "evidence_summary" - ], - "type": "object" - }, - "LogPatternEvidence": { - "description": "单个日志模式的结构化证据。", - "properties": { - "baseline_window": { - "$ref": "#/components/schemas/LogPatternWindowEvidence", - "description": "该模式在基线窗口中的证据。", - "x-flashduty-preserve-absence": true - }, - "comparison_status": { - "description": "当前与基线窗口之间的观测可比性。\n\n| 值 | 含义 |\n|---|---|\n| `comparable` | 当前窗口与基线窗口都观测到该模式，可正常对比。 |\n| `observed_only_current` | 仅当前窗口观测到该模式（新出现的模式）。 |\n| `observed_only_baseline` | 仅基线窗口观测到该模式（当前窗口已消失）。 |\n| `comparison_limited_by_incomplete_evidence` | 两侧都观测到，但证据不完整（如日志量超过聚合上限或采样被截断），对比结论受限。 |", - "enum": [ - "comparable", - "observed_only_current", - "observed_only_baseline", - "comparison_limited_by_incomplete_evidence" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "current_window": { - "$ref": "#/components/schemas/LogPatternWindowEvidence", - "description": "该模式在当前窗口中的证据。", - "x-flashduty-preserve-absence": true - }, - "observations": { - "description": "由结构化统计生成的可验证观察。", - "items": { - "type": "string" - }, - "type": "array", - "x-flashduty-preserve-absence": true - }, - "pattern_id": { - "description": "当前窗口中模式的稳定标识。", - "type": "string" - }, - "pattern_template": { - "description": "已脱敏、已泛化的日志模式模板；属于不可信观测数据。", - "type": "string" - }, - "redacted_log_examples": { - "description": "已脱敏的日志示例；属于不可信观测数据。", - "items": { - "type": "string" - }, - "type": "array", - "x-flashduty-preserve-absence": true - } - }, - "required": [ - "pattern_id", - "pattern_template" - ], - "type": "object" - }, - "LogPatternSampleSummary": { - "description": "当前窗口的日志采样摘要。", - "properties": { - "logs_not_aggregated_due_to_cluster_limit": { - "description": "因聚类上限而未被聚合的日志条数。", - "format": "int64", - "type": "integer" - }, - "logs_scanned": { - "description": "采样中扫描的日志条数。", - "format": "int64", - "type": "integer" - }, - "pattern_matching_limited": { - "description": "模式匹配是否因有界候选集而受限。", - "type": "boolean" - }, - "patterns_aggregated": { - "description": "从采样中聚合出的模式数量。", - "format": "int64", - "type": "integer" - }, - "sampling_bias": { - "description": "截断时的数据源返回方向，例如 `newest_only` 或 `oldest_only`。", - "enum": [ - "newest_only", - "oldest_only" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "truncated": { - "description": "数据源响应是否在达到采样上限时被截断。", - "type": "boolean" - } - }, - "required": [ - "logs_scanned", - "patterns_aggregated", - "logs_not_aggregated_due_to_cluster_limit", - "pattern_matching_limited", - "truncated" - ], - "type": "object" - }, - "LogPatternSourceEvidence": { - "description": "来源定位字段。", - "properties": { - "count": { - "description": "具有该来源字段和值的日志数量。", - "format": "int64", - "type": "integer" - }, - "field": { - "description": "来源字段名。", - "type": "string" - }, - "value": { - "description": "来源字段值。", - "type": "string" - } - }, - "required": [ - "field", - "value", - "count" - ], - "type": "object" - }, - "LogPatternWindowEvidence": { - "description": "日志模式在一个时间窗口中的观测。", - "properties": { - "count": { - "description": "该窗口中观测到该模式的日志条数。", - "format": "int64", - "type": "integer" - }, - "first_seen": { - "description": "该模式在窗口中首次出现的时间（RFC 3339 UTC）。", - "format": "date-time", - "type": "string" - }, - "last_seen": { - "description": "该模式在窗口中最后出现的时间（RFC 3339 UTC）。", - "format": "date-time", - "type": "string" - }, - "observed_severity_counts": { - "additionalProperties": { - "format": "int64", - "type": "integer" - }, - "description": "按已观测严重级别统计的日志数量。", - "type": "object", - "x-flashduty-preserve-absence": true - }, - "share_of_scanned_logs": { - "description": "该模式占已扫描日志的比例。", - "format": "double", - "type": "number" - }, - "sources": { - "description": "低基数来源定位字段；字段值属于不可信观测数据。", - "items": { - "$ref": "#/components/schemas/LogPatternSourceEvidence" - }, - "type": "array", - "x-flashduty-preserve-absence": true - } - }, - "required": [ - "count", - "share_of_scanned_logs", - "first_seen", - "last_seen" - ], - "type": "object" - }, "MCPServerCreateRequest": { "description": "新建 MCP 服务器的配置。", "properties": { @@ -16460,150 +15775,6 @@ ], "type": "object" }, - "MetricTrendDiagnoseSummary": { - "description": "指标序列的覆盖范围、选择和返回计数。", - "properties": { - "analysis_truncated": { - "description": "是否因 `max_series` 未能完整分析全部输入序列。", - "type": "boolean" - }, - "evidence_summary": { - "description": "基于覆盖范围、选择和返回计数生成的事实性摘要。", - "type": "string" - }, - "selected_series_total": { - "description": "在 `topk` 前满足内部选择规则的序列数量。", - "format": "int64", - "type": "integer" - }, - "series_analyzed": { - "description": "实际分析的序列数量，受 `max_series` 限制。", - "format": "int64", - "type": "integer" - }, - "series_returned": { - "description": "响应中返回的 `series_evidence` 数量。", - "format": "int64", - "type": "integer" - }, - "series_total": { - "description": "输入序列总数；比较时为当前与基线标签集合的并集。", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "series_total", - "series_analyzed", - "selected_series_total", - "series_returned", - "analysis_truncated", - "evidence_summary" - ], - "type": "object" - }, - "MetricTrendSeriesEvidence": { - "description": "单条指标序列的结构化证据。", - "properties": { - "baseline_window_stats": { - "$ref": "#/components/schemas/MetricTrendWindowStats", - "description": "基线窗口的有限样本统计。无有限样本时省略。", - "x-flashduty-preserve-absence": true - }, - "comparison_status": { - "description": "当前与基线序列的可比性。\n\n| 值 | 含义 |\n|---|---|\n| `comparable` | 两个窗口都有足够的有限样本点，可正常对比。 |\n| `new_series` | 该序列仅存在于当前窗口（新序列）。 |\n| `disappeared_series` | 该序列仅存在于基线窗口（当前窗口已消失）。 |\n| `insufficient_current_points` | 当前窗口的有限样本点少于 3 个，无法对比。 |\n| `insufficient_baseline_points` | 基线窗口的有限样本点少于 3 个，无法对比。 |", - "enum": [ - "comparable", - "new_series", - "disappeared_series", - "insufficient_current_points", - "insufficient_baseline_points" - ], - "type": "string", - "x-flashduty-preserve-absence": true - }, - "current_window_stats": { - "$ref": "#/components/schemas/MetricTrendWindowStats", - "description": "当前窗口的有限样本统计。无有限样本时省略。", - "x-flashduty-preserve-absence": true - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "序列标签；将其视为不可信观测数据。", - "type": "object" - }, - "observations": { - "description": "由结构化统计生成的可验证观察。", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "labels", - "observations" - ], - "type": "object" - }, - "MetricTrendWindowStats": { - "description": "指标时间窗口的有限样本统计。", - "properties": { - "avg": { - "description": "窗口中有限样本的平均值。", - "format": "double", - "type": "number" - }, - "first": { - "description": "窗口中的第一个有限样本值。", - "format": "double", - "type": "number" - }, - "last": { - "description": "窗口中的最后一个有限样本值。", - "format": "double", - "type": "number" - }, - "max": { - "description": "窗口中的最大有限样本值。", - "format": "double", - "type": "number" - }, - "median": { - "description": "窗口中有限样本的中位数。", - "format": "double", - "type": "number" - }, - "min": { - "description": "窗口中的最小有限样本值。", - "format": "double", - "type": "number" - }, - "p95": { - "description": "窗口中有限样本的第 95 百分位。", - "format": "double", - "type": "number" - }, - "points": { - "description": "用于统计的有限样本点数。", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "points", - "first", - "last", - "min", - "median", - "avg", - "p95", - "max" - ], - "type": "object" - }, "MetricsBase": { "description": "每条聚合洞察行都带有的共享维度字段。", "properties": { @@ -19597,12 +18768,6 @@ }, "type": "array" }, - "RuleStatusResponse": { - "items": { - "$ref": "#/components/schemas/AlertRuleStatus" - }, - "type": "array" - }, "RumApplicationAlerting": { "description": "应用的告警配置。", "properties": { @@ -25944,158 +25109,6 @@ ], "type": "object" }, - "StoreRulesetItem": { - "description": "单个规则仓库规则集。", - "properties": { - "created_at": { - "description": "创建时间，Unix 时间戳（秒）。", - "format": "int64", - "type": "integer" - }, - "creator_account_id": { - "description": "创建者的账户 ID。", - "format": "uint64", - "type": "integer" - }, - "creator_id": { - "description": "创建者的成员 ID。", - "format": "uint64", - "type": "integer" - }, - "creator_name": { - "description": "创建者显示名称。", - "type": "string" - }, - "id": { - "description": "规则集 ID。", - "format": "uint64", - "type": "integer" - }, - "note": { - "description": "规则集描述或标题。", - "type": "string" - }, - "open_flag": { - "description": "共享范围：`0` 私有（创建者与账户管理员可见），`1` 账户内共享，`2` 公开。", - "enum": [ - 0, - 1, - 2 - ], - "type": "integer" - }, - "payload": { - "description": "包含告警规则定义的 JSON 字符串，列表接口中省略。", - "type": "string" - }, - "type_ident": { - "description": "该规则集适用的数据源类型标识符。", - "type": "string" - }, - "updated_at": { - "description": "最后更新时间，Unix 时间戳（秒）。", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "id", - "type_ident", - "note", - "open_flag", - "creator_account_id", - "creator_id", - "creator_name", - "created_at", - "updated_at" - ], - "type": "object" - }, - "StoreRulesetListRequest": { - "description": "按数据源类型过滤规则集。", - "properties": { - "type_ident": { - "description": "数据源类型标识符，如 `prometheus`。", - "type": "string" - } - }, - "required": [ - "type_ident" - ], - "type": "object" - }, - "StoreRulesetListResponse": { - "description": "当前用户有权访问的规则集列表，不含 `payload` 字段。", - "items": { - "$ref": "#/components/schemas/StoreRulesetItem" - }, - "type": "array" - }, - "StoreRulesetUpdateRequest": { - "description": "更新规则集的参数。", - "properties": { - "id": { - "description": "要更新的规则集 ID。", - "format": "uint64", - "type": "integer" - }, - "note": { - "description": "新的描述。", - "type": "string" - }, - "open_flag": { - "description": "新的共享范围：`0` 私有（创建者与账户管理员可见），`1` 账户共享，`2` 公开。", - "enum": [ - 0, - 1, - 2 - ], - "type": "integer" - }, - "payload": { - "description": "新的告警规则定义 JSON 字符串。", - "type": "string" - } - }, - "required": [ - "id", - "note", - "payload" - ], - "type": "object" - }, - "StoreRulesetUpsertRequest": { - "description": "创建规则集的请求体，所有字段均经服务端 `Validate()` 校验。", - "properties": { - "note": { - "description": "规则集描述或标题。", - "type": "string" - }, - "open_flag": { - "description": "共享范围：`0` 私有（创建者与账户管理员可见），`1` 账户内共享，`2` 公开。省略时默认为 `0`。", - "enum": [ - 0, - 1, - 2 - ], - "type": "integer" - }, - "payload": { - "description": "包含告警规则定义的 JSON 字符串。", - "type": "string" - }, - "type_ident": { - "description": "该规则集适用的数据源类型标识符，如 `prometheus`。", - "type": "string" - } - }, - "required": [ - "type_ident", - "note", - "payload" - ], - "type": "object" - }, "StringMapPatch": { "description": "map 字段的增量更新：`set` 中的键会被插入或覆盖，`delete` 中的键会被删除，其余键保持不变。", "properties": { @@ -42995,188 +42008,6 @@ } } }, - "/monit/query/diagnose": { - "post": { - "deprecated": true, - "description": "执行同步诊断查询(Loki/VictoriaLogs 使用 `log_patterns`,Prometheus 使用 `metric_trends`)。Flashduty AI SRE 用于日志模式聚类与时间序列趋势分析。长耗时——最长可达 35 秒。 已弃用：迁移到 /monit/datasource/tools/invoke 的 prometheus.metric_trends、loki.log_patterns 或 victorialogs.log_patterns。为现有消费者保留，旧请求与响应保持不变。", - "operationId": "monit-read-query-diagnose", - "requestBody": { - "content": { - "application/json": { - "example": { - "account_id": 10001, - "ds_name": "vmlogs-read", - "ds_type": "victorialogs", - "input": { - "query": "_stream:{status='500'}" - }, - "methods": [ - { - "name": "pattern_snapshot" - }, - { - "baseline": "same_window_yesterday", - "name": "pattern_compare" - } - ], - "operation": "log_patterns", - "options": { - "examples_per_pattern": 2, - "max_logs_scanned": 10000, - "max_patterns": 20, - "timeout_seconds": 25 - }, - "time_range": { - "end": 1776849344, - "start": 1776847544 - } - }, - "schema": { - "$ref": "#/components/schemas/DiagnoseRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "data_handling": { - "log_redaction_applied": true, - "log_redaction_coverage": "best_effort", - "untrusted_data_fields": [ - "pattern_template", - "current_window.sources[].value", - "redacted_log_examples[]" - ] - }, - "ds_name": "prod-loki", - "ds_type": "loki", - "operation": "log_patterns", - "query": "{service=\"checkout\"}", - "results": [ - { - "baseline": "previous_window", - "baseline_window": { - "end": "2026-07-14T06:00:00Z", - "start": "2026-07-14T05:00:00Z" - }, - "method": "pattern_compare", - "pattern_evidence": [ - { - "baseline_window": { - "count": 2, - "first_seen": "2026-07-14T05:11:00Z", - "last_seen": "2026-07-14T05:44:00Z", - "observed_severity_counts": { - "error": 2 - }, - "share_of_scanned_logs": 0.00025 - }, - "comparison_status": "comparable", - "current_window": { - "count": 12, - "first_seen": "2026-07-14T06:03:00Z", - "last_seen": "2026-07-14T06:58:00Z", - "observed_severity_counts": { - "error": 12 - }, - "share_of_scanned_logs": 0.0012 - }, - "observations": [ - "The current-sample count was 12 and the baseline-sample count was 2." - ], - "pattern_id": "8f1496a85df86ca1", - "pattern_template": "checkout request <*> failed", - "redacted_log_examples": [ - "checkout request failed" - ] - } - ], - "summary": { - "aggregated_pattern_evidence_total": 20, - "baseline_sample": { - "logs_not_aggregated_due_to_cluster_limit": 0, - "logs_scanned": 8000, - "pattern_matching_limited": false, - "patterns_aggregated": 20, - "truncated": false - }, - "current_sample": { - "logs_not_aggregated_due_to_cluster_limit": 0, - "logs_scanned": 10000, - "pattern_matching_limited": false, - "patterns_aggregated": 18, - "truncated": false - }, - "evidence_summary": "1 of 20 pattern evidence items are returned.", - "pattern_evidence_returned": 1, - "pattern_evidence_truncated_by_max_patterns": true, - "patterns_aggregated_only_in_baseline_sample": 2 - }, - "warnings": [], - "window": { - "end": "2026-07-14T07:00:00Z", - "start": "2026-07-14T06:00:00Z" - } - } - ], - "schema_version": "2", - "window": { - "end": "2026-07-14T07:00:00Z", - "start": "2026-07-14T06:00:00Z" - } - }, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/DiagnoseResponse" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "成功" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "数据源诊断", - "tags": [ - "Monitors/诊断分析" - ], - "x-mint": { - "content": "## 调用限制\n\n| 项 | 值 |\n| ------ | ----- |\n| 速率限制 | **600 次/分钟**;**10 次/秒** 每账户 |\n| 权限 | 任意有效的 `app_key`(只读;不受特定权限分类约束) |\n\n## 使用说明\n\n- 这是诊断 / RCA 接口,而非原始数据查询接口——如需查询底层数据,请配合 `/monit/query/data` 使用。\n- 仅支持三种 `ds_type` 与 `operation` 组合：`loki` / `victorialogs` → `log_patterns`，`prometheus` → `metric_trends`。即使显式传入 `operation`，其他数据源也会被拒绝。\n- `methods` 选择要执行的分析方法;省略时,`log_patterns` 默认为 `pattern_snapshot + pattern_compare(previous_window)`,`metric_trends` 默认为 `single_window_shape + window_compare(previous_window)`。\n- `time_range` 单位为 Unix 秒;缺失或无效时默认最近 15 分钟;窗口宽度超过 6 小时将被拒绝。\n- 请求通过 WebSocket 转发至 `monit-edge`。长耗时:边缘侧执行可能耗时约 30 秒,叠加 webapi 开销。客户端超时应至少设置为 **35 秒**。\n- `options.*` 由边缘侧设置上限(`max_logs_scanned` ≤ 50 000,`max_patterns` ≤ 50,`examples_per_pattern` ≤ 3,`step_seconds` ∈ [15, 300],`max_series` ≤ 200,`topk` ≤ 50,`timeout_seconds` ≤ 30)。\n- 成功响应体为原始 `{\"data\": ...}` 对象,不含通常的 `request_id` 包装字段（edge 侧原样透传）。\n- 存在两层错误:请求级失败返回非 200 状态码与标准 `error` 包装;边缘侧执行错误以 HTTP 200 返回,响应体中带 `error` 对象——务必同时检查两层。\n- 日志样例在返回前会经过基础脱敏处理,响应中会带 `warnings: [\"examples redacted\"]`。不可作为原始日志使用。", - "href": "/zh/api-reference/monitors/diagnostics/monit-read-query-diagnose", - "metadata": { - "sidebarTitle": "数据源诊断" - } - } - } - }, "/monit/rule/audit/detail": { "post": { "description": "返回审计记录（包含 `content` 字段，即该时间点规则配置的 JSON 字符串快照）。", @@ -43393,94 +42224,23 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "按协作空间查询规则统计", - "tags": [ - "Monitors/告警规则" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-channel", - "metadata": { - "sidebarTitle": "按协作空间查询规则统计" - } - } - } - }, - "/monit/rule/counter/node": { - "post": { - "description": "返回一个对象，key 为顶层文件夹名称，value 为该文件夹及其子孙下的规则总数。", - "operationId": "monit-rule-read-counter-node", - "requestBody": { - "content": { - "application/json": { - "example": {}, - "schema": { - "$ref": "#/components/schemas/RuleEmptyRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "Production": 10, - "Staging": 3 - }, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCounterNodeResponse" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "成功" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "按文件夹节点查询规则统计", + "summary": "按协作空间查询规则统计", "tags": [ "Monitors/告警规则" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-node", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-channel", "metadata": { - "sidebarTitle": "按文件夹节点查询规则统计" + "sidebarTitle": "按协作空间查询规则统计" } } } }, - "/monit/rule/counter/status": { + "/monit/rule/counter/node": { "post": { - "description": "返回所有顶层文件夹节点的规则触发状态汇总，用于概览看板。", - "operationId": "monit-rule-read-counter-status", + "description": "返回一个对象，key 为顶层文件夹名称，value 为该文件夹及其子孙下的规则总数。", + "operationId": "monit-rule-read-counter-node", "requestBody": { "content": { "application/json": { @@ -43497,14 +42257,10 @@ "content": { "application/json": { "example": { - "data": [ - { - "folder_id": 100, - "folder_name": "Production", - "rule_total": 10, - "triggered_rule_count": 2 - } - ], + "data": { + "Production": 10, + "Staging": 3 + }, "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, "schema": { @@ -43515,7 +42271,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/RuleStatusResponse" + "$ref": "#/components/schemas/RuleCounterNodeResponse" } }, "type": "object" @@ -43539,15 +42295,15 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "查看顶层文件夹规则状态统计", + "summary": "按文件夹节点查询规则统计", "tags": [ "Monitors/告警规则" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-status", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-node", "metadata": { - "sidebarTitle": "查看顶层文件夹规则状态统计" + "sidebarTitle": "按文件夹节点查询规则统计" } } } @@ -44194,288 +42950,31 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "查看告警规则详情", - "tags": [ - "Monitors/告警规则" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-info", - "metadata": { - "sidebarTitle": "查看告警规则详情" - } - } - } - }, - "/monit/rule/list/basic": { - "post": { - "description": "返回指定文件夹下所有告警规则的基础信息。如需完整规则详情，请调用 `POST /monit/rule/info`。", - "operationId": "monit-rule-read-list", - "requestBody": { - "content": { - "application/json": { - "example": { - "folder_id": 100 - }, - "schema": { - "$ref": "#/components/schemas/RuleListRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": [ - { - "active_alert_count": 2, - "created_at": 1710000000, - "ds_type": "prometheus", - "enabled": true, - "folder_id": 100, - "id": 50001, - "name": "CPU High", - "runtime_state": "normal", - "triggered": true - } - ], - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/RuleBasicListResponse" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "成功" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "查询告警规则列表", - "tags": [ - "Monitors/告警规则" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |\n\n## 使用说明\n\n- 将 `folder_id` 设为 `0` 可列出当前用户有权查看的所有文件夹下的规则。\n- `triggered` 字段表示该规则当前是否有活跃告警。", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-list", - "metadata": { - "sidebarTitle": "查询告警规则列表" - } - } - } - }, - "/monit/rule/move": { - "post": { - "description": "将一条或多条告警规则移动到其他文件夹。", - "operationId": "monit-rule-write-move", - "requestBody": { - "content": { - "application/json": { - "example": { - "dest_folder_id": 200, - "ids": [ - 50001, - 50002 - ] - }, - "schema": { - "$ref": "#/components/schemas/RuleMoveRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": [ - { - "message": "", - "name": "CPU High" - } - ], - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/RuleNameMessageListResponse" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "成功" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "移动告警规则到文件夹", - "tags": [ - "Monitors/告警规则" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则管理**（`monit`） |\n\n## 使用说明\n\n- 如果目标文件夹中已存在同名规则，该规则会被跳过；请检查每条结果的 `message` 以识别冲突。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-write-move", - "metadata": { - "sidebarTitle": "移动告警规则到文件夹" - } - } - } - }, - "/monit/rule/update": { - "post": { - "description": "替换已有告警规则的完整配置，所有字段将被覆盖。", - "operationId": "monit-rule-write-update", - "requestBody": { - "content": { - "application/json": { - "example": { - "cron_pattern": "0 * * * * *", - "ds_list": [ - "prometheus*" - ], - "ds_type": "prometheus", - "enabled": true, - "folder_id": 100, - "id": 50001, - "name": "CPU High v2", - "rule_configs": { - "queries": [ - { - "expr": "avg(cpu_usage_idle) < 5", - "name": "A" - } - ] - } - }, - "schema": { - "$ref": "#/components/schemas/AlertRule" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "id": 50001, - "updated_at": 1712100000 - }, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, - { - "properties": { - "data": { - "$ref": "#/components/schemas/AlertRule" - } - }, - "type": "object" - } - ] - } - } - }, - "description": "成功" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "更新告警规则", + "summary": "查看告警规则详情", "tags": [ "Monitors/告警规则" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则管理**（`monit`） |\n\n## 使用说明\n\n- `id` 为必填项。其他字段与 `POST /monit/rule/create` 的规则相同。\n- 名称在所在文件夹内必须保持唯一；重名会返回 `InvalidParameter`。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-write-update", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-info", "metadata": { - "sidebarTitle": "更新告警规则" + "sidebarTitle": "查看告警规则详情" } } } }, - "/monit/rule/update/fields": { + "/monit/rule/list/basic": { "post": { - "description": "一次性更新多条告警规则的特定字段，仅应用 `fields` 列表中指定的字段。", - "operationId": "monit-rule-write-fields-update", + "description": "返回指定文件夹下所有告警规则的基础信息。如需完整规则详情，请调用 `POST /monit/rule/info`。", + "operationId": "monit-rule-read-list", "requestBody": { "content": { "application/json": { "example": { - "enabled": false, - "fields": [ - "enabled" - ], - "ids": [ - 50001, - 50002 - ] + "folder_id": 100 }, "schema": { - "$ref": "#/components/schemas/RuleFieldsUpdateRequest" + "$ref": "#/components/schemas/RuleListRequest" } } }, @@ -44488,12 +42987,15 @@ "example": { "data": [ { - "message": "", - "name": "CPU High" - }, - { - "message": "", - "name": "Disk High" + "active_alert_count": 2, + "created_at": 1710000000, + "ds_type": "prometheus", + "enabled": true, + "folder_id": 100, + "id": 50001, + "name": "CPU High", + "runtime_state": "normal", + "triggered": true } ], "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" @@ -44506,7 +43008,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/RuleNameMessageListResponse" + "$ref": "#/components/schemas/RuleBasicListResponse" } }, "type": "object" @@ -44530,34 +43032,35 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "批量更新规则字段", + "summary": "查询告警规则列表", "tags": [ "Monitors/告警规则" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则管理**（`monit`） |\n\n## 使用说明\n\n- 在 `fields` 数组中指定要更新的字段名，如 `[\"enabled\", \"channel_ids\"]`。\n- 仅更新指定字段，其他字段保持不变。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/alert-rules/monit-rule-write-fields-update", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |\n\n## 使用说明\n\n- 将 `folder_id` 设为 `0` 可列出当前用户有权查看的所有文件夹下的规则。\n- `triggered` 字段表示该规则当前是否有活跃告警。", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-list", "metadata": { - "sidebarTitle": "批量更新规则字段" + "sidebarTitle": "查询告警规则列表" } } } }, - "/monit/store/ruleset/create": { + "/monit/rule/move": { "post": { - "description": "在规则仓库中创建新的规则集。", - "operationId": "monit-store-ruleset-create", + "description": "将一条或多条告警规则移动到其他文件夹。", + "operationId": "monit-rule-write-move", "requestBody": { "content": { "application/json": { "example": { - "note": "CPU usage alerts", - "open_flag": 1, - "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.8\"}]", - "type_ident": "prometheus" + "dest_folder_id": 200, + "ids": [ + 50001, + 50002 + ] }, "schema": { - "$ref": "#/components/schemas/StoreRulesetUpsertRequest" + "$ref": "#/components/schemas/RuleMoveRequest" } } }, @@ -44568,14 +43071,12 @@ "content": { "application/json": { "example": { - "data": { - "created_at": 1712000000, - "id": 1, - "note": "CPU usage alerts", - "open_flag": 1, - "type_ident": "prometheus", - "updated_at": 1712000000 - }, + "data": [ + { + "message": "", + "name": "CPU High" + } + ], "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, "schema": { @@ -44586,7 +43087,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetItem" + "$ref": "#/components/schemas/RuleNameMessageListResponse" } }, "type": "object" @@ -44610,101 +43111,47 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "创建规则集", + "summary": "移动告警规则到文件夹", "tags": [ - "Monitors/规则集" + "Monitors/告警规则" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库管理**（`monit`） |\n\n## 使用说明\n\n- `open_flag`：`0` 仅创建者可见，`1` 账户内共享，`2` 公开。\n- `payload` 为必填 JSON 字符串，包含告警规则定义。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-create", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则管理**（`monit`） |\n\n## 使用说明\n\n- 如果目标文件夹中已存在同名规则，该规则会被跳过；请检查每条结果的 `message` 以识别冲突。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-write-move", "metadata": { - "sidebarTitle": "创建规则集" + "sidebarTitle": "移动告警规则到文件夹" } } } }, - "/monit/store/ruleset/delete": { + "/monit/rule/update": { "post": { - "description": "通过 ID 从规则仓库中删除规则集。", - "operationId": "monit-store-ruleset-delete", + "description": "替换已有告警规则的完整配置，所有字段将被覆盖。", + "operationId": "monit-rule-write-update", "requestBody": { "content": { "application/json": { "example": { - "id": 1 - }, - "schema": { - "$ref": "#/components/schemas/IDRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": {}, - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" - }, + "cron_pattern": "0 * * * * *", + "ds_list": [ + "prometheus*" + ], + "ds_type": "prometheus", + "enabled": true, + "folder_id": 100, + "id": 50001, + "name": "CPU High v2", + "rule_configs": { + "queries": [ { - "properties": { - "data": { - "$ref": "#/components/schemas/EmptyResponse" - } - }, - "type": "object" + "expr": "avg(cpu_usage_idle) < 5", + "name": "A" } ] } - } - }, - "description": "成功" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "删除规则集", - "tags": [ - "Monitors/规则集" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库管理**（`monit`） |\n\n## 使用说明\n\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-delete", - "metadata": { - "sidebarTitle": "删除规则集" - } - } - } - }, - "/monit/store/ruleset/info": { - "post": { - "description": "获取规则集的完整信息，包括 `payload`（JSON 字符串形式的告警规则定义）。", - "operationId": "monit-store-ruleset-info", - "requestBody": { - "content": { - "application/json": { - "example": { - "id": 1 }, "schema": { - "$ref": "#/components/schemas/IDRequest" + "$ref": "#/components/schemas/AlertRule" } } }, @@ -44716,16 +43163,8 @@ "application/json": { "example": { "data": { - "created_at": 1710000000, - "creator_account_id": 10023, - "creator_id": 80011, - "creator_name": "Alice", - "id": 1, - "note": "CPU usage alerts", - "open_flag": 2, - "payload": "[{\"prom_ql\":\"...\"}]", - "type_ident": "prometheus", - "updated_at": 1712000000 + "id": 50001, + "updated_at": 1712100000 }, "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, @@ -44737,7 +43176,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetItem" + "$ref": "#/components/schemas/AlertRule" } }, "type": "object" @@ -44761,31 +43200,38 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "查看规则集详情", + "summary": "更新告警规则", "tags": [ - "Monitors/规则集" + "Monitors/告警规则" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库查看**（`monit`） |", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-info", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则管理**（`monit`） |\n\n## 使用说明\n\n- `id` 为必填项。其他字段与 `POST /monit/rule/create` 的规则相同。\n- 名称在所在文件夹内必须保持唯一；重名会返回 `InvalidParameter`。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-write-update", "metadata": { - "sidebarTitle": "查看规则集详情" + "sidebarTitle": "更新告警规则" } } } }, - "/monit/store/ruleset/list": { + "/monit/rule/update/fields": { "post": { - "description": "返回指定数据源类型下当前用户有权访问的所有规则集。", - "operationId": "monit-store-ruleset-list", + "description": "一次性更新多条告警规则的特定字段，仅应用 `fields` 列表中指定的字段。", + "operationId": "monit-rule-write-fields-update", "requestBody": { "content": { "application/json": { "example": { - "type_ident": "prometheus" + "enabled": false, + "fields": [ + "enabled" + ], + "ids": [ + 50001, + 50002 + ] }, "schema": { - "$ref": "#/components/schemas/StoreRulesetListRequest" + "$ref": "#/components/schemas/RuleFieldsUpdateRequest" } } }, @@ -44798,95 +43244,14 @@ "example": { "data": [ { - "created_at": 1710000000, - "creator_account_id": 10023, - "creator_id": 80011, - "creator_name": "Alice", - "id": 1, - "note": "CPU usage alerts", - "open_flag": 2, - "type_ident": "prometheus", - "updated_at": 1712000000 - } - ], - "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" - }, - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SuccessEnvelope" + "message": "", + "name": "CPU High" }, { - "properties": { - "data": { - "$ref": "#/components/schemas/StoreRulesetListResponse" - } - }, - "type": "object" + "message": "", + "name": "Disk High" } - ] - } - } - }, - "description": "成功" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/ServerError" - } - }, - "summary": "查询规则集列表", - "tags": [ - "Monitors/规则集" - ], - "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库查看**（`monit`） |\n\n## 使用说明\n\n- 当 `open_flag` 为 `2`（公开）、当前用户为创建者（`open_flag=0`）或与账户共享（`open_flag=1`）时，规则集对当前用户可见。\n- 列表不包含 `payload` 字段，完整内容请调用 `/monit/store/ruleset/info`。", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-list", - "metadata": { - "sidebarTitle": "查询规则集列表" - } - } - } - }, - "/monit/store/ruleset/update": { - "post": { - "description": "更新已有规则集的备注、共享标志及 payload。", - "operationId": "monit-store-ruleset-update", - "requestBody": { - "content": { - "application/json": { - "example": { - "id": 1, - "note": "Updated CPU alerts", - "open_flag": 2, - "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.9\"}]" - }, - "schema": { - "$ref": "#/components/schemas/StoreRulesetUpdateRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "data": { - "id": 1, - "note": "Updated CPU alerts", - "open_flag": 2, - "updated_at": 1712100000 - }, + ], "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4" }, "schema": { @@ -44897,7 +43262,7 @@ { "properties": { "data": { - "$ref": "#/components/schemas/StoreRulesetItem" + "$ref": "#/components/schemas/RuleNameMessageListResponse" } }, "type": "object" @@ -44921,15 +43286,15 @@ "$ref": "#/components/responses/ServerError" } }, - "summary": "更新规则集", + "summary": "批量更新规则字段", "tags": [ - "Monitors/规则集" + "Monitors/告警规则" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **规则仓库管理**（`monit`） |\n\n## 使用说明\n\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", - "href": "/zh/api-reference/monitors/rule-sets/monit-store-ruleset-update", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **告警规则管理**（`monit`） |\n\n## 使用说明\n\n- 在 `fields` 数组中指定要更新的字段名，如 `[\"enabled\", \"channel_ids\"]`。\n- 仅更新指定字段，其他字段保持不变。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", + "href": "/zh/api-reference/monitors/alert-rules/monit-rule-write-fields-update", "metadata": { - "sidebarTitle": "更新规则集" + "sidebarTitle": "批量更新规则字段" } } } @@ -60332,10 +58697,6 @@ "description": "管理监控告警规则用于查询指标的数据源。", "name": "Monitors/告警数据源" }, - { - "description": "管理 Monitors 规则仓库中的共享规则集，规则集可在账户内或公开共享。", - "name": "Monitors/规则集" - }, { "description": "", "name": "平台/成员管理" diff --git a/docs.json b/docs.json index cc744bd9..97383fe6 100644 --- a/docs.json +++ b/docs.json @@ -2475,8 +2475,7 @@ "POST /monit/rule/dstypes", "POST /monit/rule/counter/total", "POST /monit/rule/counter/node", - "POST /monit/rule/counter/channel", - "POST /monit/rule/counter/status" + "POST /monit/rule/counter/channel" ] }, { @@ -2493,23 +2492,11 @@ "POST /monit/datasource/sls/logstores" ] }, - { - "group": "规则集", - "icon": "books", - "pages": [ - "POST /monit/store/ruleset/list", - "POST /monit/store/ruleset/info", - "POST /monit/store/ruleset/create", - "POST /monit/store/ruleset/update", - "POST /monit/store/ruleset/delete" - ] - }, { "group": "诊断分析", "icon": "stethoscope", "pages": [ - "POST /monit/query/data", - "POST /monit/query/diagnose" + "POST /monit/query/data" ] } ] @@ -3855,8 +3842,7 @@ "POST /monit/rule/dstypes", "POST /monit/rule/counter/total", "POST /monit/rule/counter/node", - "POST /monit/rule/counter/channel", - "POST /monit/rule/counter/status" + "POST /monit/rule/counter/channel" ] }, { @@ -3873,23 +3859,11 @@ "POST /monit/datasource/sls/logstores" ] }, - { - "group": "Rule sets", - "icon": "books", - "pages": [ - "POST /monit/store/ruleset/list", - "POST /monit/store/ruleset/info", - "POST /monit/store/ruleset/create", - "POST /monit/store/ruleset/update", - "POST /monit/store/ruleset/delete" - ] - }, { "group": "Diagnostics", "icon": "stethoscope", "pages": [ - "POST /monit/query/data", - "POST /monit/query/diagnose" + "POST /monit/query/data" ] } ] diff --git a/en/developer/cli.mdx b/en/developer/cli.mdx index 85a9e681..1fac18e5 100644 --- a/en/developer/cli.mdx +++ b/en/developer/cli.mdx @@ -464,26 +464,12 @@ flashduty session export --include-subagents > session.ndjson ### monit-query — Monitoring datasource queries -Probe monitoring back-end datasources directly, bypassing the alert-rule layer. The `data` subcommand supports 9 datasource types (Prometheus, VictoriaLogs, Loki, MySQL, SLS, Elasticsearch, PostgreSQL, Oracle, ClickHouse); `diagnose` is a **legacy** interface (its log_patterns / metric_trends evidence has moved to `monit datasource-tools-invoke`) supporting `prometheus` (metric trends), `victorialogs`, and `loki` (log patterns). +Query monitoring back-end datasources directly, bypassing the alert-rule layer. The `data` subcommand supports 9 datasource types (Prometheus, VictoriaLogs, Loki, MySQL, SLS, Elasticsearch, PostgreSQL, Oracle, ClickHouse). For metric trends and log patterns, use the named tools of `monit datasource-tools-invoke` below. ```bash -flashduty monit-query diagnose [flags] # Legacy: pre-clustered RCA findings (log patterns or metric trends; prefer monit datasource-tools-invoke) flashduty monit-query data [flags] # Structured datasource query ``` -Common flags for `diagnose`: - -| Flag | Description | -|------|-------------| -| `--ds-type` | Datasource type supported by the diagnose endpoint (required): `prometheus`, `victorialogs`, `loki` | -| `--ds-name` | Datasource name as configured in the console (required) | -| `--input-query` | Filter-only log query or matrix PromQL (required) | -| `--time-start` | Window start (default `15m`). Accepts a relative duration (`15m`, `1h`), `now`, a date/RFC3339 timestamp, or a unix epoch in seconds or milliseconds | -| `--time-end` | Window end (default `now`); same formats as `--time-start`; the window is capped at 6h | -| `--operation` | `log_patterns` (`loki` / `victorialogs`) or `metric_trends` (`prometheus`); inferred from `--ds-type` when omitted | - -`diagnose` is a legacy interface (the equivalent of the SDK's deprecated `QueryDiagnose`): for new scenarios use the `prometheus.metric_trends`, `loki.log_patterns`, and `victorialogs.log_patterns` tools of `monit datasource-tools-invoke`, below. - Common flags for `data`: | Flag | Description | @@ -496,7 +482,7 @@ Common flags for `data`: `data` returns a stable `query_result.v1` structured result: `format` is always `query_result.v1`, and `result.kind` is one of `frames` (typed table/time-series frames), `records` (schema-flexible records, may contain nested JSON or null), or `samples` (instant samples with complete label sets) — results are no longer flattened into the legacy rows shape. -`rows` requires `--ds-type`, `--ds-name`, and `--expr` (query expression). Use `--args KEY=VALUE` (repeatable) for parameterized queries. **`rows` is deprecated** — use `monit-query data` instead. In raw mode (`loki` / `victorialogs`), `rows` accepts time-window arguments `--args .start=` and `--args .end=` in the same formats as `diagnose`'s `--time-start`/`--time-end` (relative duration, `now`, date/RFC3339, unix seconds or milliseconds); the CLI normalizes them to the unix-seconds form the datasource requires. +`rows` requires `--ds-type`, `--ds-name`, and `--expr` (query expression). Use `--args KEY=VALUE` (repeatable) for parameterized queries. **`rows` is deprecated** — use `monit-query data` instead. In raw mode (`loki` / `victorialogs`), `rows` accepts time-window arguments `--args .start=` and `--args .end=` as a relative duration, `now`, date/RFC3339, or Unix seconds or milliseconds; the CLI normalizes them to the unix-seconds form the datasource requires. ### monit datasource-tools-invoke — Datasource diagnostics @@ -559,7 +545,7 @@ Core fields for `datasource-create` / `datasource-update`: | Flag | Description | |------|-------------| -| `--name` | Datasource display name (required); the `ds_name` referenced by query/diagnose APIs | +| `--name` | Datasource display name (required); the `ds_name` referenced by query APIs | | `--type-ident` | Datasource type identifier (required): `prometheus`, `loki`, `mysql`, `oracle`, `postgres`, `clickhouse`, `elasticsearch`, `sls`, `tencent_cls`, `victorialogs`, plus 5 **diagnostic-only** types: `redis_node`, `redis_sentinel`, `mongodb_mongod`, `mongodb_mongos`, `kafka` | | `--address` | Connection address. Required for every type except `elasticsearch` with `deployment: cloud`. Prometheus/Loki/VictoriaLogs: HTTP URL; MySQL/Oracle/Postgres/ClickHouse: `host:port`; SLS: endpoint without the `http(s)://` prefix. **Redis/MongoDB diagnostic types**: one `host:port`, bracket IPv6; no URI, userinfo or query. **Kafka**: 1–32 unique comma-separated `host:port` bootstrap addresses (no broker list in the payload). At most 4096 characters after normalization | | `--edge-cluster-name` | Monitors edge cluster name responsible for evaluating rules using this datasource (required) | diff --git a/en/developer/go-sdk.mdx b/en/developer/go-sdk.mdx index 6fb65aae..7ea877dd 100644 --- a/en/developer/go-sdk.mdx +++ b/en/developer/go-sdk.mdx @@ -153,7 +153,6 @@ Endpoints are grouped by service and hang off the client: the call convention is | `client.Account` | Account | | `client.AuditLogs` | Audit logs | | `client.AlertRules` | Alert rules | -| `client.RuleSets` | Rule sets | | `client.AlertEnrichment` | Alert enrichment | | `client.DataSources` | Data sources | | `client.Integrations` | Integrations | @@ -185,7 +184,7 @@ Endpoints are grouped by service and hang off the client: the call convention is `client.Artifacts` (AI SRE artifacts) covers the 11 operations under `/safari/artifact/*`: on the gallery read side `ReadGet` (get a single published artifact by ID), `ReadList` (list artifacts visible to the caller, with title substring search and `scope` (`all` / `personal` / `team`) plus `team_ids` filtering), and `ReadGetFileState` (probe up to 50 presented-file IDs (`pf_` prefix) in one call for ones that already have a live published artifact); on the file side `ReadSign` (issue short-lived download/preview URLs for a presented file, valid 5 minutes, `expires_in` is fixed at 300) and `ReadStream` (download or preview the file's bytes with a signed token — the success body is a file, not a JSON envelope, with the raw bytes on `Response.Raw`); on the write side `WritePublish` (publish a session-produced file to the gallery), `WriteUpdate` (rename the artifact or transfer it between personal and team scope), and `WriteDelete` (detach it from the gallery; the source file stays with its session); public sharing `WriteShareEnable` (turn on anonymous public sharing and return the public link — anyone with the link can view it, no login required), `WriteShareRevoke` (turn sharing off; the link stops resolving immediately), and `WriteShareSync` (refresh the public snapshot with the latest content — when `share_enabled` is true and `share_file_id` differs from `file_id`, the snapshot is stale and calling this refreshes it). Exported types include `PublishedArtifactItem`, `ArtifactShareState`, `SignedUrLs`, and the various `Artifact*Request` / `Artifact*Response` structs. -`client.Diagnostics` (diagnostics) provides datasource query methods: `QueryData` runs a synchronous query via `POST /monit/query/data` and returns a stable `query_result.v1` structured result (`format` is always `query_result.v1`; `result.kind` is one of `frames` / `records` / `samples`). This API requires monit-edge v0.65.0 or later. `QueryDiagnose` (`POST /monit/query/diagnose`) runs pre-clustered RCA analysis (log patterns or metric trends) and can take up to 35 seconds — **but it is deprecated**: migrate to `client.DataSources.ToolsInvoke` using the `prometheus.metric_trends`, `loki.log_patterns`, or `victorialogs.log_patterns` tools. It is retained for existing consumers; the legacy request and response remain unchanged. +`client.Diagnostics.QueryData` runs a synchronous query via `POST /monit/query/data` and returns a stable `query_result.v1` structured result (`result.kind` is one of `frames`, `records`, or `samples`). This API requires monit-edge v0.65.0 or later. For log-pattern and metric-trend analysis, use `client.DataSources.ToolsInvoke` with `prometheus.metric_trends`, `loki.log_patterns`, or `victorialogs.log_patterns`. `client.DataSources.ToolsInvoke` (`POST /monit/datasource/tools/invoke`, `monit-datasource-tools-invoke`) executes one deterministic tool against a configured datasource: `tool` is a single tool name prefixed by the datasource type (e.g. `mysql.overview`), and `params` is the tool-specific JSON parameters (omitted means `{}`; an explicit `null` is invalid). Free SQL goes through `/monit/query/data`; `mysql.query` and `postgres.query` are unsupported. It requires all currently online routable Edge sessions in the cluster to support the v0.71.0 base invoke protocol (individual tools may require a newer implementation), and there is no tool catalog, no automatic replay, and no fallback to Agent or legacy diagnose. The request body limit is 128 KiB, the complete success response limit is 1 MiB, and the tool timeout is at most 25 seconds; the response is a `DatasourceToolResult` (`data` is tool-specific JSON, never null, `summary` is optional, and a `truncated` object with `reason` indicates truncation). diff --git a/en/openapi/api-catalog.mdx b/en/openapi/api-catalog.mdx index 8bfcaddd..59420efb 100644 --- a/en/openapi/api-catalog.mdx +++ b/en/openapi/api-catalog.mdx @@ -293,7 +293,6 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated vi | POST | [`/monit/rule/counter/total`](/en/api-reference/monitors/alert-rules/monit-rule-read-counter-total) | Get rule counter time series | | POST | [`/monit/rule/counter/node`](/en/api-reference/monitors/alert-rules/monit-rule-read-counter-node) | Get rule counts by folder node | | POST | [`/monit/rule/counter/channel`](/en/api-reference/monitors/alert-rules/monit-rule-read-counter-channel) | Get rule counts by channel | -| POST | [`/monit/rule/counter/status`](/en/api-reference/monitors/alert-rules/monit-rule-read-counter-status) | Get rule status counters for top-level folders | ### Data sources @@ -308,22 +307,11 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated vi | POST | [`/monit/datasource/sls/projects`](/en/api-reference/monitors/data-sources/monit-datasource-read-sls-projects) | List SLS projects | | POST | [`/monit/datasource/sls/logstores`](/en/api-reference/monitors/data-sources/monit-datasource-read-sls-logstores) | List SLS logstores | -### Rule sets - -| Method | Endpoint | Description | -| :--- | :--- | :--- | -| POST | [`/monit/store/ruleset/list`](/en/api-reference/monitors/rule-sets/monit-store-ruleset-list) | List rulesets | -| POST | [`/monit/store/ruleset/info`](/en/api-reference/monitors/rule-sets/monit-store-ruleset-info) | Get ruleset detail | -| POST | [`/monit/store/ruleset/create`](/en/api-reference/monitors/rule-sets/monit-store-ruleset-create) | Create ruleset | -| POST | [`/monit/store/ruleset/update`](/en/api-reference/monitors/rule-sets/monit-store-ruleset-update) | Update ruleset | -| POST | [`/monit/store/ruleset/delete`](/en/api-reference/monitors/rule-sets/monit-store-ruleset-delete) | Delete ruleset | - ### Diagnostics | Method | Endpoint | Description | | :--- | :--- | :--- | | POST | [`/monit/query/data`](/en/api-reference/monitors/diagnostics/monit-read-query-data) | Query structured data | -| POST | [`/monit/query/diagnose`](/en/api-reference/monitors/diagnostics/monit-read-query-diagnose) | Diagnose data source | ### Monitor utilities diff --git a/zh/developer/cli.mdx b/zh/developer/cli.mdx index 98deb0cc..65aadf61 100644 --- a/zh/developer/cli.mdx +++ b/zh/developer/cli.mdx @@ -464,26 +464,12 @@ flashduty session export --include-subagents > session.ndjson ### monit-query — 监控数据源查询 -直接探测监控后端数据源，无需经过告警规则层。`data` 子命令支持 9 种数据源类型（Prometheus、VictoriaLogs、Loki、MySQL、SLS、Elasticsearch、PostgreSQL、Oracle、ClickHouse）；`diagnose` 为**遗留接口**（log_patterns / metric_trends 证据已迁移到 `monit datasource-tools-invoke`），支持 `prometheus`（指标趋势）、`victorialogs` 和 `loki`（日志模式）。 +直接查询监控后端数据源，无需经过告警规则层。`data` 子命令支持 9 种数据源类型（Prometheus、VictoriaLogs、Loki、MySQL、SLS、Elasticsearch、PostgreSQL、Oracle、ClickHouse）。指标趋势和日志模式分析使用下文的 `monit datasource-tools-invoke` 命名工具。 ```bash -flashduty monit-query diagnose [flags] # 遗留接口：预聚合 RCA 分析（日志模式或指标趋势；新场景请用 monit datasource-tools-invoke） flashduty monit-query data [flags] # 结构化数据源查询 ``` -`diagnose` 常用参数： - -| 参数 | 说明 | -|------|------| -| `--ds-type` | 诊断接口支持的数据源类型（必填）：`prometheus`、`victorialogs`、`loki` | -| `--ds-name` | 数据源名称（必填，与控制台配置一致） | -| `--input-query` | 过滤查询语句或 PromQL（必填） | -| `--time-start` | 窗口起始时间（默认 `15m`）。支持相对时长（`15m`、`1h`）、`now`、日期/RFC3339 时间戳，或 Unix 秒/毫秒时间戳 | -| `--time-end` | 窗口截止时间（默认 `now`），格式与 `--time-start` 相同；时间窗口最长 6 小时 | -| `--operation` | `log_patterns`（`loki` / `victorialogs`）或 `metric_trends`（`prometheus`）；省略时根据 `--ds-type` 自动推断 | - -`diagnose` 是遗留接口（等价于 SDK 中已弃用的 `QueryDiagnose`）：新场景请改用 `monit datasource-tools-invoke` 的 `prometheus.metric_trends`、`loki.log_patterns`、`victorialogs.log_patterns` 工具，见下文。 - `data` 常用参数： | 参数 | 说明 | @@ -496,7 +482,7 @@ flashduty monit-query data [flags] # 结构化数据源查询 `data` 返回稳定的 `query_result.v1` 结构化结果：`format` 固定为 `query_result.v1`，`result.kind` 为 `frames`（类型化表格/时序帧）、`records`（字段灵活的记录，可含嵌套 JSON 或 null）或 `samples`（带完整标签集的即时样本）三者之一，不再把结果强制压平为旧版行结构。 -`rows` 常用参数：`--ds-type`、`--ds-name`（均必填）、`--expr`（查询表达式，必填）、`--args KEY=VALUE`（可重复）。**`rows` 已弃用**，请改用 `monit-query data`。`rows` 原始模式（`loki` / `victorialogs`）可通过 `--args .start=` 与 `--args .end=` 指定时间窗口，取值格式与 `diagnose` 的 `--time-start`/`--time-end` 相同（相对时长、`now`、日期/RFC3339、Unix 秒或毫秒），CLI 会统一归一化为数据源要求的 Unix 秒。 +`rows` 常用参数：`--ds-type`、`--ds-name`（均必填）、`--expr`（查询表达式，必填）、`--args KEY=VALUE`（可重复）。**`rows` 已弃用**，请改用 `monit-query data`。`rows` 原始模式（`loki` / `victorialogs`）可通过 `--args .start=` 与 `--args .end=` 指定时间窗口，支持相对时长、`now`、日期/RFC3339、Unix 秒或毫秒，CLI 会统一归一化为数据源要求的 Unix 秒。 ### monit datasource-tools-invoke — 数据源诊断工具 diff --git a/zh/developer/go-sdk.mdx b/zh/developer/go-sdk.mdx index fd10b631..a5622764 100644 --- a/zh/developer/go-sdk.mdx +++ b/zh/developer/go-sdk.mdx @@ -153,7 +153,6 @@ client, err := flashduty.NewClient("YOUR_APP_KEY", | `client.Account` | 账户 | | `client.AuditLogs` | 审计日志 | | `client.AlertRules` | 告警规则 | -| `client.RuleSets` | 规则集 | | `client.AlertEnrichment` | 告警字段加工 | | `client.DataSources` | 数据源 | | `client.Integrations` | 集成 | @@ -185,7 +184,7 @@ client, err := flashduty.NewClient("YOUR_APP_KEY", `client.Artifacts`（AI SRE 产物）对应 `/safari/artifact/*` 的 11 个 API 操作：画廊读取侧 `ReadGet`（按 ID 获取单个已发布产物）、`ReadList`（分页列出调用方可见的产物，支持标题子串搜索、`scope`（`all` / `personal` / `team`）与 `team_ids` 过滤）、`ReadGetFileState`（批量探测会话展示文件（`pf_` 前缀）是否已有上线产物，单次至多 50 个 ID）；文件侧 `ReadSign`（为展示文件签发短期有效的下载/预览 URL，有效期 5 分钟，`expires_in` 固定 300 秒）与 `ReadStream`（凭签名 token 下载或预览文件，成功响应体是文件而非 JSON 信封，原始字节放在 `Response.Raw`）；写入侧 `WritePublish`（把会话产生的文件发布为画廊产物）、`WriteUpdate`（重命名或转移个人/团队作用域）、`WriteDelete`（从画廊移除，源文件仍保留在会话中）；公开分享 `WriteShareEnable`（开启匿名公开分享并返回公开链接，任何人凭链接即可查看、无需登录）、`WriteShareRevoke`（关闭分享，链接立即失效）、`WriteShareSync`（把公开快照刷新为最新内容——当 `share_enabled` 为 true 且 `share_file_id` 与 `file_id` 不一致时表示快照已过期，调用它刷新）。相关导出类型包括 `PublishedArtifactItem`、`ArtifactShareState`、`SignedUrLs` 以及各 `Artifact*Request` / `Artifact*Response`。 -`client.Diagnostics`（诊断）提供数据源查询方法：`QueryData` 通过 `POST /monit/query/data` 执行同步查询，返回稳定的 `query_result.v1` 结构化结果（`format` 固定为 `query_result.v1`，`result.kind` 为 `frames` / `records` / `samples` 之一），该接口要求 monit-edge v0.65.0 及以上版本；`QueryDiagnose`（`POST /monit/query/diagnose`）用于预聚合 RCA 分析（日志模式或指标趋势），最长运行 35 秒，**但已弃用**——请迁移到 `client.DataSources.ToolsInvoke` 并使用 `prometheus.metric_trends`、`loki.log_patterns` 或 `victorialogs.log_patterns` 工具；该接口为既有调用方保留，旧请求与响应格式不变。 +`client.Diagnostics.QueryData` 通过 `POST /monit/query/data` 执行同步查询，返回稳定的 `query_result.v1` 结构化结果（`result.kind` 为 `frames` / `records` / `samples` 之一），要求 monit-edge v0.65.0 及以上版本。日志模式和指标趋势分析统一使用 `client.DataSources.ToolsInvoke`，工具名称为 `prometheus.metric_trends`、`loki.log_patterns` 或 `victorialogs.log_patterns`。 `client.DataSources.ToolsInvoke`（`POST /monit/datasource/tools/invoke`，`monit-datasource-tools-invoke`）在某个已配置数据源上执行一个确定性工具：`tool` 名称由数据源类型前缀修饰（如 `mysql.overview`），`params` 为工具专属 JSON 参数（省略视为 `{}`，显式 `null` 非法）；自由 SQL 请走 `/monit/query/data`，`mysql.query` 与 `postgres.query` 不受支持。该接口要求集群中所有在线可路由的 Edge 会话都支持 v0.71.0 基础调用协议（单个工具可能要求更新的实现），无工具目录、无自动重放、也不会回退到 Agent 或旧版 diagnose。请求体上限 128 KiB，完整成功响应上限 1 MiB，单工具超时至多 25 秒；响应为 `DatasourceToolResult`（`data` 为工具专属 JSON、永不为 null，`summary` 可选，出现 `truncated` 时其 `reason` 说明截断原因）。 diff --git a/zh/openapi/api-catalog.mdx b/zh/openapi/api-catalog.mdx index ebc42976..7cf06333 100644 --- a/zh/openapi/api-catalog.mdx +++ b/zh/openapi/api-catalog.mdx @@ -293,7 +293,6 @@ Flashduty Open API 提供 **354** 个接口，覆盖 On-call、Monitors、RUM、 | POST | [`/monit/rule/counter/total`](/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-total) | 查看规则数量时序 | | POST | [`/monit/rule/counter/node`](/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-node) | 按文件夹节点查询规则统计 | | POST | [`/monit/rule/counter/channel`](/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-channel) | 按协作空间查询规则统计 | -| POST | [`/monit/rule/counter/status`](/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-status) | 查看顶层文件夹规则状态统计 | ### 告警数据源 @@ -308,22 +307,11 @@ Flashduty Open API 提供 **354** 个接口，覆盖 On-call、Monitors、RUM、 | POST | [`/monit/datasource/sls/projects`](/zh/api-reference/monitors/data-sources/monit-datasource-read-sls-projects) | 查询 SLS 项目列表 | | POST | [`/monit/datasource/sls/logstores`](/zh/api-reference/monitors/data-sources/monit-datasource-read-sls-logstores) | 查询 SLS 日志库列表 | -### 规则集 - -| 方法 | 接口 | 描述 | -| :--- | :--- | :--- | -| POST | [`/monit/store/ruleset/list`](/zh/api-reference/monitors/rule-sets/monit-store-ruleset-list) | 查询规则集列表 | -| POST | [`/monit/store/ruleset/info`](/zh/api-reference/monitors/rule-sets/monit-store-ruleset-info) | 查看规则集详情 | -| POST | [`/monit/store/ruleset/create`](/zh/api-reference/monitors/rule-sets/monit-store-ruleset-create) | 创建规则集 | -| POST | [`/monit/store/ruleset/update`](/zh/api-reference/monitors/rule-sets/monit-store-ruleset-update) | 更新规则集 | -| POST | [`/monit/store/ruleset/delete`](/zh/api-reference/monitors/rule-sets/monit-store-ruleset-delete) | 删除规则集 | - ### 诊断分析 | 方法 | 接口 | 描述 | | :--- | :--- | :--- | | POST | [`/monit/query/data`](/zh/api-reference/monitors/diagnostics/monit-read-query-data) | 查询结构化数据 | -| POST | [`/monit/query/diagnose`](/zh/api-reference/monitors/diagnostics/monit-read-query-diagnose) | 数据源诊断 | ### 通用工具