ManageSchedulerxNotificationPolicy - 更新通知策略

更新时间:

更新通知策略。

调试

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

授权信息

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

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

请求参数

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

地域 ID

cn-hangzhou
PolicyNamestring

通知策略名称

test-weekdays
Descriptionstring

通知策略描述

Monday-Friday only
ChannelTimeRangestring

通知渠道生效时间段配置

说明 请参考请求参数中 ChannelTimeRange 的补充说明
{ "sendChannel": "sms,webhook,mail,phone", "timezone": "UTC+08:00", "webhookIsAtAll": "false", "timeRanges": { "all": [ { "startTime": "08:00", "endTime": "18:00", "daysOfWeek": [1, 2, 3, 4, 5] } ] } }

ChannelTimeRange 配置说明

通知渠道的生效时间配置,支持统一配置和独立配置两种模式。

配置格式

该字段应为 JSON 格式,支持以下核心属性:

属性说明

sendChannel:通知渠道配置(必填)

  • 必填字段,指定需要配置的通知渠道
  • 格式:多个渠道用逗号分隔,如 "sms,webhook,mail,phone"
  • 支持的渠道:sms(短信)、webhook(如钉钉、企业微信)、mail(邮件)、phone(电话)

timezone:时区设置

  • 支持 GMT 或 UTC 格式
  • 示例:GMT+8 或 UTC+08:00
  • 说明:时区决定了报警生效时间的参考标准,与实际所在地区无关。例如在北京地区配置"美国纽约时区(UTC-4),周一 00:00-03:00",系统将以纽约当地时间为准。

webhookIsAtAll:Webhook 通知配置

  • 值为 "true" 或 "false"
  • 指示 webhook 通知时是否@所有成员

timeRanges:时间范围配置(必填)

  • 支持两种配置模式:
    1. 统一配置:使用 "all" 作为 key,为所有选择的渠道统一设置时间段
    2. 独立配置:为每个渠道单独配置时间段,key 为具体的渠道标识

时间段配置项

每个时间段包含以下属性:

  • startTime:开始时间,格式为 HH:mm (必填)
  • endTime:结束时间,格式为 HH:mm (必填)
  • daysOfWeek:生效的工作日,数组格式,1-7 代表周一到周日(非必填,为空时代表该时间段不生效)

示例配置

示例 1:统一配置模式

{
  "sendChannel": "sms,webhook,mail,phone",
  "timezone": "UTC+08:00",
  "webhookIsAtAll": "false",
  "timeRanges": {
    "all": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ]
  }
}

示例 2:独立配置模式

{
  "sendChannel": "sms,webhook,mail,phone",
  "timezone": "GMT+8",
  "webhookIsAtAll": "false",
  "timeRanges": {
    "webhook": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ],
    "sms": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ],
    "mail": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ],
    "phone": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ]
  }
}

注意事项

  1. sendChannel 字段必填,且只能包含支持的通知渠道
  2. 当 timeRanges 中包含 "all" 时,表示统一配置模式,此时不能包含其他渠道的配置
  3. 当 timeRanges 不包含 "all" 时,需要为 sendChannel 中指定的每个渠道进行独立配置
  4. 时间必须使用 24 小时制,格式为 HH:mm
  5. 工作日使用 1-7 的数字表示,分别对应周一到周日
  6. 时区支持 GMT 和 UTC 两种格式的配置

返回参数

名称类型描述示例值
object
Codeinteger

状态码

200
Messagestring

错误消息,仅错误时返回错误信息

Invalid parameter: policyName cannot be null
RequestIdstring

请求唯一 ID

4F68ABED-AC31-4412-9297-D9A8F0401108
Successboolean

是否成功

true
AccessDeniedDetailobject

访问被拒绝详细信息

AuthActionstring

鉴权操作

edas:ManageSchedulerxNotificationPolicy
AuthPrincipalDisplayNamestring

身份验证主体名称

209312833131416xxx
AuthPrincipalOwnerIdstring

身份验证主体所属账号

1827811800526xxx
AuthPrincipalTypestring

身份类型

SubUser
EncodedDiagnosticMessagestring

编码诊断信息

AQFn/cLPZ/3Cz0YxQkZBMjVGLTY0REUtNTlGNS05NzUwLTgyMUE4M0MwMTFDRQ==
NoPermissionTypestring

无权限类型

ImplicitDeny
PolicyTypestring

策略类型

AccountLevelIdentityBasedPolicy

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Invalid parameter: policyName cannot be null\n",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "edas:ManageSchedulerxNotificationPolicy",
    "AuthPrincipalDisplayName": "209312833131416xxx",
    "AuthPrincipalOwnerId": "1827811800526xxx",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFn/cLPZ/3Cz0YxQkZBMjVGLTY0REUtNTlGNS05NzUwLTgyMUE4M0MwMTFDRQ==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "AccountLevelIdentityBasedPolicy"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-10-29新增 OpenAPI查看变更详情