GET /v1/admin/status-page
读取状态页编辑视图
响应
| 状态码 | 说明 |
|---|---|
200 | Settings 字段： |
401 | Error |
403 | Error |
503 | Error |
失败时怎么办
401检查凭据格式、是否过期或被轮换。403检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。503依赖暂不可用：稍后用原 Idempotency-Key 重试。
| 方法 | 路径 | 摘要 | 认证 |
|---|---|---|---|
| GET | /v1/admin/status-page | 读取状态页编辑视图 | 登录会话 |
| PUT | /v1/admin/status-page | 保存状态页设置与组件 | 登录会话 |
| POST | /v1/admin/status-page/incidents | 新建状态页事件或计划维护 | 登录会话 |
| DELETE | /v1/admin/status-page/incidents/{incident_id} | 删除状态页事件 | 登录会话 |
| POST | /v1/admin/status-page/incidents/{incident_id}/updates | 追加状态页事件进展 | 登录会话 |
契约文件：api/control-status-page.openapi.yaml
接口详情
GET
PUT /v1/admin/status-page
保存状态页设置与组件
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
If-Match | header | string | 是 | — |
请求体
application/json · 必填：是
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
settings | SettingsInput | 是 | — |
components | array<ComponentInput> | 是 | — |
响应
| 状态码 | 说明 |
|---|---|
200 | Saved view 字段： |
400 | Error |
401 | Error |
403 | Error |
409 | Duplicate component name |
412 | Revision conflict |
428 | If-Match revision is missing |
503 | Error |
失败时怎么办
400按字段说明修正参数或请求体再发；不要原样重试。401检查凭据格式、是否过期或被轮换。403检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。409先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。412版本已变：回读最新 ETag 后重新判断，再带新的 If-Match 提交。428缺少前置条件：回读资源，带 If-Match（或页面要求的验证）再提交。503依赖暂不可用：稍后用原 Idempotency-Key 重试。
POST /v1/admin/status-page/incidents
新建状态页事件或计划维护
请求体
application/json · 必填：是
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
kind | string: incident / maintenance | 是 | — |
title | string | 是 | — |
impact | string | 否 | Required for an incident (degraded or outage); ignored for maintenance, which is always maintenance. |
status | string: investigating / identified / monitoring / resolved / scheduled / in_progress / completed | 否 | Incident: investigating, identified, monitoring or resolved (default investigating). Maintenance: scheduled, in_progress or completed (default scheduled). |
message | string | 是 | — |
component_ids | array<string(uuid)> | 否 | — |
scheduled_start | string(date-time) | 否 | Maintenance only, required there. |
scheduled_end | string(date-time) | 否 | Maintenance only, required there; after scheduled_start, at most 30 days after it, and in the future. |
响应
| 状态码 | 说明 |
|---|---|
201 | Created 字段： |
400 | Error |
401 | Error |
403 | Error |
503 | Error |
失败时怎么办
400按字段说明修正参数或请求体再发；不要原样重试。401检查凭据格式、是否过期或被轮换。403检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。503依赖暂不可用：稍后用原 Idempotency-Key 重试。
DELETE /v1/admin/status-page/incidents/{incident_id}
删除状态页事件
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
incident_id | path | string(uuid) | 是 | — |
响应
| 状态码 | 说明 |
|---|---|
204 | Deleted |
401 | Error |
403 | Error |
404 | Error |
503 | Error |
失败时怎么办
401检查凭据格式、是否过期或被轮换。403检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。404资源不存在或不属于当前租户。503依赖暂不可用：稍后用原 Idempotency-Key 重试。
POST /v1/admin/status-page/incidents/{incident_id}/updates
追加状态页事件进展
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
incident_id | path | string(uuid) | 是 | — |
请求体
application/json · 必填：是
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
status | string: investigating / identified / monitoring / resolved / scheduled / in_progress / completed | 是 | Must belong to the incident's kind. |
message | string | 是 | — |
响应
| 状态码 | 说明 |
|---|---|
200 | Updated incident 字段： |
400 | Error |
401 | Error |
403 | Error |
404 | Error |
409 | The incident is already resolved or the maintenance completed |
503 | Error |
失败时怎么办
400按字段说明修正参数或请求体再发；不要原样重试。401检查凭据格式、是否过期或被轮换。403检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。404资源不存在或不属于当前租户。409先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。503依赖暂不可用：稍后用原 Idempotency-Key 重试。