Query Alert Rule Targets with DescribeMetricRuleTargets - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Queries the notification channels of a specified alert rule by calling the DescribeMetricRuleTargets operation.

Operation description

Usage notes

This topic provides an example to query the target resources associated with the alert rule ae06917_75a8c43178ab66****.

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:DescribeMetricRuleTargets

list

*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****

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

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note The value 200 indicates success.	200
Message	string	The error message.	User not authorized to operate on the specified resource.
RequestId	string	The request ID.	786E92D2-AC66-4250-B76F-F1E2FCDDBA1C
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
Targets	object
Target	array<object>	The alert trigger targets.
	object	The alert trigger targets.
Id	string	The ID of the resource for which alerts are triggered.	1
Arn	string	The Alibaba Cloud Resource Name (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.`	acs:mns:cn-hangzhou:120886317861****:/queues/test/message
Level	string	The level of the alert. Valid values: INFO: information WARN: warning CRITICAL: critical	INFO
JsonParams	string	The parameters of the alert callback. The parameters are in the JSON format.	{"customField1":"value1","customField2":"$.name"}

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "786E92D2-AC66-4250-B76F-F1E2FCDDBA1C",
  "Success": true,
  "Targets": {
    "Target": [
      {
        "Id": "1",
        "Arn": "acs:mns:cn-hangzhou:120886317861****:/queues/test/message",
        "Level": "INFO",
        "JsonParams": "{\"customField1\":\"value1\",\"customField2\":\"$.name\"}"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameterValue	%s
400	%s	%s
500	InternalError	%s
403	AccessForbidden	User not authorized to operate on the specified resource.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.