DescribeDingTalk - Security Center - Alibaba Cloud Documentation Center

Obtains DingTalk notifications.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeDingTalk	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RuleActionName	string	No	The name of the notification.	Vulnerability notification
PageSize	integer	No	The number of entries to return on each page.Default value: 20.	20
CurrentPage	integer	No	The number of the page to return.Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	B256A525-7E42-4BB9-A27C-9017FDDFF1A2
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of messages.	1
ActionList	object []	An array that consists of details of notifications.
Status	integer	The status of the notification. Valid values: 0: disabled 1: enabled	1
ConfigList	string	The list of notification settings.	[{\"type\":\"vul\",\"configItemList\":[{\"key\":\"key\", \"valueList\":\"123\"}]}]
GmtCreate	long	The creation time. unit:millisecond.	1550828400000
ActionName	string	The name of the notification.	Alert notification
Url	string	The parameters of the notification.	https://oapi.dingtalk.com/robot/send
AliUid	long	The UID of the user.	12312412341
DingTalkLang	string	The language of the content within notifications. Valid values: zh: Chinese en: English	zh
IntervalTime	integer	The interval at which the notifications are sent.unit:minute.	1000
GmtModified	long	The modification time.	1550828400000
GroupIdList	string	The group IDs.	"123,456"
Id	integer	The ID of the notification.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "B256A525-7E42-4BB9-A27C-9017FDDFF1A2",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 1
  },
  "ActionList": [
    {
      "Status": 1,
      "ConfigList": "[{\\\"type\\\":\\\"vul\\\",\\\"configItemList\\\":[{\\\"key\\\":\\\"key\\\", \\\"valueList\\\":\\\"123\\\"}]}]",
      "GmtCreate": 1550828400000,
      "ActionName": "Alert notification\n",
      "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	Description
400	NoPermission	no permission	-
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.