Help Center/ Auto Scaling/ API Reference/ APIs/ Notifications/ Enabling Notification for an AS Group

Updated on 2024-05-23 GMT+08:00

View PDF

Enabling Notification for an AS Group

Function

This API is used to enable notification for an AS group. Each time this API is called, the AS group adds a notification topic and scenario. Each AS group supports up to five topics. The notification topic is pre-configured and subscribed by you in SMN. When the live network complies with the notification scenario that matches the notification topic, the AS group sends a notification to your subscription endpoints.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
scaling_group_id	Yes	String	Specifies the AS group ID.

Request

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
topic_urn	Yes	String	Specifies a unique topic in SMN.
topic_scene	Yes	Array of strings	Specifies a notification scenario, which can be one of the following: SCALING_UP: indicates that the capacity is expanded. SCALING_UP_FAIL: indicates that the capacity expansion failed. SCALING_DOWN: indicates that the capacity is reduced. SCALING_DOWN_FAIL: indicates that the capacity reduction failed. SCALING_GROUP_ABNORMAL: indicates that an exception has occurred in the AS group.

Example Request

This example enables notifications with topic_urn urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh for the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a. After the configuration is complete, a notification will be sent when capacity expansion succeeds or fails, capacity reduction succeeds or fails, or an error occurs in the AS group.

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"
     ]
}

Response

**Table 3** Response parameters
Parameter	Type	Description
topic_urn	String	Specifies a unique topic in SMN.
topic_scene	Array of strings	Specifies a notification scenario, which can be one of the following: SCALING_UP: indicates that the capacity is expanded. SCALING_UP_FAIL: indicates that the capacity expansion failed. SCALING_DOWN: indicates that the capacity is reduced. SCALING_DOWN_FAIL: indicates that the capacity reduction failed. SCALING_GROUP_ABNORMAL: indicates that an exception has occurred in the AS group.
topic_name	String	Specifies the topic name in SMN.

Example Response

{
    "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"
}

Returned Values

Normal
200

Abnormal

Returned Value	Description
400 Bad Request	The server failed to process the request.
401 Unauthorized	You must enter the username and password to access the requested page.
403 Forbidden	You are forbidden to access the requested page.
404 Not Found	The server could not find the requested page.
405 Method Not Allowed	You are not allowed to use the method specified in the request.
406 Not Acceptable	The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required	You must use the proxy server for authentication to process the request.
408 Request Timeout	The request timed out.
409 Conflict	The request could not be processed due to a conflict.
500 Internal Server Error	Failed to complete the request because of an internal service error.
501 Not Implemented	Failed to complete the request because the server does not support the requested function.
502 Bad Gateway	Failed to complete the request because the request is invalid.
503 Service Unavailable	Failed to complete the request because the system is unavailable.
504 Gateway Timeout	A gateway timeout error occurred.