运维简化 API
状态:Compatibility — 拆分/兼容参考,不是 canonical。运维域当前主入口请用 运维 API,本页不能新增独立语义。
1. "更新代理元数据"
- route definition
- Url: /api/v1/ops/agent-meta
- Method: PUT
- Request:
OpsAgentMetaUpdateRequest - Response:
OpsAgentMetaResponse
- request definition
go
type OpsAgentMetaUpdateRequest struct {
AgentID string `json:"agentId"`
Meta interface{} `json:"meta"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。2. "获取告警列表"
- route definition
- Url: /api/v1/ops/alerts
- Method: GET
- Request:
OpsAlertsRequest - Response:
OpsAlertsResponse
- request definition
go
type OpsAlertsRequest struct {
}- response definition
go
type OpsAlertsResponse struct {
Alerts []string `json:"alerts"`
}3. "静默告警"
- route definition
- Url: /api/v1/ops/alerts/silence
- Method: POST
- Request:
OpsAlertSilenceRequest - Response:
OpsAlertSilenceResponse
- request definition
go
type OpsAlertSilenceRequest struct {
AlertID string `json:"alertId"`
Duration int `json:"duration"` // 静默时长(分钟)
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。4. "创建备份"
- route definition
- Url: /api/v1/ops/backups
- Method: POST
- Request:
OpsBackupCreateRequest - Response:
OpsBackupCreateResponse
- request definition
go
type OpsBackupCreateRequest struct {
Name string `json:"name,optional"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。5. "获取备份列表"
- route definition
- Url: /api/v1/ops/backups
- Method: GET
- Request:
OpsBackupsListRequest - Response:
OpsBackupsListResponse
- request definition
go
type OpsBackupsListRequest struct {
Page int `form:"page,optional"`
PageSize int `form:"pageSize,optional"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。6. "删除备份"
- route definition
- Url: /api/v1/ops/backups/:id
- Method: DELETE
- Request:
OpsBackupDeleteRequest - Response:
OpsBackupDeleteResponse
- request definition
go
type OpsBackupDeleteRequest struct {
ID string `path:"id"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。7. "下载备份"
- route definition
- Url: /api/v1/ops/backups/:id/download
- Method: GET
- Request:
OpsBackupDownloadRequest - Response:
OpsBackupDownloadResponse
- request definition
go
type OpsBackupDownloadRequest struct {
ID string `path:"id"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。8. "获取运维配置"
- route definition
- Url: /api/v1/ops/config
- Method: GET
- Request:
OpsConfigRequest - Response:
OpsConfigResponse
- request definition
go
type OpsConfigRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。9. "获取函数列表"
- route definition
- Url: /api/v1/ops/functions
- Method: GET
- Request:
OpsFunctionsRequest - Response:
OpsFunctionsResponse
- request definition
go
type OpsFunctionsRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。10. "获取健康状态"
- route definition
- Url: /api/v1/ops/health
- Method: GET
- Request:
OpsHealthGetRequest - Response:
OpsHealthGetResponse
- request definition
go
type OpsHealthGetRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。11. "更新健康检查配置"
- route definition
- Url: /api/v1/ops/health
- Method: PUT
- Request:
OpsHealthUpdateRequest - Response:
OpsHealthUpdateResponse
- request definition
go
type OpsHealthUpdateRequest struct {
Enabled bool `json:"enabled"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。12. "运行健康检查"
- route definition
- Url: /api/v1/ops/health/run
- Method: POST
- Request:
OpsHealthRunRequest - Response:
OpsHealthRunResponse
- request definition
go
type OpsHealthRunRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。13. "获取维护模式状态"
- route definition
- Url: /api/v1/ops/maintenance
- Method: GET
- Request:
OpsMaintenanceGetRequest - Response:
OpsMaintenanceGetResponse
- request definition
go
type OpsMaintenanceGetRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。14. "更新维护模式"
- route definition
- Url: /api/v1/ops/maintenance
- Method: PUT
- Request:
OpsMaintenanceUpdateRequest - Response:
OpsMaintenanceUpdateResponse
- request definition
go
type OpsMaintenanceUpdateRequest struct {
Enabled bool `json:"enabled"`
Message string `json:"message,optional"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。15. "获取指标"
- route definition
- Url: /api/v1/ops/metrics
- Method: GET
- Request:
OpsMetricsQuery - Response:
OpsMetricsResponse
- request definition
go
type OpsMetricsQuery struct {
Start string `form:"start,optional"`
End string `form:"end,optional"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。16. "获取消息队列状态"
- route definition
- Url: /api/v1/ops/mq
- Method: GET
- Request:
OpsMQRequest - Response:
OpsMQResponse
- request definition
go
type OpsMQRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。17. "获取节点列表"
- route definition
- Url: /api/v1/ops/nodes
- Method: GET
- Request:
OpsNodesRequest - Response:
OpsNodesResponse
- request definition
go
type OpsNodesRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。18. "排空节点"
- route definition
- Url: /api/v1/ops/nodes/:nodeId/drain
- Method: POST
- Request:
OpsNodeActionRequest - Response:
OpsNodeDrainResponse
- request definition
go
type OpsNodeActionRequest struct {
NodeID string `path:"nodeId"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。19. "获取节点元数据"
- route definition
- Url: /api/v1/ops/nodes/:nodeId/meta
- Method: GET
- Request:
OpsNodeMetaRequest - Response:
OpsNodeMetaResponse
- request definition
go
type OpsNodeMetaRequest struct {
NodeID string `path:"nodeId"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。20. "重启节点"
- route definition
- Url: /api/v1/ops/nodes/:nodeId/restart
- Method: POST
- Request:
OpsNodeActionRequest - Response:
OpsNodeRestartResponse
- request definition
go
type OpsNodeActionRequest struct {
NodeID string `path:"nodeId"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。21. "取消排空节点"
- route definition
- Url: /api/v1/ops/nodes/:nodeId/undrain
- Method: POST
- Request:
OpsNodeActionRequest - Response:
OpsNodeUndrainResponse
- request definition
go
type OpsNodeActionRequest struct {
NodeID string `path:"nodeId"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。22. "获取节点命令"
- route definition
- Url: /api/v1/ops/nodes/commands
- Method: GET
- Request:
OpsNodeCommandsQuery - Response:
OpsNodeCommandsResponse
- request definition
go
type OpsNodeCommandsQuery struct {
NodeID string `form:"nodeId"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。23. "获取通知配置"
- route definition
- Url: /api/v1/ops/notifications
- Method: GET
- Request:
OpsNotificationsGetRequest - Response:
OpsNotificationsGetResponse
- request definition
go
type OpsNotificationsGetRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。24. "更新通知配置"
- route definition
- Url: /api/v1/ops/notifications
- Method: PUT
- Request:
OpsNotificationsUpdateRequest - Response:
OpsNotificationsUpdateResponse
- request definition
go
type OpsNotificationsUpdateRequest struct {
Enabled bool `json:"enabled"`
Channels []string `json:"channels,optional"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。25. "获取服务列表"
- route definition
- Url: /api/v1/ops/services
- Method: GET
- Request:
OpsServicesRequest - Response:
OpsServicesResponse
- request definition
go
type OpsServicesRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。26. "获取静默规则列表"
- route definition
- Url: /api/v1/ops/silences
- Method: GET
- Request:
OpsSilencesRequest - Response:
OpsSilencesResponse
- request definition
go
type OpsSilencesRequest struct {
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。27. "删除静默规则"
- route definition
- Url: /api/v1/ops/silences/:id
- Method: DELETE
- Request:
OpsAlertSilenceDeleteRequest - Response:
OpsSilenceDeleteResponse
- request definition
go
type OpsAlertSilenceDeleteRequest struct {
ID string `path:"id"`
}- response definition
go
// 实际响应为裸 payload(业务 DTO 直接 JSON 序列化),无 code/message envelope。
// 错误统一 { "error", "message", "details" }(见 rest.md)。