- route definition
- Url: /api/v1/ops/agent-meta
- Method: PUT
- Request:
OpsAgentMetaUpdateRequest - Response:
OpsAgentMetaResponse
- request definition
type OpsAgentMetaUpdateRequest struct {
AgentID string `json:"agentId"`
Meta interface{} `json:"meta"`
}
- response definition
type OpsAgentMetaResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/alerts
- Method: GET
- Request:
OpsAlertsRequest - Response:
OpsAlertsResponse
- request definition
type OpsAlertsRequest struct {
}
- response definition
type OpsAlertsResponse struct {
Alerts []string `json:"alerts"`
}
- route definition
- Url: /api/v1/ops/alerts/silence
- Method: POST
- Request:
OpsAlertSilenceRequest - Response:
OpsAlertSilenceResponse
- request definition
type OpsAlertSilenceRequest struct {
AlertID string `json:"alertId"`
Duration int `json:"duration"` // 静默时长(分钟)
}
- response definition
type OpsAlertSilenceResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/backups
- Method: POST
- Request:
OpsBackupCreateRequest - Response:
OpsBackupCreateResponse
- request definition
type OpsBackupCreateRequest struct {
Name string `json:"name,optional"`
}
- response definition
type OpsBackupCreateResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/backups
- Method: GET
- Request:
OpsBackupsListRequest - Response:
OpsBackupsListResponse
- request definition
type OpsBackupsListRequest struct {
Page int `form:"page,optional"`
PageSize int `form:"pageSize,optional"`
}
- response definition
type OpsBackupsListResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/backups/:id
- Method: DELETE
- Request:
OpsBackupDeleteRequest - Response:
OpsBackupDeleteResponse
- request definition
type OpsBackupDeleteRequest struct {
ID string `path:"id"`
}
- response definition
type OpsBackupDeleteResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/backups/:id/download
- Method: GET
- Request:
OpsBackupDownloadRequest - Response:
OpsBackupDownloadResponse
- request definition
type OpsBackupDownloadRequest struct {
ID string `path:"id"`
}
- response definition
type OpsBackupDownloadResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/config
- Method: GET
- Request:
OpsConfigRequest - Response:
OpsConfigResponse
- request definition
type OpsConfigRequest struct {
}
- response definition
type OpsConfigResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/functions
- Method: GET
- Request:
OpsFunctionsRequest - Response:
OpsFunctionsResponse
- request definition
type OpsFunctionsRequest struct {
}
- response definition
type OpsFunctionsResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/health
- Method: GET
- Request:
OpsHealthGetRequest - Response:
OpsHealthGetResponse
- request definition
type OpsHealthGetRequest struct {
}
- response definition
type OpsHealthGetResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/health
- Method: PUT
- Request:
OpsHealthUpdateRequest - Response:
OpsHealthUpdateResponse
- request definition
type OpsHealthUpdateRequest struct {
Enabled bool `json:"enabled"`
}
- response definition
type OpsHealthUpdateResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/health/run
- Method: POST
- Request:
OpsHealthRunRequest - Response:
OpsHealthRunResponse
- request definition
type OpsHealthRunRequest struct {
}
- response definition
type OpsHealthRunResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/maintenance
- Method: GET
- Request:
OpsMaintenanceGetRequest - Response:
OpsMaintenanceGetResponse
- request definition
type OpsMaintenanceGetRequest struct {
}
- response definition
type OpsMaintenanceGetResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/maintenance
- Method: PUT
- Request:
OpsMaintenanceUpdateRequest - Response:
OpsMaintenanceUpdateResponse
- request definition
type OpsMaintenanceUpdateRequest struct {
Enabled bool `json:"enabled"`
Message string `json:"message,optional"`
}
- response definition
type OpsMaintenanceUpdateResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/metrics
- Method: GET
- Request:
OpsMetricsQuery - Response:
OpsMetricsResponse
- request definition
type OpsMetricsQuery struct {
Start string `form:"start,optional"`
End string `form:"end,optional"`
}
- response definition
type OpsMetricsResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/mq
- Method: GET
- Request:
OpsMQRequest - Response:
OpsMQResponse
- request definition
type OpsMQRequest struct {
}
- response definition
type OpsMQResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/nodes
- Method: GET
- Request:
OpsNodesRequest - Response:
OpsNodesResponse
- request definition
type OpsNodesRequest struct {
}
- response definition
type OpsNodesResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/nodes/:nodeId/drain
- Method: POST
- Request:
OpsNodeActionRequest - Response:
OpsNodeDrainResponse
- request definition
type OpsNodeActionRequest struct {
NodeID string `path:"nodeId"`
}
- response definition
type OpsNodeDrainResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/nodes/:nodeId/meta
- Method: GET
- Request:
OpsNodeMetaRequest - Response:
OpsNodeMetaResponse
- request definition
type OpsNodeMetaRequest struct {
NodeID string `path:"nodeId"`
}
- response definition
type OpsNodeMetaResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/nodes/:nodeId/restart
- Method: POST
- Request:
OpsNodeActionRequest - Response:
OpsNodeRestartResponse
- request definition
type OpsNodeActionRequest struct {
NodeID string `path:"nodeId"`
}
- response definition
type OpsNodeRestartResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/nodes/:nodeId/undrain
- Method: POST
- Request:
OpsNodeActionRequest - Response:
OpsNodeUndrainResponse
- request definition
type OpsNodeActionRequest struct {
NodeID string `path:"nodeId"`
}
- response definition
type OpsNodeUndrainResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/nodes/commands
- Method: GET
- Request:
OpsNodeCommandsQuery - Response:
OpsNodeCommandsResponse
- request definition
type OpsNodeCommandsQuery struct {
NodeID string `form:"nodeId"`
}
- response definition
type OpsNodeCommandsResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/notifications
- Method: GET
- Request:
OpsNotificationsGetRequest - Response:
OpsNotificationsGetResponse
- request definition
type OpsNotificationsGetRequest struct {
}
- response definition
type OpsNotificationsGetResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/notifications
- Method: PUT
- Request:
OpsNotificationsUpdateRequest - Response:
OpsNotificationsUpdateResponse
- request definition
type OpsNotificationsUpdateRequest struct {
Enabled bool `json:"enabled"`
Channels []string `json:"channels,optional"`
}
- response definition
type OpsNotificationsUpdateResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/services
- Method: GET
- Request:
OpsServicesRequest - Response:
OpsServicesResponse
- request definition
type OpsServicesRequest struct {
}
- response definition
type OpsServicesResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/silences
- Method: GET
- Request:
OpsSilencesRequest - Response:
OpsSilencesResponse
- request definition
type OpsSilencesRequest struct {
}
- response definition
type OpsSilencesResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}
- route definition
- Url: /api/v1/ops/silences/:id
- Method: DELETE
- Request:
OpsAlertSilenceDeleteRequest - Response:
OpsSilenceDeleteResponse
- request definition
type OpsAlertSilenceDeleteRequest struct {
ID string `path:"id"`
}
- response definition
type OpsSilenceDeleteResponse struct {
Code int `json:"code"`
Message string `json:"message"`
Data interface{} `json:"data,omitempty"`
}