DescribeNotificationConfigurations

下载PDF

最后更新时间：2025-10-30 21:28:19

DescribeNotificationConfigurations

最后更新时间： 2025-10-30 21:28:19

下载PDF

1. API Description

Domain name for API request: as.intl.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 Params. The value used for this API: DescribeNotificationConfigurations.
Version	Yes	String	Common Params. The value used for this API: 2018-04-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
AutoScalingNotificationIds.N	No	Array of String	Query by one or more notification ids. the list length limit is 100. you can obtain the notification ID by logging in to the console (https://console.tencentcloud.com/autoscaling/group). parameters AutoScalingNotificationIds and Filters must not be specified simultaneously.
Filters.N	No	Array of Filter	Filter criteria 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. you can obtain the scaling group id by logging in to the console (https://console.tencentcloud.com/autoscaling/group) or calling the api DescribeAutoScalingGroups (https://www.tencentcloud.com/document/api/377/20438?from_cn_redirect=1) and retrieving the AutoScalingGroupId from the returned information. . The maximum number of `Filters` per request is 10, and that of `Filter.Values` is 5. the `AutoScalingNotificationIds` and `Filters` parameters cannot be specified simultaneously.
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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying notifications

Input Example

POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNotificationConfigurations
<Common request parameters>

{
    "AutoScalingNotificationIds": [
        "asn-9bhwvxqh"
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "AutoScalingNotificationSet": [
            {
                "TargetType": "USER_GROUP",
                "TopicName": "topicname",
                "QueueName": "queuename",
                "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

Tencent Cloud CLI 3.0

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
InvalidParameter.ActionNotFound	Invalid Action request.
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.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud