chore: improve api desc for alarms

This commit is contained in:
zhouzb 2022-09-30 15:34:49 +08:00
parent d1a15f1a43
commit f08982be93
1 changed files with 26 additions and 22 deletions

View File

@ -2,78 +2,82 @@ emqx_mgmt_api_alarms {
list_alarms_api {
desc {
en: """List alarms"""
zh: """列出告警,获取告警列表"""
en: """List currently activated alarms or historical alarms, determined by query parameters."""
zh: """列出当前激活的告警或历史告警,由查询参数决定。"""
}
}
delete_alarms_api {
desc {
en: """Remove all deactivated alarms"""
zh: """删除所有历史告警(非活跃告警)"""
en: """Remove all historical alarms."""
zh: """删除所有历史告警"""
}
}
delete_alarms_api_response204 {
desc {
en: """Remove all deactivated alarms ok"""
zh: """删除所有历史告警(非活跃告警)成功"""
en: """Historical alarms have been cleared successfully."""
zh: """历史告警已成功清除。"""
}
}
get_alarms_qs_activated {
desc {
en: """Activate alarms, or deactivate alarms. Default is false"""
zh: """活跃中的告警,或历史告警(非活跃告警),默认为 false"""
en: """It is used to specify the alarm type of the query.
When true, it returns the currently activated alarm,
and when it is false, it returns the historical alarm.
The default is false."""
zh: """用于指定查询的告警类型,
为 true 时返回当前激活的告警,为 false 时返回历史告警,默认为 false。"""
}
}
node {
desc {
en: """Alarm in node"""
zh: """告警节点名称"""
en: """The name of the node that triggered this alarm."""
zh: """触发此告警节点名称"""
}
}
name {
desc {
en: """Alarm name"""
zh: """告警名称"""
en: """Alarm name, used to distinguish different alarms."""
zh: """告警名称,用于区分不同的告警。"""
}
}
message {
desc {
en: """Alarm readable information"""
zh: """告警信息"""
en: """Alarm message, which describes the alarm content in a human-readable format."""
zh: """告警消息,以人类可读的方式描述告警内容。"""
}
}
details {
desc {
en: """Alarm details information"""
zh: """告警详细信息"""
en: """Alarm details, provides more alarm information, mainly for program processing."""
zh: """告警详情,提供了更多的告警信息,主要提供给程序处理。"""
}
}
duration {
desc {
en: """Alarms duration time; UNIX time stamp, millisecond"""
zh: """告警持续时间,单位:毫秒"""
en: """Indicates how long the alarm has lasted, in milliseconds."""
zh: """表明告警已经持续了多久,单位:毫秒。"""
}
}
activate_at {
desc {
en: """Alarms activate time, RFC 3339"""
zh: """告警开始时间,使用 rfc3339 标准时间格式"""
en: """Alarm start time, using rfc3339 standard time format."""
zh: """告警开始时间,使用 rfc3339 标准时间格式"""
}
}
deactivate_at {
desc {
en: """Alarms deactivate time, RFC 3339"""
zh: """告警结束时间,使用 rfc3339 标准时间格式"""
en: """Alarm end time, in the rfc3339 standard time format."""
zh: """告警结束时间,使用 rfc3339 标准时间格式"""
}
}