tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyNotificationConfiguration

Last updated: 2024-11-27 15:17:42

    1. API Description

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

    This API is used to modify a notification policy.

    • The receiver type of the notification policy cannot be modified.

    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: ModifyNotificationConfiguration.
    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.
    AutoScalingNotificationId Yes String ID of the notification to be modified.
    NotificationTypes.N No 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 No 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.
    QueueName No String CMQ or TDMQ CMQ queue name.
    TopicName No String CMQ or TDMQ CMQ toipc name.

    3. Output Parameters

    Parameter Name Type Description
    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 Modifying an event notification

    Input Example

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

{
    "NotificationUserGroupIds": [
        "1678"
    ],
    "NotificationTypes": [
        "SCALE_IN_FAILED",
        "SCALE_IN_SUCCESSFUL"
    ],
    "AutoScalingNotificationId": "asn-2sestqbr"
}

    Output Example

    {
    "Response": {
        "RequestId": "52e32a5b-5f69-4d48-a3f1-f2fea5c43a70"
    }
}

    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
    InvalidParameter.ActionNotFound Invalid Action request.
    InvalidParameterValue.ConflictNotificationTarget Conflicting notification receiver type.
    InvalidParameterValue.InvalidAutoScalingNotificationId Invalid notification ID.
    InvalidParameterValue.InvalidNotificationUserGroupId The notification group ID should be a numeric string.
    InvalidParameterValue.UserGroupIdNotFound The user group does not exist.
    ResourceNotFound.AutoScalingNotificationNotFound The notification does not exist.
    ResourceNotFound.CmqQueueNotFound The specified CMQ queue does not exist.
    ResourceNotFound.TDMQCMQQueueNotFound The TDMQ-CMQ queue doesn't exist.
    ResourceNotFound.TDMQCMQTopicNotFound The TDMQ-CMQ topic doesn't exist.
    ResourceUnavailable.TDMQCMQTopicHasNoSubscriber The TDMQ-CMQ topic is not subscribed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy