All Products
Search
Document Center

CloudMonitor:DescribeMetricRuleTargets

Last Updated:Jul 26, 2024

Queries the resources that are associated with a specified alert rule.

Operation description

Limit

This operation supports only Message Service (MNS) resources.

Note This topic provides an example on how to query the resources that are associated with an alert rule whose ID is ae06917_75a8c43178ab66****.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
cms:DescribeMetricRuleTargetslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RuleIdstringYes

The ID of the alert rule.

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

ae06917_75a8c43178ab66****

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

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code.

Note The status code 200 indicates that the call was successful.
200
Messagestring

The error message.

User not authorized to operate on the specified resource.
RequestIdstring

The ID of the request.

786E92D2-AC66-4250-B76F-F1E2FCDDBA1C
Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
true
Targetsarray<object>

The information about the resource for which alerts are triggered.

object
Idstring

The ID of the resource for which alerts are triggered.

1
Arnstring

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
Levelstring

The level of the alert. Valid values:

  • INFO: information
  • WARN: warning
  • CRITICAL: critical
["INFO", "WARN", "CRITICAL"]
JsonParamsstring

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

{"customField1":"value1","customField2":"$.name"}

Examples

Sample success responses

JSONformat

{
  "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\", \"WARN\", \"CRITICAL\"]",
        "JsonParams": "{\"customField1\":\"value1\",\"customField2\":\"$.name\"}"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400InvalidParameterValue%s
400%s%s
403AccessForbiddenUser not authorized to operate on the specified resource.
500InternalError%s
500InternalErrorThe request processing has failed due to some unknown error.

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

Change history

Change timeSummary of changesOperation
2023-07-25The Error code has changedView Change Details
2022-03-21API Description Update. The Error code has changed. The response structure of the API has changedView Change Details