Skip to content

docs(api): daily audit 2026-09-14 — retire monit rule import/export, add template notification fields #391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ysyneu merged 1 commit into from
Sep 14, 2026
Merged

docs(api): daily audit 2026-09-14 — retire monit rule import/export, add template notification fields #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 0 additions & 174 deletions api-reference/monitors.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -682,88 +682,6 @@
}
}
},
"/monit/rule/export": {
"post": {
"operationId": "monit-rule-read-export",
"summary": "Export alert rules",
"description": "Export the configuration of selected alert rules as a portable JSON array, compatible with `POST /monit/rule/import`.",
"tags": [
"Monitors/Alert rules"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/day**; **200 requests/minute**; **20 requests/second** per account |\n| Permissions | **Alerting Rules Read** (`monit`) |",
"href": "/en/api-reference/monitors/alert-rules/monit-rule-read-export",
"metadata": {
"sidebarTitle": "Export alert rules"
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SuccessEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AlertRuleExportListResponse"
}
}
}
]
},
"example": {
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": [
{
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"enabled": true,
"cron_pattern": "0 * * * * *"
}
]
}
}
}
},
"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/RuleIDsRequest"
},
"example": {
"ids": [
50001
]
}
}
}
}
}
},
"/monit/datasource/sls/logstores": {
"post": {
"operationId": "monit-datasource-read-sls-logstores",
Expand Down Expand Up @@ -1079,98 +997,6 @@
}
}
},
"/monit/rule/import": {
"post": {
"operationId": "monit-rule-write-import",
"summary": "Import alert rules",
"description": "Import one or more alert rules from a JSON array. Returns the result for each rule, indicating success or failure.",
"tags": [
"Monitors/Alert rules"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **20 requests/minute**; **2 requests/second** per account |\n| Permissions | **Alerting Rules Manage** (`monit`) |\n\n## Usage\n\n- The request body is a JSON array of rule export objects (compatible with the output of `POST /monit/rule/export`).\n- Each object must include `folder_id`, `ds_type`, and either `ds_list` or `ds_ids`.\n- Some rules may fail (e.g. duplicate name). Check each result for individual status.\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-import",
"metadata": {
"sidebarTitle": "Import alert rules"
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SuccessEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RuleImportResponse"
}
}
}
]
},
"example": {
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": [
{
"name": "CPU High",
"message": ""
}
]
}
}
}
},
"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/RuleImportRequest"
},
"example": [
{
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"enabled": true,
"cron_pattern": "0 * * * * *",
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "avg(cpu_usage_idle) < 10"
}
]
}
}
]
}
}
}
}
},
"/monit/rule/list/basic": {
"post": {
"operationId": "monit-rule-read-list",
Expand Down
174 changes: 0 additions & 174 deletions api-reference/monitors.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -682,88 +682,6 @@
}
}
},
"/monit/rule/export": {
"post": {
"operationId": "monit-rule-read-export",
"summary": "导出告警规则",
"description": "将选定告警规则的配置导出为可移植的 JSON 数组，与 `POST /monit/rule/import` 兼容。",
"tags": [
"Monitors/告警规则"
],
"x-mint": {
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/天**；**200 次/分钟**；**20 次/秒** |\n| 权限要求 | **告警规则查看**（`monit`） |",
"href": "/zh/api-reference/monitors/alert-rules/monit-rule-read-export",
"metadata": {
"sidebarTitle": "导出告警规则"
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SuccessEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AlertRuleExportListResponse"
}
}
}
]
},
"example": {
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": [
{
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"enabled": true,
"cron_pattern": "0 * * * * *"
}
]
}
}
}
},
"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/RuleIDsRequest"
},
"example": {
"ids": [
50001
]
}
}
}
}
}
},
"/monit/datasource/sls/logstores": {
"post": {
"operationId": "monit-datasource-read-sls-logstores",
Expand Down Expand Up @@ -1079,98 +997,6 @@
}
}
},
"/monit/rule/import": {
"post": {
"operationId": "monit-rule-write-import",
"summary": "导入告警规则",
"description": "从 JSON 数组导入一条或多条告警规则，返回每条规则的导入结果（成功或失败）。",
"tags": [
"Monitors/告警规则"
],
"x-mint": {
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **20 次/分钟**；**2 次/秒** |\n| 权限要求 | **告警规则管理**（`monit`） |\n\n## 使用说明\n\n- 请求体为规则导出对象的 JSON 数组（与 `POST /monit/rule/export` 输出兼容）。\n- 每个对象必须包含 `folder_id`、`ds_type` 以及 `ds_list` 或 `ds_ids` 之一。\n- 部分规则可能失败（如名称重复），请检查每条结果的状态。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。",
"href": "/zh/api-reference/monitors/alert-rules/monit-rule-write-import",
"metadata": {
"sidebarTitle": "导入告警规则"
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SuccessEnvelope"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RuleImportResponse"
}
}
}
]
},
"example": {
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": [
{
"name": "CPU High",
"message": ""
}
]
}
}
}
},
"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/RuleImportRequest"
},
"example": [
{
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"enabled": true,
"cron_pattern": "0 * * * * *",
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "avg(cpu_usage_idle) < 10"
}
]
}
}
]
}
}
}
}
},
"/monit/rule/list/basic": {
"post": {
"operationId": "monit-rule-read-list",
Expand Down
Loading
Loading