Associate resources with an alert rule using PutMetricRuleTargets - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Adds or modifies push channels for a specified alert rule by calling the PutMetricRuleTargets operation.

Operation description

Usage notes

This topic provides an example on how to associate the resource acs:mns:ap-southeast-1:120886317861****:/queues/test/message with the alert rule ae06917_75a8c43178ab66****. The alert trigger target ID is 1. The response shows that the resource is associated.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:PutMetricRuleTargets

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RuleId	string	Yes	The ID of the alert rule. For information about how to obtain the alert rule ID, see DescribeMetricRuleList.	ae06917_75a8c43178ab66****
Targets	array<object>	Yes	None.
	object	No	None.
Id	string	Yes	The ID of the alert trigger target. For information about how to obtain the alert trigger target ID, see DescribeMetricRuleTargets.	1
Arn	string	Yes	The Alibaba Cloud Resource Name (ARN) of the resource. Simple Message Queue (formerly MNS), elastic scaling (ESS), Simple Log Service (SLS), and Function Compute (FC) are supported. The following section describes the ARN parameter metric description for Simple Message Queue (formerly MNS): `acs:mns:{regionId}:{userId}:/{Resource type}/{Resource name}/message` {regionId}: the region where the MSMQ or topic of Simple Message Queue (formerly MNS) resides. {userId}: the Alibaba Cloud account that owns the resource. {Resource type}: the type of the resource that accepts alert notifications. Valid values: queues: queue. topics: topic. {Resource name}: the name of the resource. 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. ARN for elastic scaling: acs:ess:{regionId}:{userId}:scalingGroupId/{Scaling group ID}:scalingRuleId/{Scaling rule ID} ARN for Simple Log Service: acs:log:{regionId}:{userId}:project/{Project name}/logstore/{Logstore name} ARN for Function Compute: acs:fc:{regionId}:{userId}:services/{Service name}/functions/{Function name}.	acs:mns:cn-hangzhou:120886317861****:/queues/test/message
Level	string	No	The alert level. Valid values: INFO: information. WARN: warning. CRITICAL: critical.	["INFO", "WARN", "CRITICAL"]
JsonParams	string	No	The JSON-formatted parameters of the alert callback.	{"customField1":"value1","customField2":"$.name"}

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

Response elements

Element	Type	Description	Example
	object	None.
Code	string	The HTTP status code. Note The value 200 indicates success.	200
Message	string	The error message.	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 operation was successful. Valid values: true: successful. false: failed.	true
FailData	object	The list of failures.
Targets	object
Target	array<object>	The information about the resources for which alerts are triggered.
	object	None.
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`. SMQ, Auto Scaling, Simple Log Service, and Function Compute are supported. Example: `acs:mns:cn-hangzhou:120886317861**:/queues/test123/message`. The following part describes the ARN of SMQ and the parameters in the ARN: {Service name abbreviation}: mns. {userId}: the ID of the Alibaba Cloud account. {regionId}: the region ID of the SMQ queue or topic. {Resource type}: the type of the resource for which alerts are triggered. 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

Success response

JSON format

{
  "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
201	%s	%s
400	%s	%s
401	%s	%s
500	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	%s	%s
404	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.