Querying Notifications

Last updated: 2020-06-04 16:31:55

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new Auto Scaling API 3.0 which is standardized and faster.

    1. API Description

    This API (ModifyScalingNotification) is used to modify notification configuration.
    Domain for API request: scaling.api.qcloud.com

    2. Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is ModifyScalingNotification.

    Parameter Name Required Type Description
    scalingGroupId Yes String Scaling group ID of the notification to be modified. It can be queried by calling Query Scaling Group List (DescribeScalingGroup) API.
    notificationId Yes String ID of the notification to be modified. It can be queried by calling Query Notification (DescribeScalingNotification) API.
    notificationTypes.n No String An array of notification types, which is a collection of scaling activity notifications that need to be subscribed, ranging from 1 to 6. The specific mapping relationship is as follows:
    1: Scale-up Succeeded
    2: Scale-up Failed
    3: Scale-down Succeeded
    4: Scale-down Failed
    5: Replacement of Unhealthy Sub-machines Succeeded
    6: Replacement of Unhealthy Sub-machines Failed

    3. Output Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
    codeDesc String Error code at business side. If the task succeeds, it will return "Success"; if the task fails, the specific business error reason will be returned.
    message String Module error message description depending on API.
    data Array It is empty if returned successfully.

    4. Error Codes

    The following error codes only include the business logic error codes for this API. For additional common error codes, refer to AS Error Code.

    Error Code Description
    InvalidParameter.ScallingGroupId Cannot match to the corresponding scaling group ID
    InvalidParameter.NotifyType Invalid notification type number
    InvalidParameter.NotifyPara Notification parameter is empty
    InvalidParameter.NotifyId Cannot match to the corresponding notification ID
    InvalidParameter.GroupId Cannot match to the corresponding notification group ID

    5. Example

    https://scaling.api.qcloud.com/v2/index.php?
    &<Common Request Parameters>
    &scalingGroupId=xxxx
    &notificationTypes.0=1
    &notificationTypes.1=2
    &receiversIds.0=1832
    &receiversIds.1=1833

    Example of returned result is as below:

    {
        "code":"0",
        "message":"",
        "codeDesc":"Success"
        "data":[]
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help