Adds or modifies the push channels of an alert rule.

Operation description

Limits

This operation supports only Message Service (MNS) resources.

Usage notes

This topic provides an example on how to associate a resource with an alert rule whose ID is ae06917_75a8c43178ab66****. In this example, the Alibaba Cloud Resource Name (ARN) of the resource is acs:mns:cn-hangzhou:120886317861****:/queues/test/message for an alert rule and the ID of the resource for which alerts are triggered is 1. The response indicates that the resource is associated with the specified alert rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cms:PutMetricRuleTargets	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RuleId	string	Yes	The ID of the alert rule. For information about how to obtain the ID of an alert rule, see DescribeMetricRuleList .	ae06917_75a8c43178ab66****
Targets	array<object>	Yes	None.
	object	Yes	The alert trigger.
Id	string	Yes	The ID of the resource for which alerts are triggered. For information about how to obtain the ID of a resource for which alerts are triggered, see DescribeMetricRuleTargets .	1
Arn	string	Yes	The Alibaba Cloud Resource Name (ARN) of the resource. For information about how to obtain the ARN of a resource, see DescribeMetricRuleTargets . Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861**:/queues/test123/message`. Fields: {Service name abbreviation}: the abbreviation of the service name. Valid value: mns. {userId}: the ID of the Alibaba Cloud account. {regionId}: the region ID of the message queue or topic. {Resource type}: the type of the resource that triggers the alert. Valid values: queues topics {Resource name}: the resource name. If the resource type is queues, the resource name is the queue name. If the resource type is topics**, the resource name is the topic name.	acs:mns:cn-hangzhou:120886317861****:/queues/test/message
Level	string	No	The alert level. Valid values: INFO WARN CRITICAL	["INFO", "WARN", "CRITICAL"]
JsonParams	string	No	The parameters of the alert callback. Specify the parameters in the JSON format.	{"customField1":"value1","customField2":"$.name"}

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object	None.
Code	string	The HTTP status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message returned.	The request processing has failed due to some unknown error.
RequestId	string	The request ID.	6A569B0D-9055-58AF-9E82-BAEAF95C0FD5
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
FailData	object	The list of resources that failed to be created or modified.
Targets	array<object>	The information about the resource for which alerts are triggered.
	object
Id	string	The ID of the resource for which alerts are triggered.	1
Arn	string	The ARN of the resource. Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861**:/queues/test123/message`. Fields: {Service name abbreviation}: the abbreviation of the service name. Valid value: mns. {userId}: the ID of the Alibaba Cloud account. {regionId}: the region ID of the message queue or topic. {Resource type}: the type of the resource that triggers the alert. Valid values: queues topics {Resource name}: the resource name. If the resource type is queues, the resource name is the queue name. If the resource type is topics**, the resource name is the topic name.	acs:mns:cn-hangzhou:111:/queues/test/message
Level	string	The alert level. Valid values: INFO WARN CRITICAL	["INFO", "WARN", "CRITICAL"]

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The request processing has failed due to some unknown error.",
  "RequestId": "6A569B0D-9055-58AF-9E82-BAEAF95C0FD5",
  "Success": true,
  "FailData": {
    "Targets": {
      "Target": [
        {
          "Id": "1",
          "Arn": "acs:mns:cn-hangzhou:111:/queues/test/message",
          "Level": "[\"INFO\", \"WARN\", \"CRITICAL\"]"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message
200	%s	%s
500	InternalError	The request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-03-21	API Description Update. The Error code has changed	View Change Details