DingTalk Notification API Overview for Security Center - Security Center - Alibaba Cloud - Security Center

Retrieves the list of DingTalk notifications.

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

yundun-sas:DescribeDingTalk

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RuleActionName	string	No	The notification name.	TestRuleAction
PageSize	integer	No	The maximum number of notifications to display per page in a paged query. Default value: 20, which indicates that up to 20 entries are displayed per page.	20
CurrentPage	integer	No	The page number of the current page to display in a paged query.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	B256A525-7E42-4BB9-A27C-9017FDDFF1A2
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the current page in a paged query.	1
PageSize	integer	The maximum number of entries displayed per page in a paged query.	20
TotalCount	integer	The total number of entries.	149
ActionList	array<object>	The notification list.
	object	The notification information.
Status	integer	The notification status. Valid values: 0: disabled 1: enabled.	0
ConfigList	string	The notification scope configuration for messages. The value is a JSON string that contains the following fields: type: the notification type. configItemList: the notification scope.	[{"type":"sas_analysis_pre-sas-operation-log-sas-event-suspicious","configItemList":[{"key":"item_level","valueList":["all"]}]},{"type":"sas_analysis_pre-sas-operation-log-sas-event-hc","configItemList":[{"key":"item_level","valueList":["all"]}]}]
GmtCreate	integer	The creation timestamp. Unit: milliseconds.	1550828400000
ActionName	string	The notification name.	TestRuleAction
Url	string	The notification parameter.	https://oapi.dingtalk.com/robot/send
AliUid	integer	The UID of the user.	12312412341
DingTalkLang	string	The language of the notification. Valid values: zh: Chinese en: English.	zh
IntervalTime	integer	The time interval. Unit: minutes.	1000
GmtModified	integer	The modification time.	1550828400000
GroupIdList	string	The list of group IDs.	"123,456"
Id	integer	The notification message ID.	1

Examples

Success response

JSON format

{
  "RequestId": "B256A525-7E42-4BB9-A27C-9017FDDFF1A2",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 149
  },
  "ActionList": [
    {
      "Status": 0,
      "ConfigList": "[{\"type\":\"sas_analysis_pre-sas-operation-log-sas-event-suspicious\",\"configItemList\":[{\"key\":\"item_level\",\"valueList\":[\"all\"]}]},{\"type\":\"sas_analysis_pre-sas-operation-log-sas-event-hc\",\"configItemList\":[{\"key\":\"item_level\",\"valueList\":[\"all\"]}]}]",
      "GmtCreate": 1550828400000,
      "ActionName": "TestRuleAction",
      "Url": "https://oapi.dingtalk.com/robot/send",
      "AliUid": 12312412341,
      "DingTalkLang": "zh",
      "IntervalTime": 1000,
      "GmtModified": 1550828400000,
      "GroupIdList": "\"123,456\"",
      "Id": 1
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	no permission
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.