文档首页/ 弹性伸缩 AS/ API参考/ API/ 通知/ 配置伸缩组通知
更新时间：2023-06-27 GMT+08:00
查看PDF
分享

配置伸缩组通知

功能介绍

给弹性伸缩组配置通知功能。每调用一次该接口，伸缩组即配置一个通知主题及其通知场景，每个伸缩组最多可以增加5个主题。通知主题由用户事先在SMN创建并进行订阅，当通知主题对应的通知场景出现时，伸缩组会向用户的订阅终端发送通知。

调试

您可以在API Explorer中调试该接口。

URI

PUT /autoscaling-api/v1/{project_id}/scaling_notification/{scaling_group_id}

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

scaling_group_id

是

String

伸缩组ID

请求参数

表2 请求参数

参数

是否必选

参数类型

描述

topic_urn

是

String

SMN服务中Topic的唯一的资源标识。创建Topic请参考《消息通知服务》的创建Topic。

topic_scene

是

Array of strings

通知场景，有以下五种类型。

  • SCALING_UP：扩容成功
  • SCALING_UP_FAIL：扩容失败
  • SCALING_DOWN：缩容成功
  • SCALING_DOWN_FAIL：缩容失败
  • SCALING_GROUP_ABNORMAL：伸缩组发生异常

请求示例

创建一个topic_urn为urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh的通知，在ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组扩容成功，扩容失败，缩容成功，缩容失败，伸缩组发生异常场景下会发送消息。

PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_notification/e5d27f5c-dd76-4a61-b4bc-a67c5686719a

{
    "topic_urn": "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh",
    "topic_scene": [
        "SCALING_UP","SCALING_UP_FAIL","SCALING_DOWN","SCALING_DOWN_FAIL","SCALING_GROUP_ABNORMAL"
     ]
}

响应参数

表3 响应参数

参数

参数类型

描述

topic_urn

String

SMN服务中Topic的唯一的资源标识

topic_scene

Array of strings

通知场景，有以下五种类型。

  • SCALING_UP：扩容成功
  • SCALING_UP_FAIL：扩容失败
  • SCALING_DOWN：缩容成功
  • SCALING_DOWN_FAIL：缩容失败
  • SCALING_GROUP_ABNORMAL：伸缩组发生异常

topic_name

String

SMN服务中Topic的资源名称。

响应示例

{
    "topic_urn": "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh",
    "topic_scene": [
        "SCALING_UP","SCALING_UP_FAIL","SCALING_DOWN","SCALING_DOWN_FAIL","SCALING_GROUP_ABNORMAL"
     ],
    "topic_name": "gsh"
}

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    服务器未能处理请求。

    401 Unauthorized

    被请求的页面需要用户名和密码。

    403 Forbidden

    对被请求的页面访问禁止。

    404 Not Found

    服务器无法找到被请求的页面。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    406 Not Acceptable

    服务器生成的响应无法被客户端所接受。

    407 Proxy Authentication Required

    用户必须首先使用代理服务器进行验证，这样请求才会被处理。

    408 Request Timeout

    请求超出了服务器的等待时间。

    409 Conflict

    由于冲突，请求无法被完成。

    500 Internal Server Error

    请求未完成。服务异常。

    501 Not Implemented

    请求未完成。服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成。服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成。系统暂时异常。

    504 Gateway Timeout

    网关超时。

错误码

请参考错误码。

父主题： 通知

相关文档