Skip to content

docs(api): require a time range of at most 31 days on the alert event list #1041

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
Oct 12, 2026
Merged

docs(api): require a time range of at most 31 days on the alert event list #1041

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
22 changes: 10 additions & 12 deletions api-reference/on-call.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7763,7 +7763,7 @@
"On-call/Alerts"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Channels Read** (`on-call`) |\n\n## Usage\n\n- Results are filtered by the caller's channel data-access permissions.\n- `severities` is a comma-separated string, e.g. `\"Critical,Warning\"`.",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Channels Read** (`on-call`) |\n\n## Usage\n\n- Both `start_time` and `end_time` are required Unix epoch seconds. `start_time` must be less than `end_time`; the span must not exceed 31 days.\n- Results are filtered by the caller's channel data-access permissions.\n- `severities` is a comma-separated string, e.g. `\"Critical,Warning\"`.",
"href": "/en/api-reference/on-call/alerts/alert-event-read-list",
"metadata": {
"sidebarTitle": "List raw alert events"
Expand Down Expand Up @@ -18521,24 +18521,22 @@
},
"AlertEventGlobalListRequest": {
"type": "object",
"description": "Filter and pagination criteria for the global raw event list.",
"description": "Filter and pagination criteria for the global raw event list. Time range is required.",
"required": [
"start_time",
"end_time"
],
"properties": {
"start_time": {
"type": [
"integer",
"null"
],
"type": "integer",
"format": "int64",
"description": "Start of the search window, Unix epoch seconds. Must be greater than 0 when provided.",
"description": "Start of the search window, Unix epoch seconds. Must be greater than 0.",
"exclusiveMinimum": 0
},
"end_time": {
"type": [
"integer",
"null"
],
"type": "integer",
"format": "int64",
"description": "End of the search window, Unix epoch seconds. Must be greater than `start_time` when provided."
"description": "End of the search window, Unix epoch seconds. Must be greater than `start_time`; the span must not exceed 31 days."
},
"p": {
"type": [
Expand Down
22 changes: 10 additions & 12 deletions api-reference/on-call.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7763,7 +7763,7 @@
"On-call/告警管理"
],
"x-mint": {
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **协作空间查看**（`on-call`） |\n\n## 使用说明\n\n- 结果会根据调用方的协作空间数据访问权限进行过滤。\n- `severities` 为逗号分隔的字符串，如 `\"Critical,Warning\"`。",
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **协作空间查看**（`on-call`） |\n\n## 使用说明\n\n- `start_time` 和 `end_time` 均为必填的 Unix 时间戳（秒）。`start_time` 必须小于 `end_time`，跨度不超过 31 天。\n- 结果会根据调用方的协作空间数据访问权限进行过滤。\n- `severities` 为逗号分隔的字符串，如 `\"Critical,Warning\"`。",
"href": "/zh/api-reference/on-call/alerts/alert-event-read-list",
"metadata": {
"sidebarTitle": "查询原始告警事件列表"
Expand Down Expand Up @@ -18521,24 +18521,22 @@
},
"AlertEventGlobalListRequest": {
"type": "object",
"description": "全局原始事件列表的过滤和分页条件。",
"description": "全局原始事件列表的过滤和分页条件，时间范围必填。",
"required": [
"start_time",
"end_time"
],
"properties": {
"start_time": {
"type": [
"integer",
"null"
],
"type": "integer",
"format": "int64",
"description": "查询窗口起点，Unix 时间戳（秒）。提供时必须大于 0。",
"description": "查询窗口起点，Unix 时间戳（秒）。必须大于 0。",
"exclusiveMinimum": 0
},
"end_time": {
"type": [
"integer",
"null"
],
"type": "integer",
"format": "int64",
"description": "查询窗口终点，Unix 时间戳（秒）。提供时必须大于 `start_time`。"
"description": "查询窗口终点，Unix 时间戳（秒）。必须大于 `start_time`；跨度不超过 31 天。"
},
"p": {
"type": [
Expand Down
22 changes: 10 additions & 12 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,7 +850,7 @@
"type": "object"
},
"AlertEventGlobalListRequest": {
"description": "Filter and pagination criteria for the global raw event list.",
"description": "Filter and pagination criteria for the global raw event list. Time range is required.",
"properties": {
"asc": {
"description": "Sort ascending when `true`.",
Expand All @@ -866,12 +866,9 @@
"type": "array"
},
"end_time": {
"description": "End of the search window, Unix epoch seconds. Must be greater than `start_time` when provided.",
"description": "End of the search window, Unix epoch seconds. Must be greater than `start_time`; the span must not exceed 31 days.",
"format": "int64",
"type": [
"integer",
"null"
]
"type": "integer"
},
"integration_ids": {
"description": "Filter by integration IDs.",
Expand Down Expand Up @@ -926,15 +923,16 @@
"type": "string"
},
"start_time": {
"description": "Start of the search window, Unix epoch seconds. Must be greater than 0 when provided.",
"description": "Start of the search window, Unix epoch seconds. Must be greater than 0.",
"exclusiveMinimum": 0,
"format": "int64",
"type": [
"integer",
"null"
]
"type": "integer"
}
},
"required": [
"start_time",
"end_time"
],
"type": "object"
},
"AlertEventGlobalListResponse": {
Expand Down Expand Up @@ -33429,7 +33427,7 @@
"On-call/Alerts"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Channels Read** (`on-call`) |\n\n## Usage\n\n- Results are filtered by the caller's channel data-access permissions.\n- `severities` is a comma-separated string, e.g. `\"Critical,Warning\"`.",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Channels Read** (`on-call`) |\n\n## Usage\n\n- Both `start_time` and `end_time` are required Unix epoch seconds. `start_time` must be less than `end_time`; the span must not exceed 31 days.\n- Results are filtered by the caller's channel data-access permissions.\n- `severities` is a comma-separated string, e.g. `\"Critical,Warning\"`.",
"href": "/en/api-reference/on-call/alerts/alert-event-read-list",
"metadata": {
"sidebarTitle": "List raw alert events"
Expand Down
22 changes: 10 additions & 12 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,7 +850,7 @@
"type": "object"
},
"AlertEventGlobalListRequest": {
"description": "全局原始事件列表的过滤和分页条件。",
"description": "全局原始事件列表的过滤和分页条件，时间范围必填。",
"properties": {
"asc": {
"description": "为 true 时升序排序。",
Expand All @@ -866,12 +866,9 @@
"type": "array"
},
"end_time": {
"description": "查询窗口终点，Unix 时间戳（秒）。提供时必须大于 `start_time`。",
"description": "查询窗口终点，Unix 时间戳（秒）。必须大于 `start_time`；跨度不超过 31 天。",
"format": "int64",
"type": [
"integer",
"null"
]
"type": "integer"
},
"integration_ids": {
"description": "按集成 ID 过滤。",
Expand Down Expand Up @@ -926,15 +923,16 @@
"type": "string"
},
"start_time": {
"description": "查询窗口起点，Unix 时间戳（秒）。提供时必须大于 0。",
"description": "查询窗口起点，Unix 时间戳（秒）。必须大于 0。",
"exclusiveMinimum": 0,
"format": "int64",
"type": [
"integer",
"null"
]
"type": "integer"
}
},
"required": [
"start_time",
"end_time"
],
"type": "object"
},
"AlertEventGlobalListResponse": {
Expand Down Expand Up @@ -33429,7 +33427,7 @@
"On-call/告警管理"
],
"x-mint": {
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **协作空间查看**（`on-call`） |\n\n## 使用说明\n\n- 结果会根据调用方的协作空间数据访问权限进行过滤。\n- `severities` 为逗号分隔的字符串，如 `\"Critical,Warning\"`。",
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **协作空间查看**（`on-call`） |\n\n## 使用说明\n\n- `start_time` 和 `end_time` 均为必填的 Unix 时间戳（秒）。`start_time` 必须小于 `end_time`，跨度不超过 31 天。\n- 结果会根据调用方的协作空间数据访问权限进行过滤。\n- `severities` 为逗号分隔的字符串，如 `\"Critical,Warning\"`。",
"href": "/zh/api-reference/on-call/alerts/alert-event-read-list",
"metadata": {
"sidebarTitle": "查询原始告警事件列表"
Expand Down
Loading