Associates resources with a specified alert rule or modifies the resources that are associated with the alert rule.

Limit

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes PutMetricRuleTargets

The operation that you want to perform. Set the value to PutMetricRuleTargets.

RuleId String Yes ae06917_75a8c43178ab66****

The ID of the alert rule.

For information about how to obtain the ID of an alert rule, see DescribeMetricRuleList.

Targets.N.Id String Yes 1

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.

Targets.N.Arn String Yes acs:mns:cn-hangzhou:120886317861****:/queues/test/message

The 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 for which alerts are triggered. Valid values: - **queues** - **topics** {Resource name}: the name of the resource. - If the resource type is set to **queues**, the resource name is the name of the message queue. - If the resource type is set to **topics**, the resource name is the name of the topic.
Targets.N.Level String No ["INFO", "WARN", "CRITICAL"]

The level of the alert. Valid values:

  • INFO: information
  • WARN: warning
  • CRITICAL: critical
Targets.N.JsonParams String No {"customField1":"value1","customField2":"$.name"}

The parameters of the alert callback. The parameters are in the JSON format.

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

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Message String The request processing has failed due to some unknown error.

The error message.

RequestId String 6A569B0D-9055-58AF-9E82-BAEAF95C0FD5

The ID of the request.

Success Boolean true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
FailData Object

The list of resources that failed to be created or modified.

Targets Array of Target

The information about the resource for which alerts are triggered.

Target
Id String 1

The ID of the resource for which alerts are triggered.

Arn String acs:mns:cn-hangzhou:111:/queues/test/message

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 for which alerts are triggered. Valid values: - **queues** - **topics** {Resource name}: the name of the resource. - If the resource type is set to **queues**, the resource name is the name of the message queue. - If the resource type is set to **topics**, the resource name is the name of the topic.
Level String ["INFO", "WARN", "CRITICAL"]

The level of the alert. Valid values:

  • INFO: information
  • WARN: warning
  • CRITICAL: critical

Examples

Sample requests

http(s)://[Endpoint]/?Action=PutMetricRuleTargets
&RuleId=ae06917_75a8c43178ab66****
&Targets.1.Arn=acs:mns:cn-hangzhou:120886317861****:/queues/test/message
&Targets.1.Id=1
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<PutMetricRuleTargetsResponse>
	<RequestId>6A569B0D-9055-58AF-9E82-BAEAF95C0FD5</RequestId>
	<Code>200</Code>
	<Success>true</Success>
</PutMetricRuleTargetsResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6A569B0D-9055-58AF-9E82-BAEAF95C0FD5",
  "Code" : "200",
  "Success" : true
}

Error codes

For a list of error codes, visit the API Error Center.