Create Alert Content¶
创建告警内容。需要校验的字段有模型ID(modelId
)和告警类型ID(alertTypeId
)。
约束条件¶
确保告警内容所属的告警类型已被创建。
请求格式¶
POST https://{apigw-address}/event-service/v2.1/alert-contents?action=create
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织ID。 如何获取orgId信息>> |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
alertContent |
必需 |
GenerateContent结构体 |
告警内容。见 GenerateContent结构体>> |
GenerateContent结构体 ¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
contentId |
必需 |
String |
告警内容编号。 |
contentDesc |
必需 |
StringI18n |
国际化告警内容描述,其中 |
modelId |
必需 |
String |
告警内容所适用模型的ID。如何获取modelId信息>> |
alertTypeId |
必需 |
String |
关联的告警类型编号。 |
tags |
可选 |
Map |
告警内容的标签。详情见 标签的作用与表示方法>> |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
String |
告警内容ID。 |
示例¶
请求示例¶
url: https://{apigw-address}/event-service/v2.1/alert-contents?action=create&orgId=yourOrgId
method: POST
requestBody:
{
"alertContent": {
"contentId": "planetTemperature",
"contentDesc": {
"defaultValue": "Grid is connected from converter",
"i18nValue": {
"en_US": "Grid is connected from converter",
"zh_CN": "风机已并网"
}
},
"modelId": "WindDev-E0",
"alertTypeId": "9001",
"tags": {
"year": "2000",
"author": "cshan"
}
},
"action": "create"
}
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "94e0e6e5-10dd-4fcb-a013-331d5869975a",
"data": "planetTemperature"
}
SDK 示例¶
你可以在 Github 上获取告警引擎的 SDK 示例: