弹性伸缩创建通知-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（CreateNotificationConfiguration）用于创建通知。
通知到 CMQ 主题或队列时，消息内容如下：

{
    "Service": "Tencent Cloud Auto Scaling",
    "CreatedTime": "2021-10-11T10:15:11Z", // 活动创建时间
    "AppId": "100000000",
    "ActivityId": "asa-fznnvrja", // 伸缩活动ID
    "AutoScalingGroupId": "asg-pc2oqu2z", // 伸缩组ID
    "ActivityType": "SCALE_OUT",  // 伸缩活动类型
    "StatusCode": "SUCCESSFUL",   // 伸缩活动结果
    "Description": "Activity was launched in response to a difference between desired capacity and actual capacity,
    scale out 1 instance(s).", // 伸缩活动描述
    "StartTime": "2021-10-11T10:15:11Z",  // 活动开始时间
    "EndTime": "2021-10-11T10:15:32Z",    // 活动结束时间
    "DetailedStatusMessageSet": [ // 活动内部错误集合（非空不代表活动失败）
        {
            "Code": "InvalidInstanceType",
            "Zone": "ap-guangzhou-2",
            "InstanceId": "",
            "InstanceChargeType": "POSTPAID_BY_HOUR",
            "SubnetId": "subnet-4t5mgeuu",
            "Message": "The specified instance type `S5.LARGE8` is invalid in `subnet-4t5mgeuu`, `ap-guangzhou-2`.",
            "InstanceType": "S5.LARGE8"
        }
    ]
}

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateNotificationConfiguration。
Version	是	String	公共参数，本接口取值：2018-04-19。
Region	是	String	公共参数，详见产品支持的地域列表。
AutoScalingGroupId	是	String	伸缩组ID。示例值：asg-12wjuh0s
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：替换不健康子机失败示例值：["SCALE_OUT_SUCCESSFUL","SCALE_OUT_FAILED"]
NotificationUserGroupIds.N	否	Array of String	通知组ID，即为用户组ID集合，用户组ID可以通过ListGroups查询。示例值：["1678"]
TargetType	否	String	通知接收端类型，取值如下 USER_GROUP：用户组 CMQ_QUEUE：CMQ 队列 CMQ_TOPIC：CMQ 主题 TDMQ_CMQ_TOPIC：TDMQ CMQ 主题 TDMQ_CMQ_QUEUE：TDMQ CMQ 队列默认值为：`USER_GROUP`。示例值：USER_GROUP
QueueName	否	String	CMQ 队列名称，如 TargetType 取值为 `CMQ_QUEUE` 或 `TDMQ_CMQ_QUEUE` 时，该字段必填。示例值：queue
TopicName	否	String	CMQ 主题名称，如 TargetType 取值为 `CMQ_TOPIC` 或 `TDMQ_CMQ_TOPIC` 时，该字段必填。示例值：topic

3. 输出参数

参数名称	类型	描述
AutoScalingNotificationId	String	通知ID。示例值：asn-2sestqbr
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNotificationConfiguration
<公共请求参数>

{
    "AutoScalingGroupId": "asg-12wjuh0s",
    "NotificationUserGroupIds": [
        "1678"
    ],
    "NotificationTypes": [
        "SCALE_OUT_FAILED",
        "SCALE_OUT_SUCCESSFUL"
    ]
}

输出示例

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

示例2 创建扩容失败事件通知，接收端为 CMQ 队列

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNotificationConfiguration
<公共请求参数>

{
    "AutoScalingGroupId": "asg-pc2oqu2z",
    "NotificationTypes": [
        "SCALE_OUT_FAILED"
    ],
    "TargetType": "CMQ_QUEUE",
    "QueueName": "test-queue"
}

输出示例

{
    "Response": {
        "AutoScalingNotificationId": "asn-03kyokwk",
        "RequestId": "8565bcc0-7b02-4e9c-ae9f-27e3d3d73e12"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameter.ActionNotFound	无效的Action请求。
InvalidParameterValue.ConflictNotificationTarget	通知接收端类型冲突。
InvalidParameterValue.InvalidAutoScalingGroupId	伸缩组ID无效。
InvalidParameterValue.InvalidNotificationUserGroupId	指定的通知组 ID 不是数值字符串格式。
InvalidParameterValue.LimitExceeded	取值超出限制。
InvalidParameterValue.UserGroupIdNotFound	用户组不存在。
LimitExceeded	超过配额限制。
LimitExceeded.QuotaNotEnough	当前剩余配额不足。
MissingParameter	缺少参数错误。
ResourceNotFound.AutoScalingGroupNotFound	伸缩组不存在。
ResourceNotFound.CmqQueueNotFound	指定的 CMQ queue 不存在。
ResourceNotFound.TDMQCMQQueueNotFound	TDMQ-CMQ 队列不存在。
ResourceNotFound.TDMQCMQTopicNotFound	TDMQ-CMQ 主题不存在。
ResourceUnavailable.CmqTopicHasNoSubscriber	指定的 CMQ Topic 无订阅者。
ResourceUnavailable.TDMQCMQTopicHasNoSubscriber	TDMQ-CMQ 主题无订阅者。

创建通知

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

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

输入示例

输出示例

示例2 创建扩容失败事件通知，接收端为 CMQ 队列

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码