All Products
Search
Document Center

Security Center:DescribeDingTalk

Last Updated:Nov 13, 2024

Obtains DingTalk notifications.

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
yundun-sas:DescribeDingTalkget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RuleActionNamestringNo

The name of the notification.

Vulnerability notification
PageSizeintegerNo

The number of entries to return on each page.Default value: 20.

20
CurrentPageintegerNo

The number of the page to return.Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B256A525-7E42-4BB9-A27C-9017FDDFF1A2
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of messages.

1
ActionListarray<object>

An array that consists of details of notifications.

ActionListArrobject
Statusinteger

The status of the notification. Valid values:

  • 0: disabled
  • 1: enabled
1
ConfigListstring

The list of notification settings.

[{\"type\":\"vul\",\"configItemList\":[{\"key\":\"key\", \"valueList\":\"123\"}]}]
GmtCreatelong

The creation time. unit:millisecond.

1550828400000
ActionNamestring

The name of the notification.

Alert notification
Urlstring

The parameters of the notification.

https://oapi.dingtalk.com/robot/send
AliUidlong

The UID of the user.

12312412341
DingTalkLangstring

The language of the content within notifications. Valid values:

  • zh: Chinese
  • en: English
zh
IntervalTimeinteger

The interval at which the notifications are sent.unit:minute.

1000
GmtModifiedlong

The modification time.

1550828400000
GroupIdListstring

The group IDs.

"123,456"
Idinteger

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 codeError codeError messageDescription
400NoPermissionno permission-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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