最近更新时间:2024.04.19 11:53:55
首次发布时间:2023.06.30 15:23:34
更新告警规则。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateAlertingRule | 公共参数,本接口值:UpdateAlertingRule。 |
Version | String | 是 | 2021-03-03 | 公共参数,本接口值:2021-03-03 |
Id | String | 是 | 90b5a3da-3464-4718-92e4-039bf41d3cff | 告警规则 ID。 |
Name | String | 否 | test | 告警规则名称。 |
Description | String | 否 | 这是一段描述 | 告警规则描述信息。 |
Type | String | 否 | vmp/PromQL | 告警规则类型,固定取值为vmp/PromQL 。 |
Query | Object AlertingRuleQuery | 否 | - | 告警配置。 |
Levels | Array of AlertingRuleLevel | 否 | - | 告警等级。 |
NotifyPolicyId | String | 否 | 8cd7b480-6387-44e5-aea4-db4ca2c4b47a | 告警通知策略 ID。 |
NotifyGroupPolicyId | String | 否 | ce4d942a-bac3-4ef6-b3a0-b7845b3b53bf | 告警通知聚合策略 ID。 |
说明
Type
和Query
参数必须同时存在。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
WorkspaceId | String | 是 | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | 工作区 ID。 |
PromQL | String | 是 | sum(up) | 查询语句。 |
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Level | String | 是 | P0 | 告警规则等级,包括:P0、P1 和P2。 |
For | String | 是 | 5m | 告警持续时间:
|
Comparator | String | 是 | > | 告警规则比较条件:
|
Threshold | Float64 | 是 | 1.0 | 告警规则阈值。 |
注意
若请求参数包含 Levels,则 Levels.Level 的值不能重复。
POST /?Action=UpdateAlertingRule&Version=2021-03-03 Content-Type:application/json { "Id": "90b5a3da-3464-4718-92e4-039bf41d3cff", "Name": " test", "Description": "这是一段描述", "Type": "vmp/PromQL", "Query": { "WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c", "PromQL": " sum(up)" }, "Levels": [ { "Level": " P0", "For": " 5m", "Comparator": " >", "Threshold": } ], "NotifyPolicyId": "8cd7b480-6387-44e5-aea4-db4ca2c4b47a", "NotifyGroupPolicyId": "ce4d942a-bac3-4ef6-b3a0-b7845b3b53bf" }
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 90b5a3da-3464-4718-92e4-039bf41d3cff | 告警规则 ID。 |
HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "202211302208xxxx", "Action": "UpdateAlertingRule", "Version": "2021-03-03", "Service": "vmp", "Region": "cn-beijing" }, "Result": { "Id": "90b5a3da-3464-4718-92e4-039bf41d3cff" } }
本接口错误码如下表所示,公共错误码请参见 公共错误码。
HTTP 状态码 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | NotFound.Id | The specified AlertingRule {{Id}} is not found. | 未找到指定的告警规则。 |
409 | Conflict.Name | The specified name conflicts with existing AlertingRule. | 同一工作区内不能有同名的告警规则。 |