All Products
Search
Document Center

CloudMonitor:PutMetricRuleTargets

Last Updated:Feb 28, 2024

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

Operation description

Limits

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.

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

None.

IdstringYes

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 .

1
ArnstringYes

The Alibaba Cloud Resource Name (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 that triggers the alert. 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:120886317861****:/queues/test/message
LevelstringNo

The alert level. Valid values:

  • INFO
  • WARN
  • CRITICAL
["INFO", "WARN", "CRITICAL"]
JsonParamsstringNo

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

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

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

Response parameters

ParameterTypeDescriptionExample
object

None.

Codestring

The HTTP status code.

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

The error message returned.

The request processing has failed due to some unknown error.
RequestIdstring

The request ID.

6A569B0D-9055-58AF-9E82-BAEAF95C0FD5
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
FailDataobject

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

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 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 that triggers the alert. 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
Levelstring

The alert level. Valid values:

  • INFO
  • WARN
  • CRITICAL
["INFO", "WARN", "CRITICAL"]

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
200%s%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
2022-03-21API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 200
    delete Error Codes: 201
    delete Error Codes: 400
    delete Error Codes: 401
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500