PrevNext
search by keyword

Recent Pages

Documentation
Auto Scaling
    Documentation
    Download PDF

    CreateNotificationConfiguration

    Last updated: 2021-05-25 10:54:36
    Download PDF

    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

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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 Notification group ID, which is the set of user group IDs. You can query the user group IDs through the ListGroups 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 successful and failed scale-out events

    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

    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.InvalidAutoScalingGroupId Invalid scaling group ID.
    InvalidParameterValue.InvalidNotificationUserGroupId The notification group ID should be a numeric string.
    InvalidParameterValue.UserGroupIdNotFound The user group does not exist.
    LimitExceeded The quota limit is exceeded.
    LimitExceeded.QuotaNotEnough You are short of the quota.
    MissingParameter Parameter missing.
    ResourceNotFound.AutoScalingGroupNotFound The scaling group does not exist.
    ResourceNotFound.AutoScalingNotificationNotFound The notification does not exist.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy