You need to enable JavaScript to run this app.
导航
CreateSilencePolicy
最近更新时间:2024.09.03 15:42:18首次发布时间:2024.08.16 17:03:02

创建告警静默策略。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=CreateSilencePolicy&Version=2021-03-03

请求参数

参数类型是否必选示例值描述
ActionStringCreateSilencePolicy接口名称。当前 API 的名称为 CreateSilencePolicy
VersionString2021-03-03接口版本。当前 API 的版本为 2021-03-03

Name

String

alert-silence-demo

告警静默策略名称。

  • 字符串形式,取值范围为 1~128 字符。
  • 支持中文,字母,数字,下划线和中划线。不能以数字,下划线开头。
  • 相同地域内名称唯一。

Description

String

这是一段描述

告警静默策略的描述信息。

  • 字符串形式,取值范围为 1~128 字符。
  • 支持任意 utf-8 字符。
LabelMatchersArray of String-使用告警中包含的 Label 匹配需要静默的告警事件。
TimeRangeMatchersArray of TimeRangeMatcher-告警静默时间。

TimeRangeMatcher

参数类型是否必选示例值描述
DateString2006-01-02 15:04~2006-01-03 14:04告警静默的时间段。用于配置指定时间段内的告警静默。
LocationStringAsia/Shanghai时区。
PeriodicDateObject of PeriodicDate-告警静默的周期。用于配置周期生效的告警静默。

PeriodicDate

参数类型是否必选示例值描述
TimeString20:00~21:12时间周期。

请求示例

POST https://open.volcengineapi.com/?Action=CreateSilencePolicy&Version=2021-03-03
Content-Type: application/json
{
    "Name": "alert-silence-demo",
    "Description": "这是一段描述",
    "LabelMatchers": [
        [
            {
                "Label": "app",
                "Value": "test",
                "Operator": "=~"
            }
        ]
    ],
    "TimeRangeMatchers": [
        {
            "Date": "2006-01-02 15:04~2006-01-03 14:04",
            "Location": "Asia/Shanghai",
            "PeriodicDate": {
                "Time": "20:00~21:12",
            }
        }
    ]
}

返回参数

参数类型示例值描述
IdStringe28ae750-bbb8-4ff4-abf4-1e0e0f88808c告警静默策略 ID。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateSilencePolicy",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
    }
}

错误码

本接口错误码如下表所示,公共错误码请参见 公共错误码

HTTP 状态码错误码错误信息说明
400InvalidParameter.{{parameter}}The specified parameter {{parameter}} is invalid.指定的参数无效。
400MissingParameter.{{parameter}}The required parameter {{parameter}} is missing.缺少必要的参数。
403ProductUnsubscribedYou are not subscribed to the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service当前账号未订阅 VMP 服务。
409Conflict.NameThe specified name conflicts with existing {{resource}}.指定的名称与已有资源重复。