Use DescribeEventRuleTargetList to query event-triggered alert rule targets - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Queries the list of event-triggered alert rules.

Operation description

This topic provides an example to query the details of the event-triggered alert rule testRule.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RuleName	string	Yes	The name of the event-triggered alert rule.	testRule

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

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note A value of 200 indicates success.	200
Message	string	The error message.	The Request is not authorization.
RequestId	string	The request ID.	87170bc7-e28a-4c93-b9bf-90a1dbe84736
ContactParameters	object
ContactParameter	array<object>	The notification method of the alert contact group.
	object
ContactGroupName	string	The name of the alert group.	Default alert notification group
Level	string	The alert notification methods. Valid values: 4: Alert notifications are sent by using DingTalk chatbots and emails.	3
Id	string	The ID of the recipient.	1
FcParameters	object
FCParameter	array<object>	The Function Compute notification method.
	object
ServiceName	string	The name of the Function Compute service.	service1
FunctionName	string	The name of the function.	fcTest1
Arn	string	The Alibaba Cloud Resource Name (ARN) of the function. Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: Service: the code of an Alibaba Cloud service Region: the region ID Account: the ID of an Alibaba Cloud account ResourceType: the resource type ResourceId: the resource ID	acs:log:cn-hangzhou::project/cms-log-mon*/logstore/cxxxx*
Id	string	The ID of the recipient.	3
Region	string	The region where Function Compute is deployed.	cn-qingdao
MnsParameters	object
MnsParameter	array<object>	The Simple Message Queue (formerly MNS) notification method.
	object
Queue	string	The name of the SMQ queue.	testQueue
Arn	string	The ARN of the MNS queue. Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: Service: the code of an Alibaba Cloud service Region: the region ID Account: the ID of an Alibaba Cloud account ResourceType: the resource type ResourceId: the resource ID	acs:log:cn-hangzhou::project/cms-log-mon*/logstore/cxxxx*
Region	string	The region for SMQ.	cn-hangzhou
Id	string	The ID of the recipient.	2
Topic	string	The SMQ topic.	topic_sample
WebhookParameters	object
WebhookParameter	array<object>	The URL callback notification method.
	object
Url	string	The callback URL.	http://www.aliyun.com
Method	string	The HTTP request method. Valid values: GET and POST.	GET
Protocol	string	The protocol type.	HTTP
Id	string	The ID of the recipient.	5
SlsParameters	object
SlsParameter	array<object>	The Simple Log Service (SLS) notification method.
	object
Project	string	The name of the project.	project_test
LogStore	string	The name of the Logstore.	logstore_test
Arn	string	The ARN of the Log Service Logstore. Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: Service: the code of an Alibaba Cloud service Region: the region ID Account: the ID of an Alibaba Cloud account ResourceType: the resource type ResourceId: the resource ID	acs:log:cn-hangzhou::project/cms-log-mo**/logstore/c*
Region	string	The ID of the region where the Log Service project resides.	cn-hangzhou
Id	string	The ID of the recipient.	4
OpenApiParameters	object
OpenApiParameters	array<object>	The parameters of the callback API.
	object
Action	string	The name of the API operation.	PutLogs
Arn	string	The ARN of the API operation. Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: Service: the code of an Alibaba Cloud service Region: the region ID Account: the ID of an Alibaba Cloud account ResourceType: the resource type ResourceId: the resource ID The ARN of the Log Service Logstore. Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: Service: the code of an Alibaba Cloud service Region: the region ID Account: the ID of an Alibaba Cloud account ResourceType: the resource type ResourceId: the resource ID	acs:log:cn-hangzhou::project/cms-log-mon*/logstore/cxxxx*
Id	string	The ID of the recipient.	3
Product	string	The ID of the cloud service to which the API operation belongs.	log
Region	string	The region where the resource resides.	cn-hangzhou
Role	string	The name of the role.	MyRole
Version	string	The version of the API.	2019-01-01

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "87170bc7-e28a-4c93-b9bf-90a1dbe84736",
  "ContactParameters": {
    "ContactParameter": [
      {
        "ContactGroupName": "Default alert notification group",
        "Level": "3",
        "Id": "1"
      }
    ]
  },
  "FcParameters": {
    "FCParameter": [
      {
        "ServiceName": "service1",
        "FunctionName": "fcTest1",
        "Arn": "acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***",
        "Id": "3",
        "Region": "cn-qingdao"
      }
    ]
  },
  "MnsParameters": {
    "MnsParameter": [
      {
        "Queue": "testQueue",
        "Arn": "acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***",
        "Region": "cn-hangzhou",
        "Id": "2",
        "Topic": "topic_sample"
      }
    ]
  },
  "WebhookParameters": {
    "WebhookParameter": [
      {
        "Url": "http://www.aliyun.com",
        "Method": "GET",
        "Protocol": "HTTP",
        "Id": "5"
      }
    ]
  },
  "SlsParameters": {
    "SlsParameter": [
      {
        "Project": "project_test",
        "LogStore": "logstore_test",
        "Arn": "acs:log:cn-hangzhou::project/cms-log-mo****/logstore/c***",
        "Region": "cn-hangzhou",
        "Id": "4"
      }
    ]
  },
  "OpenApiParameters": {
    "OpenApiParameters": [
      {
        "Action": "PutLogs",
        "Arn": "acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***",
        "Id": "3",
        "Product": "log",
        "Region": "cn-hangzhou",
        "Role": "MyRole",
        "Version": "2019-01-01"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameterValue	Illegal parameters.	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
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.