Update Alert Type¶
更新告警类型。需要校验的字段为 typeId。如果告警类型已经有了父告警类型（parentTypeId）或不是一个子类型，则该父告警类型不能被修改。
请求格式¶
POST https://{apigw-address}/event-service/v2.1/alert-types?action=update
请求参数（URI）¶
| 名称 | 位置（Path/Query） | 必需/可选 | 数据类型 | 描述 |
|---|---|---|---|---|
| orgId | Query | 必需 | String | 资产所属的组织 ID。如何获取 orgId 信息>> |
| isPatchUpdate | Query | 必需 | Boolean | 是否全量更新。
当其值为 true 时，只更新参数中指定字段的值；
当其值为 false 时，更新所有字段的值，即未指定值的字段将被置空。 |
请求参数（Body）¶
| 名称 | 必需/可选 | 数据类型 | 描述 |
|---|---|---|---|
| type | 必需 | GenerateType 结构体 | 告警类型，其结构参见 GenerateType 结构体。 |
GenerateType 结构体
| 名称 | 必需/可选 | 数据类型 | 描述 |
|---|---|---|---|
| typeId | 必需 | String | 告警类型编号 |
| typeDesc | 必需 | StringI18n | 国际化告警类型描述，其中 default 必填。其结构参见 国际化名称结构体。 |
| tags | 可选 | tags 数据类型 | 告警类型的标签。标签的作用与表示方法>> |
| parentTypeId | 可选 | String | 父告警类型编号。只有在告警类型是另一类型的子类型时才能使用。 |
示例¶
请求示例¶
url: https://{apigw-address}/event-service/v2.1/alert-types?action=update&orgId=yourOrgId&isPatchUpdate=false
method: POST
requestBody:
{
"action": "update",
"type":{
"typeId":"planetTemperature",
"typeDesc":{
"defaultValue":"OverLimit",
"parentTypeId":"parent",
"i18nValue":{
"en_US":"OverLimit",
"zh_CN":"超限"
}
},
"tags":{
"year":"2000",
"author":"cshan"
},
"parentTypeId": "chenchen_test_documentation"
}
}
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "4873095e-621d-4cfd-bc2c-edb520f574ea",
"data": null
}