Update Alert Content
更新告警内容。需要校验的字段为modelId
和alertTypeId
。
请求格式
POST https://{apigw-address}/event-service/v2.1/alert-contents?action=update
请求参数(URI)
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
orgId |
Query |
必需 |
String |
资产所属的组织ID。 如何获取orgId信息>> |
isPatchUpdate |
Query |
必需 |
Boolean |
是否全量更新。
+ 当其值为 true 时,只更新参数中指定字段的值;
+ 当其值为 false 时,更新所有字段的值,即未指定值的字段将被置空。 |
请求参数(Body)
generateContent结构体
名称 |
必需/可选 |
数据类型 |
描述 |
contentId |
必需 |
String |
告警内容编号。 |
contentDesc |
必需 |
String |
告警内容描述。 |
modelId |
必需 |
String |
告警内容所适用模型的ID。 如何获取modelId信息>> |
alertTypeId |
必需 |
String |
关联的告警类型编号。 |
tags |
可选 |
Map |
标签,只支持全量更新。 详情见 标签的作用与表示方法>> |
示例
请求示例
url: https://{apigw-address}/event-service/v2.1/alert-contents?action=update&orgId=yourOrgId&isPatchUpdate=false
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": "update"
}
返回示例
{
"code": 0,
"msg": "OK",
"requestId": "4873095e-621d-4cfd-bc2c-edb520f574ea",
"data": null
}
SDK 示例
你可以在 Github 上获取告警引擎的 SDK 示例: