From 7e229b67dff9d6ccbe05f598075ee1e8a2474520 Mon Sep 17 00:00:00 2001 From: Flashduty AI-SRE Date: Mon, 7 Sep 2026 08:35:45 +0000 Subject: [PATCH] docs(api): daily audit 2026-09-07 - localize zh 200 descriptions, add tools/invoke restrictions, sync api-catalog MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 16 ZH ops (rum remote-config, safari artifact/sign, on-call schedule/by-person) carried responses.200.description "Success"; aligned to the 成功 convention. - POST /monit/datasource/tools/invoke gained its ## Restrictions block. Limits (32/s, 2000/min per account) and permission class (Datasources Read, monit) come from live pgy_proxy.t_api id 18847 and pgy_account.t_permission_factor, matching fc-pgy 9c5494a / 6be0e3a - not constructed values. - {en,zh}/openapi/api-catalog.mdx: +1 row, Monitors 39->40, total 353->354. - docs.json untouched: no operation added or removed. - lint_openapi.py: OK, 12 spec files, no violations. --- api-reference/monitors.openapi.en.json | 2 +- api-reference/monitors.openapi.zh.json | 2 +- api-reference/on-call.openapi.zh.json | 2 +- api-reference/openapi.en.json | 2 +- api-reference/openapi.zh.json | 34 +++++++++++++------------- api-reference/rum.openapi.zh.json | 10 ++++---- api-reference/safari.openapi.zh.json | 20 +++++++-------- en/openapi/api-catalog.mdx | 5 ++-- zh/openapi/api-catalog.mdx | 5 ++-- 9 files changed, 42 insertions(+), 40 deletions(-) diff --git a/api-reference/monitors.openapi.en.json b/api-reference/monitors.openapi.en.json index c3c6fe8f..101b84cf 100644 --- a/api-reference/monitors.openapi.en.json +++ b/api-reference/monitors.openapi.en.json @@ -3860,7 +3860,7 @@ "Monitors/Data sources" ], "x-mint": { - "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.", + "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" diff --git a/api-reference/monitors.openapi.zh.json b/api-reference/monitors.openapi.zh.json index 783f0cdc..4c461842 100644 --- a/api-reference/monitors.openapi.zh.json +++ b/api-reference/monitors.openapi.zh.json @@ -3860,7 +3860,7 @@ "Monitors/告警数据源" ], "x-mint": { - "content": "通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 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": "调用数据源工具" diff --git a/api-reference/on-call.openapi.zh.json b/api-reference/on-call.openapi.zh.json index 2756711f..9f8ed76e 100644 --- a/api-reference/on-call.openapi.zh.json +++ b/api-reference/on-call.openapi.zh.json @@ -17340,7 +17340,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { diff --git a/api-reference/openapi.en.json b/api-reference/openapi.en.json index 4eaf4ed3..eebd081d 100644 --- a/api-reference/openapi.en.json +++ b/api-reference/openapi.en.json @@ -44827,7 +44827,7 @@ "Monitors/Data sources" ], "x-mint": { - "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.", + "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" diff --git a/api-reference/openapi.zh.json b/api-reference/openapi.zh.json index 862ecccc..0ca2d0e5 100644 --- a/api-reference/openapi.zh.json +++ b/api-reference/openapi.zh.json @@ -44827,7 +44827,7 @@ "Monitors/告警数据源" ], "x-mint": { - "content": "通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 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": "调用数据源工具" @@ -49939,7 +49939,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50090,7 +50090,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50164,7 +50164,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50244,7 +50244,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50345,7 +50345,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53745,7 +53745,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53832,7 +53832,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53929,7 +53929,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54051,7 +54051,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54131,7 +54131,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54212,7 +54212,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54288,7 +54288,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54369,7 +54369,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54467,7 +54467,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54549,7 +54549,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58089,7 +58089,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" diff --git a/api-reference/rum.openapi.zh.json b/api-reference/rum.openapi.zh.json index 3c6d6206..c0362e4d 100644 --- a/api-reference/rum.openapi.zh.json +++ b/api-reference/rum.openapi.zh.json @@ -4617,7 +4617,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4768,7 +4768,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4842,7 +4842,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4922,7 +4922,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5023,7 +5023,7 @@ } } }, - "description": "Success" + "description": "成功" }, "400": { "$ref": "#/components/responses/BadRequest" diff --git a/api-reference/safari.openapi.zh.json b/api-reference/safari.openapi.zh.json index f7e1fc84..be93ac17 100644 --- a/api-reference/safari.openapi.zh.json +++ b/api-reference/safari.openapi.zh.json @@ -4065,7 +4065,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -4185,7 +4185,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -4285,7 +4285,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -4369,7 +4369,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -4527,7 +4527,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -4607,7 +4607,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -4704,7 +4704,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -4780,7 +4780,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -4861,7 +4861,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -4942,7 +4942,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { diff --git a/en/openapi/api-catalog.mdx b/en/openapi/api-catalog.mdx index d1a8e44c..e56186e6 100644 --- a/en/openapi/api-catalog.mdx +++ b/en/openapi/api-catalog.mdx @@ -3,7 +3,7 @@ title: "API Catalog" description: "Complete list of Flashduty Open API endpoints, organized by product module with links to detailed documentation" --- -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. +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. 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 - + ### Alert rules @@ -304,6 +304,7 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated vi | POST | [`/monit/datasource/create`](/en/api-reference/monitors/data-sources/monit-datasource-write-create) | Create datasource | | POST | [`/monit/datasource/update`](/en/api-reference/monitors/data-sources/monit-datasource-write-update) | Update datasource | | POST | [`/monit/datasource/delete`](/en/api-reference/monitors/data-sources/monit-datasource-write-delete) | Delete datasource | +| POST | [`/monit/datasource/tools/invoke`](/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke) | Invoke datasource tool | | 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 | diff --git a/zh/openapi/api-catalog.mdx b/zh/openapi/api-catalog.mdx index 1d2466a6..e39982b1 100644 --- a/zh/openapi/api-catalog.mdx +++ b/zh/openapi/api-catalog.mdx @@ -3,7 +3,7 @@ title: "API 目录" description: "Flashduty Open API 接口完整列表，按产品模块组织并链接到详细文档" --- -Flashduty Open API 提供 **353** 个接口，覆盖 On-call、Monitors、RUM、AI SRE 和平台五个主要模块。所有接口使用统一认证方式和请求规范。详情参见[快速开始](/zh/openapi/introduction)。 +Flashduty Open API 提供 **354** 个接口，覆盖 On-call、Monitors、RUM、AI SRE 和平台五个主要模块。所有接口使用统一认证方式和请求规范。详情参见[快速开始](/zh/openapi/introduction)。 所有接口 URL 均以 `https://api.flashcat.cloud` 为 base，通过 query string 中的 APP Key 认证。 @@ -271,7 +271,7 @@ Flashduty Open API 提供 **353** 个接口，覆盖 On-call、Monitors、RUM、 - + ### 告警规则 @@ -304,6 +304,7 @@ Flashduty Open API 提供 **353** 个接口，覆盖 On-call、Monitors、RUM、 | POST | [`/monit/datasource/create`](/zh/api-reference/monitors/data-sources/monit-datasource-write-create) | 创建数据源 | | POST | [`/monit/datasource/update`](/zh/api-reference/monitors/data-sources/monit-datasource-write-update) | 更新数据源 | | POST | [`/monit/datasource/delete`](/zh/api-reference/monitors/data-sources/monit-datasource-write-delete) | 删除数据源 | +| POST | [`/monit/datasource/tools/invoke`](/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke) | 调用数据源工具 | | 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 日志库列表 |