全部产品
Search
文档中心

应用实时监控服务ARMS:CreateOrUpdateSilencePolicy - 新增及修改静默策略

更新时间:Nov 05, 2024

创建或修改静默策略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:CreateDispatchRulenone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Idlong

静默策略 ID。

  • 不填代表创建新的静默策略。
  • 填写代表修改指定静默策略信息。
1234
Namestring

静默策略名称。

silencepolicy_test
MatchingRulesstring

设置分派规则。格式如下:

[
     {
	 "matchingConditions": [
	 {
	 "value": "test",      //分派规则条件 Value。
	 "key": "altertname",     //分派规则条件 Key。
	 "operator": "eq"      //分派规则条件聚合方式,包括 eq(等于)、neq(不等于)、in(包含)、nin(不包含)、re(匹配正则)、nre(正则不匹配)。  
	 }
	 ]
     }
	 ]
[ { "matchingConditions": [ { "value": "test", "key": "altertname", "operator": "eq" } ] } ]
RegionIdstring

地域 ID。

cn-beijing
Statestring

静默策略是否启用,enable 启用,disable 停用

enable
EffectiveTimeTypestring

静默策略生效时间类型,PERMANENT - 永久生效,CUSTOM_TIME - 自定义时间段生效,CYCLE_EFFECT - 循环生效。

PERMANENT
TimePeriodstring

循环周期,当静默策略生效类型为 CYCLE_EFFECT(循环生效)时必填。DAY-按天循环,WEEK-按周循环。

DAY
TimeSlotsstring

通知策略生效时间段。当生效时间类型为 CUSTOM_TIME(自定义时间段时),输入格式为[{"startTime":"2024-08-04 22:13","endTime":"2024-08-04 22:21"}]。当生效时间类型为 CYCLE_EFFECT(循环生效),且循环周期是 DAY(按天循环)时,输入格式为[{"startTime":"22:13","endTime":"22:21"}](开始时间不能小于结束时间)。当生效时间类型为 CYCLE_EFFECT(循环生效),且循环周期是 WEEK(按周循环)时,输入格式为[{"startWeek":"1", "endWeek":"2" "startTime":"22:13","endTime":"22:21"}](week 参数取值为 1-7,且开始时间不能小于结束时间)。

[{"startTime":"2024-08-04 22:13","endTime":"2024-08-04 22:21"}]

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

A5EC8221-08F2-4C95-9AF1-49FD998C****
SilencePolicyobject

静默策略对象。

Idlong

静默策略 ID。

1234
Namestring

静默策略名称。

silencepolicy_test
MatchingRulesarray<object>

分派规则。

matchingRulesobject

分派规则对象。

MatchingConditionsarray<object>

分派规则条件。

matchingConditionsobject

分派条件对象。

Keystring

分派规则条件 Key。

altertname
Valuestring

分派规则条件 Value。

test
Operatorstring

分派规则条件聚合方式。

  • eq:等于
  • neq:不等于
  • in:包含
  • nin:不包含
  • re:匹配正则
  • nre:正则不匹配
eq
Statestring

静默策略是否启用,enable 启用,disable 停用

enable

示例

正常返回示例

JSON格式

{
  "RequestId": "A5EC8221-08F2-4C95-9AF1-49FD998C****",
  "SilencePolicy": {
    "Id": 1234,
    "Name": "silencepolicy_test",
    "MatchingRules": [
      {
        "MatchingConditions": [
          {
            "Key": "altertname",
            "Value": "test",
            "Operator": "eq"
          }
        ]
      }
    ],
    "State": "enable",
    "EffectiveTimeType": "",
    "TimePeriod": "",
    "TimeSlots": ""
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-08-12OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-05-24OpenAPI 返回结构发生变更查看变更详情
2024-05-24OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-02-24新增 OpenAPI查看变更详情