DescribeNotificationConfigurations

Last updated: 2021-10-20 17:00:56

1. API Description

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

This API (DescribeNotificationConfigurations) is used to query the information of one or more notifications.

You can query the details of notifications based on information such as notification ID and auto scaling group ID. For more information on filters, see Filter.
If the parameter is empty, a certain number (specified by Limit and 20 by default) of notifications of the current user will be returned.

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

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: DescribeNotificationConfigurations.
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.
AutoScalingNotificationIds.N No Array of String Queries by one or more notification IDs in the format of asn-2sestqbr. The maximum number of instances per request is 100. This parameter does not support specifying both AutoScalingNotificationIds and Filters at the same time.
Filters.N No Array of Filter Filter.
  • auto-scaling-notification-id - String - Required: No - (Filter) Filter by notification ID.
  • auto-scaling-group-id - String - Required: No - (Filter) Filter by auto scaling group ID.

  • The maximum number of Filters per request is 10. The upper limit for Filter.Values is 5. This parameter does not support specifying both AutoScalingNotificationIds and Filters at the same time.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in the API overview.
    Offset No Integer Offset. Default value: 0. For more information on Offset, see the relevant section in the API overview.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible notifications.
    AutoScalingNotificationSet Array of AutoScalingNotification List of AS event notification details.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying notifications

    Input Example

    https://as.tencentcloudapi.com/?Action=DescribeNotificationConfigurations
    &AutoScalingNotificationIds.0=asn-9bhwvxqh
    <Common request parameters>
    

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "AutoScalingNotificationSet": [
          {
            "AutoScalingGroupId": "asg-2umy3jbd",
            "NotificationUserGroupIds": [
              "1678"
            ],
            "NotificationTypes": [
              "SCALE_OUT_SUCCESSFUL"
            ],
            "AutoScalingNotificationId": "asn-9bhwvxqh"
          }
        ],
        "RequestId": "0539a5fc-14b8-4591-9fe2-faee32031a64"
      }
    }
    

    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
    InvalidParameterConflict The two parameters specified conflict and cannot co-exist.
    InvalidParameterValue.InvalidAutoScalingGroupId Invalid scaling group ID.
    InvalidParameterValue.InvalidAutoScalingNotificationId Invalid notification ID.
    InvalidParameterValue.InvalidFilter Invalid filter condition.