Search Alert Severity¶
分页查询告警级别。
请求格式¶
POST https://{apigw-address}/event-service/v2.1/alert-severities?action=search
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织 ID。 如何获取 orgId 信息>> |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
expression |
可选 |
String |
查询表达式,支持类 SQL 的查询。目前支持的逻辑运算是 and 和 or,查询的字段和对应的运算符清单如下。
|
pagination |
可选 |
Pagination 请求结构体 |
分页的参数。如未指定,默认每页 10 条。每页最大记录数为 1000 条,但为获得最佳性能,建议每页不超过 50 条。默认按照 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
AlertSeverity 结构体数组 |
告警级别数组,AlertSeverity 结构体>> |
AlertSeverity 结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
severityId |
String |
告警级别编号。 |
orgId |
String |
资产所属的组织 ID。 |
severityDesc |
StringI18n |
告警级别描述。 |
tags |
Map |
标签。标签的作用与表示方法>> |
updatePerson |
String |
更新人。 |
updateTime |
Long |
更新的 UTC 时间。 |
示例¶
请求示例¶
url: https://{apigw-address}/event-service/v2.1/alert-severities?action=search&orgId=yourOrgId
method: POST
requestBody:
{
"pagination": {
"pageNo": 1,
"pageSize": 1,
"sorters": [{
"field": "severityId",
"order": "ASC"
}]
}
}
返回示例¶
{
"pagination": {
"pageNo": 1,
"pageSize": 1,
"totalSize": 19,
"sortedBy": [{
"field": "severityID",
"order": "ASC"
}]
},
"code": 0,
"msg": "OK",
"requestId": "bd591868-0eb1-46dc-a989-c1de33cc671e",
"data": [{
"severityId": "001",
"orgId": "yourOrgId",
"severityDesc": {
"defaultValue": null,
"i18nValue": {
"en_US": "Serious!!!",
"zh_CN": "严重!!!"
}
},
"tags": {
"111": "2222"
},
"updatePerson": "yj_test_customer",
"updateTime": 1559204166000,
"source": null,
}]
}
SDK 示例¶
你可以在 Github 上获取告警引擎的 SDK 示例: