有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(ModifyNotificationConfiguration)用于修改通知。

  • 通知的接收端类型不支持修改。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyNotificationConfiguration。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
AutoScalingNotificationId String 待修改的通知ID。
示例值:asn-2sestqbr
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_IN_SUCCESSFUL","SCALE_IN_FAILED"]
    NotificationUserGroupIds.N Array of String 通知组ID,即为用户组ID集合,用户组ID可以通过ListGroups查询。
    示例值:["1678"]
    QueueName String CMQ 队列或 TDMQ CMQ 队列名。
    示例值:queue
    TopicName String CMQ 主题或 TDMQ CMQ 主题名。
    示例值:topic

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 修改事件通知

    输入示例

    POST / HTTP/1.1
    Host: as.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyNotificationConfiguration
    <公共请求参数>
    
    {
        "NotificationUserGroupIds": [
            "1678"
        ],
        "NotificationTypes": [
            "SCALE_IN_FAILED",
            "SCALE_IN_SUCCESSFUL"
        ],
        "AutoScalingNotificationId": "asn-2sestqbr"
    }

    输出示例

    {
        "Response": {
            "RequestId": "52e32a5b-5f69-4d48-a3f1-f2fea5c43a70"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter.ActionNotFound 无效的Action请求。
    InvalidParameterValue.ConflictNotificationTarget 通知接收端类型冲突。
    InvalidParameterValue.InvalidAutoScalingNotificationId 通知ID无效。
    InvalidParameterValue.InvalidNotificationUserGroupId 指定的通知组 ID 不是数值字符串格式。
    InvalidParameterValue.UserGroupIdNotFound 用户组不存在。
    ResourceNotFound.AutoScalingNotificationNotFound 通知不存在。
    ResourceNotFound.CmqQueueNotFound 指定的 CMQ queue 不存在。
    ResourceNotFound.TDMQCMQQueueNotFound TDMQ-CMQ 队列不存在。
    ResourceNotFound.TDMQCMQTopicNotFound TDMQ-CMQ 主题不存在。
    ResourceUnavailable.TDMQCMQTopicHasNoSubscriber TDMQ-CMQ 主题无订阅者。