ListAlertActions API Overview for CloudMonitor Alert Integrations - CloudMonitor

Queries alert action integrations.

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

list

*AlertAction

acs:cms:{#regionId}:{#accountId}:alertaction/*

None

Request syntax

GET /alertActions HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
alertActionIds	array	No	The unique IDs of the alert action integrations.
	string	No	The unique ID of the alert action integration.	testId
type	string	No	The type of the alert action integration.	FC
alertActionName	string	No	The name of the alert action integration.	testName
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 100.	100

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	8FDE2569-626B-5176-9844-28877A*****
total	integer	The total number of entries.	9
pageNumber	integer	The page number.	1
pageSize	integer	The number of entries per page.	100
alertActions	array<object>	The list of alert action integration configurations.
	array<object>	The list of alert action integration configurations.
fcParam	object	The parameters of Function Compute.
regionId	string	The region ID.	cn-beijing
service	string	The service name of Function Compute.	test
function	string	The function name of the Function Compute service.	test
ebParam	object	Specifies the event bus.
regionId	string	The region ID.	cn-heyuan
subject	string	The subject.	test
ebSource	string	The event provider.	test
eventBusName	string	The name of the event bus.	test
alertActionId	string	The unique ID of the alert action integration.	test
slsParam	object	The parameters of Simple Log Service.
regionId	string	The region ID.	cn-hangzhou
project	string	The name of the Simple Log Service project.	test
logstore	string	The name of the Simple Log Service Logstore.	test
fc3Param	object	The parameters of Function Compute 3.0.
regionId	string	The region ID.	cn-qingdao
function	string	The function name of the Function Compute service.	test
qualifier	string	The version or alias of the function.	test
mnsParam	object	The parameters of Simple Message Queue (formerly MNS).
mnsType	string	The resource type of Simple Message Queue (formerly MNS).	queue
regionId	string	The region ID.	cn-hangzhou
name	string	The name of the resource. If the resource type is `queue`, this parameter specifies the queue name. If the resource type is `topic`, this parameter specifies the topic name.	test
pagerDutyParam	object	The PagerDuty parameters.
key	string	The integration key of PagerDuty.	fsfer4543t5t65g4t4
url	string	The integration webhook of PagerDuty. Versions 1 and 2 are supported.	https://events.pagerduty.com/v2/enqueue
type	string	The type of the alert action integration.	FC
webhookParam	object	The webhook parameters.
headers	object	The request headers.
	string	The request headers.	{'X-Total-Count': 0}
method	string	The request method of the webhook.	GET
contentType	string	The data format. This parameter is valid only when the request method is POST.	JSON
url	string	The callback URL for alerts.	http://www.test.com
essParam	object	The parameters of Auto Scaling.
essGroupId	string	The ID of the Auto Scaling group.	testId
regionId	string	The region ID.	cn-beijing
essRuleId	string	The ID of the scaling rule.	testId
alertActionName	string	The name of the alert action integration.	testName

Examples

Success response

JSON format

{
  "requestId": "8FDE2569-626B-5176-9844-28877A*****",
  "total": 9,
  "pageNumber": 1,
  "pageSize": 100,
  "alertActions": [
    {
      "fcParam": {
        "regionId": "cn-beijing",
        "service": "test",
        "function": "test"
      },
      "ebParam": {
        "regionId": "cn-heyuan",
        "subject": "test",
        "ebSource": "test",
        "eventBusName": "test"
      },
      "alertActionId": "test",
      "slsParam": {
        "regionId": "cn-hangzhou",
        "project": "test",
        "logstore": "test"
      },
      "fc3Param": {
        "regionId": "cn-qingdao",
        "function": "test",
        "qualifier": "test"
      },
      "mnsParam": {
        "mnsType": "queue",
        "regionId": "cn-hangzhou",
        "name": "test"
      },
      "pagerDutyParam": {
        "key": "fsfer4543t5t65g4t4",
        "url": "https://events.pagerduty.com/v2/enqueue"
      },
      "type": "FC",
      "webhookParam": {
        "headers": {
          "key": "{'X-Total-Count': 0}"
        },
        "method": "GET",
        "contentType": "JSON",
        "url": "http://www.test.com"
      },
      "essParam": {
        "essGroupId": "testId",
        "regionId": "cn-beijing",
        "essRuleId": "testId"
      },
      "alertActionName": "testName"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.