All Products
Search
Document Center

CloudMonitor:DescribeMetricRuleTargets

Last Updated:Mar 01, 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

There is currently no authorization information disclosed in the API.

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
Targetsobject []

The information about the resource for which alerts are triggered.

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 changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 500
2022-03-21API Description Update. The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 500
Output ParametersThe response structure of the API has changed.