Skip to content

Commit fa09ede

Browse files
ysyneuysyneu
authored
Merge pull request #357 from flashcatcloud/api-review/20260907T083545Z
api-review daily audit 2026-09-07: zh 200 descriptions, tools/invoke restrictions, api-catalog sync
2 parents d9f1496 + 7e229b6 commit fa09ede

9 files changed

Lines changed: 42 additions & 40 deletions

‎api-reference/monitors.openapi.en.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3860,7 +3860,7 @@
38603860
"Monitors/Data sources"
38613861
],
38623862
"x-mint": {
3863-
"content": "Use 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.",
3863+
"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.",
38643864
"href": "/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke",
38653865
"metadata": {
38663866
"sidebarTitle": "Invoke datasource tool"

‎api-reference/monitors.openapi.zh.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3860,7 +3860,7 @@
38603860
"Monitors/告警数据源"
38613861
],
38623862
"x-mint": {
3863-
"content": "通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 diagnose 重试。",
3863+
"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 重试。",
38643864
"href": "/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke",
38653865
"metadata": {
38663866
"sidebarTitle": "调用数据源工具"

‎api-reference/on-call.openapi.zh.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17340,7 +17340,7 @@
1734017340
},
1734117341
"responses": {
1734217342
"200": {
17343-
"description": "Success",
17343+
"description": "成功",
1734417344
"content": {
1734517345
"application/json": {
1734617346
"schema": {

‎api-reference/openapi.en.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44827,7 +44827,7 @@
4482744827
"Monitors/Data sources"
4482844828
],
4482944829
"x-mint": {
44830-
"content": "Use 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.",
44830+
"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.",
4483144831
"href": "/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke",
4483244832
"metadata": {
4483344833
"sidebarTitle": "Invoke datasource tool"

‎api-reference/openapi.zh.json‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -44827,7 +44827,7 @@
4482744827
"Monitors/告警数据源"
4482844828
],
4482944829
"x-mint": {
44830-
"content": "通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 diagnose 重试。",
44830+
"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 重试。",
4483144831
"href": "/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke",
4483244832
"metadata": {
4483344833
"sidebarTitle": "调用数据源工具"
@@ -49939,7 +49939,7 @@
4993949939
}
4994049940
}
4994149941
},
49942-
"description": "Success"
49942+
"description": "成功"
4994349943
},
4994449944
"400": {
4994549945
"$ref": "#/components/responses/BadRequest"
@@ -50090,7 +50090,7 @@
5009050090
}
5009150091
}
5009250092
},
50093-
"description": "Success"
50093+
"description": "成功"
5009450094
},
5009550095
"400": {
5009650096
"$ref": "#/components/responses/BadRequest"
@@ -50164,7 +50164,7 @@
5016450164
}
5016550165
}
5016650166
},
50167-
"description": "Success"
50167+
"description": "成功"
5016850168
},
5016950169
"400": {
5017050170
"$ref": "#/components/responses/BadRequest"
@@ -50244,7 +50244,7 @@
5024450244
}
5024550245
}
5024650246
},
50247-
"description": "Success"
50247+
"description": "成功"
5024850248
},
5024950249
"400": {
5025050250
"$ref": "#/components/responses/BadRequest"
@@ -50345,7 +50345,7 @@
5034550345
}
5034650346
}
5034750347
},
50348-
"description": "Success"
50348+
"description": "成功"
5034950349
},
5035050350
"400": {
5035150351
"$ref": "#/components/responses/BadRequest"
@@ -53745,7 +53745,7 @@
5374553745
}
5374653746
}
5374753747
},
53748-
"description": "Success"
53748+
"description": "成功"
5374953749
},
5375053750
"400": {
5375153751
"$ref": "#/components/responses/BadRequest"
@@ -53832,7 +53832,7 @@
5383253832
}
5383353833
}
5383453834
},
53835-
"description": "Success"
53835+
"description": "成功"
5383653836
},
5383753837
"400": {
5383853838
"$ref": "#/components/responses/BadRequest"
@@ -53929,7 +53929,7 @@
5392953929
}
5393053930
}
5393153931
},
53932-
"description": "Success"
53932+
"description": "成功"
5393353933
},
5393453934
"400": {
5393553935
"$ref": "#/components/responses/BadRequest"
@@ -54051,7 +54051,7 @@
5405154051
}
5405254052
}
5405354053
},
54054-
"description": "Success"
54054+
"description": "成功"
5405554055
},
5405654056
"400": {
5405754057
"$ref": "#/components/responses/BadRequest"
@@ -54131,7 +54131,7 @@
5413154131
}
5413254132
}
5413354133
},
54134-
"description": "Success"
54134+
"description": "成功"
5413554135
},
5413654136
"400": {
5413754137
"$ref": "#/components/responses/BadRequest"
@@ -54212,7 +54212,7 @@
5421254212
}
5421354213
}
5421454214
},
54215-
"description": "Success"
54215+
"description": "成功"
5421654216
},
5421754217
"400": {
5421854218
"$ref": "#/components/responses/BadRequest"
@@ -54288,7 +54288,7 @@
5428854288
}
5428954289
}
5429054290
},
54291-
"description": "Success"
54291+
"description": "成功"
5429254292
},
5429354293
"400": {
5429454294
"$ref": "#/components/responses/BadRequest"
@@ -54369,7 +54369,7 @@
5436954369
}
5437054370
}
5437154371
},
54372-
"description": "Success"
54372+
"description": "成功"
5437354373
},
5437454374
"400": {
5437554375
"$ref": "#/components/responses/BadRequest"
@@ -54467,7 +54467,7 @@
5446754467
}
5446854468
}
5446954469
},
54470-
"description": "Success"
54470+
"description": "成功"
5447154471
},
5447254472
"400": {
5447354473
"$ref": "#/components/responses/BadRequest"
@@ -54549,7 +54549,7 @@
5454954549
}
5455054550
}
5455154551
},
54552-
"description": "Success"
54552+
"description": "成功"
5455354553
},
5455454554
"400": {
5455554555
"$ref": "#/components/responses/BadRequest"
@@ -58089,7 +58089,7 @@
5808958089
}
5809058090
}
5809158091
},
58092-
"description": "Success"
58092+
"description": "成功"
5809358093
},
5809458094
"400": {
5809558095
"$ref": "#/components/responses/BadRequest"

‎api-reference/rum.openapi.zh.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4617,7 +4617,7 @@
46174617
}
46184618
}
46194619
},
4620-
"description": "Success"
4620+
"description": "成功"
46214621
},
46224622
"400": {
46234623
"$ref": "#/components/responses/BadRequest"
@@ -4768,7 +4768,7 @@
47684768
}
47694769
}
47704770
},
4771-
"description": "Success"
4771+
"description": "成功"
47724772
},
47734773
"400": {
47744774
"$ref": "#/components/responses/BadRequest"
@@ -4842,7 +4842,7 @@
48424842
}
48434843
}
48444844
},
4845-
"description": "Success"
4845+
"description": "成功"
48464846
},
48474847
"400": {
48484848
"$ref": "#/components/responses/BadRequest"
@@ -4922,7 +4922,7 @@
49224922
}
49234923
}
49244924
},
4925-
"description": "Success"
4925+
"description": "成功"
49264926
},
49274927
"400": {
49284928
"$ref": "#/components/responses/BadRequest"
@@ -5023,7 +5023,7 @@
50235023
}
50245024
}
50255025
},
5026-
"description": "Success"
5026+
"description": "成功"
50275027
},
50285028
"400": {
50295029
"$ref": "#/components/responses/BadRequest"

‎api-reference/safari.openapi.zh.json‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4065,7 +4065,7 @@
40654065
},
40664066
"responses": {
40674067
"200": {
4068-
"description": "Success",
4068+
"description": "成功",
40694069
"content": {
40704070
"application/json": {
40714071
"schema": {
@@ -4185,7 +4185,7 @@
41854185
},
41864186
"responses": {
41874187
"200": {
4188-
"description": "Success",
4188+
"description": "成功",
41894189
"content": {
41904190
"application/json": {
41914191
"schema": {
@@ -4285,7 +4285,7 @@
42854285
},
42864286
"responses": {
42874287
"200": {
4288-
"description": "Success",
4288+
"description": "成功",
42894289
"content": {
42904290
"application/json": {
42914291
"schema": {
@@ -4369,7 +4369,7 @@
43694369
},
43704370
"responses": {
43714371
"200": {
4372-
"description": "Success",
4372+
"description": "成功",
43734373
"content": {
43744374
"application/json": {
43754375
"schema": {
@@ -4527,7 +4527,7 @@
45274527
},
45284528
"responses": {
45294529
"200": {
4530-
"description": "Success",
4530+
"description": "成功",
45314531
"content": {
45324532
"application/json": {
45334533
"schema": {
@@ -4607,7 +4607,7 @@
46074607
},
46084608
"responses": {
46094609
"200": {
4610-
"description": "Success",
4610+
"description": "成功",
46114611
"content": {
46124612
"application/json": {
46134613
"schema": {
@@ -4704,7 +4704,7 @@
47044704
},
47054705
"responses": {
47064706
"200": {
4707-
"description": "Success",
4707+
"description": "成功",
47084708
"content": {
47094709
"application/json": {
47104710
"schema": {
@@ -4780,7 +4780,7 @@
47804780
},
47814781
"responses": {
47824782
"200": {
4783-
"description": "Success",
4783+
"description": "成功",
47844784
"content": {
47854785
"application/json": {
47864786
"schema": {
@@ -4861,7 +4861,7 @@
48614861
},
48624862
"responses": {
48634863
"200": {
4864-
"description": "Success",
4864+
"description": "成功",
48654865
"content": {
48664866
"application/json": {
48674867
"schema": {
@@ -4942,7 +4942,7 @@
49424942
},
49434943
"responses": {
49444944
"200": {
4945-
"description": "Success",
4945+
"description": "成功",
49464946
"content": {
49474947
"application/json": {
49484948
"schema": {

‎en/openapi/api-catalog.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "API Catalog"
33
description: "Complete list of Flashduty Open API endpoints, organized by product module with links to detailed documentation"
44
---
55

6-
Flashduty Open API provides **353** endpoints covering five major modules: On-call, Monitors, RUM, AI SRE, and Platform. All endpoints use unified authentication and request specifications. See [Quick Start](/en/openapi/introduction) for details.
6+
Flashduty Open API provides **354** endpoints covering five major modules: On-call, Monitors, RUM, AI SRE, and Platform. All endpoints use unified authentication and request specifications. See [Quick Start](/en/openapi/introduction) for details.
77

88
<Note>
99
All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated via APP Key through query string.
@@ -271,7 +271,7 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated vi
271271

272272
</Accordion>
273273

274-
<Accordion title="Monitors (39 endpoints)">
274+
<Accordion title="Monitors (40 endpoints)">
275275

276276
### Alert rules
277277

@@ -304,6 +304,7 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated vi
304304
| POST | [`/monit/datasource/create`](/en/api-reference/monitors/data-sources/monit-datasource-write-create) | Create datasource |
305305
| POST | [`/monit/datasource/update`](/en/api-reference/monitors/data-sources/monit-datasource-write-update) | Update datasource |
306306
| POST | [`/monit/datasource/delete`](/en/api-reference/monitors/data-sources/monit-datasource-write-delete) | Delete datasource |
307+
| POST | [`/monit/datasource/tools/invoke`](/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke) | Invoke datasource tool |
307308
| POST | [`/monit/datasource/sls/projects`](/en/api-reference/monitors/data-sources/monit-datasource-read-sls-projects) | List SLS projects |
308309
| POST | [`/monit/datasource/sls/logstores`](/en/api-reference/monitors/data-sources/monit-datasource-read-sls-logstores) | List SLS logstores |
309310

‎zh/openapi/api-catalog.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "API 目录"
33
description: "Flashduty Open API 接口完整列表，按产品模块组织并链接到详细文档"
44
---
55

6-
Flashduty Open API 提供 **353** 个接口，覆盖 On-call、Monitors、RUM、AI SRE 和平台五个主要模块。所有接口使用统一认证方式和请求规范。详情参见[快速开始](/zh/openapi/introduction)。
6+
Flashduty Open API 提供 **354** 个接口，覆盖 On-call、Monitors、RUM、AI SRE 和平台五个主要模块。所有接口使用统一认证方式和请求规范。详情参见[快速开始](/zh/openapi/introduction)。
77

88
<Note>
99
所有接口 URL 均以 `https://api.flashcat.cloud` 为 base，通过 query string 中的 APP Key 认证。
@@ -271,7 +271,7 @@ Flashduty Open API 提供 **353** 个接口，覆盖 On-call、Monitors、RUM、
271271

272272
</Accordion>
273273

274-
<Accordion title="Monitors（39 个接口）">
274+
<Accordion title="Monitors（40 个接口）">
275275

276276
### 告警规则
277277

@@ -304,6 +304,7 @@ Flashduty Open API 提供 **353** 个接口，覆盖 On-call、Monitors、RUM、
304304
| POST | [`/monit/datasource/create`](/zh/api-reference/monitors/data-sources/monit-datasource-write-create) | 创建数据源 |
305305
| POST | [`/monit/datasource/update`](/zh/api-reference/monitors/data-sources/monit-datasource-write-update) | 更新数据源 |
306306
| POST | [`/monit/datasource/delete`](/zh/api-reference/monitors/data-sources/monit-datasource-write-delete) | 删除数据源 |
307+
| POST | [`/monit/datasource/tools/invoke`](/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke) | 调用数据源工具 |
307308
| POST | [`/monit/datasource/sls/projects`](/zh/api-reference/monitors/data-sources/monit-datasource-read-sls-projects) | 查询 SLS 项目列表 |
308309
| POST | [`/monit/datasource/sls/logstores`](/zh/api-reference/monitors/data-sources/monit-datasource-read-sls-logstores) | 查询 SLS 日志库列表 |
309310

0 commit comments

Comments
 (0)