All Products
Search
Document Center

CloudMonitor:PutMetricRuleTargets

Last Updated:Oct 29, 2024

Adds or modifies the push channels of an alert rule.

Operation description

This topic provides an example on how to associate an alert rule with a resource. In this example, the alert rule is ae06917_75a8c43178ab66****, the resource is acs:mns:cn-hangzhou:120886317861****:/queues/test/message, 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:PutMetricRuleTargetscreate
  • 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****
Targetsarray<object>Yes

None.

objectYes

None.

IdstringYes

The ID of the resource for which alerts are triggered.

For more information about how to obtain the ID of the resource for which alerts are triggered, see DescribeMetricRuleTargets .

1
ArnstringYes

The Alibaba Cloud Resource Name (ARN) of the resource. Simple Message Queue (formerly MNS) (SMQ), Auto Scaling, Simple Log Service, and Function Compute are supported.

The following part describes the ARN of SMQ and the parameters in the ARN:

acs:mns:{regionId}:{userId}:/{Resource type}/{Resource name}/message.

  • {regionId}: the region ID of the SMQ queue or topic.

  • {userId}: the ID of the Alibaba Cloud account that owns the resource.

  • {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.

ARN of Auto Scaling:

acs:ess:{regionId}:{userId}:scalingGroupId/{Scaling group ID}:scalingRuleId/{Scaling rule ID}

ARN of Simple Log Service:

acs:log:{regionId}:{userId}:project/{Project name}/logstore/{Logstore name}

ARN of Function Compute:

acs:fc:{regionId}:{userId}:services/{Service name}/functions/{Function 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. The parameters are 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 failed data.

Targetsarray<object>

The information about the resources for which alerts are triggered.

Targetobject

None.

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. 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
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 changedView Change Details