Help & DocumentationAuto ScalingAPI DocumentationNotification APIsCreateNotificationConfiguration

CreateNotificationConfiguration

Last updated: 2020-03-06 20:45:41

PDF

Contents：

1. API Description

Domain name for API request: as.tencentcloudapi.com.

This API (CreateNotificationConfiguration) is used to create a notification.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: as.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateNotificationConfiguration.
Version Yes String Common parameter. The value used for this API: 2018-04-19.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
AutoScalingGroupId Yes String Auto scaling group ID.
NotificationTypes.N Yes Array of String Notification type, i.e., the set of types of notifications to be subscribed to. Value range:
  • SCALE_OUT_SUCCESSFUL: scale-out succeeded
  • SCALE_OUT_FAILED: scale-out failed
  • SCALE_IN_SUCCESSFUL: scale-in succeeded
  • SCALE_IN_FAILED: scale-in failed
  • REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL: unhealthy instance replacement succeeded
  • REPLACE_UNHEALTHY_INSTANCE_FAILED: unhealthy instance replacement failed
    		•
    NotificationUserGroupIds.N Yes Array of String Array of String | Notification group ID, which is the set of user group IDs and can be queried through the DescribeUserGroup API.

    3. Output Parameters

    Parameter Name Type Description
    AutoScalingNotificationId String Notification ID.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating Notifications for Expansion Success and Expansion Failure

    Input Example

    https://as.tencentcloudapi.com/?Action=CreateNotificationConfiguration
&AutoScalingGroupId=asg-12wjuh0s
&NotificationTypes.0=SCALE_OUT_SUCCESSFUL
&NotificationTypes.1=SCALE_OUT_FAILED
&NotificationUserGroupIds.0=1678
&<common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameterValue.UserGroupIdNotFound The user group does not exist.
    LimitExceeded Quota limit is exceeded.
    MissingParameter Missing parameter.
    ResourceNotFound.AutoScalingGroupIdNotFound The auto scaling group does not exist.
    ResourceNotFound.AutoScalingNotificationNotFound The notification does not exist.