创建通知

最近更新时间:2019-07-24 14:49:50

1. 接口描述

接口请求域名: as.tencentcloudapi.com 。

本接口(CreateNotificationConfiguration)用于创建通知。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateNotificationConfiguration
Version String 公共参数,本接口取值:2018-04-19
Region String 公共参数,详见产品支持的 地域列表
AutoScalingGroupId String 伸缩组ID。
NotificationTypes.N Array of String 通知类型,即为需要订阅的通知类型集合,取值范围如下:
  • SCALE_OUT_SUCCESSFUL:扩容成功
  • SCALE_OUT_FAILED:扩容失败
  • SCALE_IN_SUCCESSFUL:缩容成功
  • SCALE_IN_FAILED:缩容失败
  • REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL:替换不健康子机成功
  • REPLACE_UNHEALTHY_INSTANCE_FAILED:替换不健康子机失败
  • NotificationUserGroupIds.N Array of String 通知组ID,即为用户组ID集合,用户组ID可以通过DescribeUserGroup查询。

    3. 输出参数

    参数名称 类型 描述
    AutoScalingNotificationId String 通知ID。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建扩容成功、扩容失败事件通知

    输入示例

    https://as.tencentcloudapi.com/?Action=CreateNotificationConfiguration
    &AutoScalingGroupId=asg-12wjuh0s
    &NotificationTypes.0=SCALE_OUT_SUCCESSFUL
    &NotificationTypes.1=SCALE_OUT_FAILED
    &NotificationUserGroupIds.0=1678
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "AutoScalingNotificationId": "asn-2sestqbr",
        "RequestId": "fb02c8bd-5f38-4786-91b6-0c6e06a88832"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidParameterValue.UserGroupIdNotFound 用户组不存在。
    LimitExceeded 超过配额限制
    MissingParameter 缺少参数错误
    ResourceNotFound.AutoScalingGroupIdNotFound 伸缩组不存在。
    ResourceNotFound.AutoScalingNotificationNotFound 通知不存在。