文档

DescribeDingTalk - 获取钉钉通知列表

更新时间:

获取钉钉通知列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeDingTalkget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RuleActionNamestring

通知名称。

TestRuleAction
PageSizeinteger

分页查询时,每页最大显示的通知数量。默认值为 20,表示每页显示 20 条信息。

20
CurrentPageinteger

分页查询时,显示的当前页的页码。

1

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

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

分页信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,显示每页数据的最大条数。

20
TotalCountinteger

总条数。

149
ActionListarray<object>

通知列表。

ActionListArrobject

通知信息。

Statusinteger

通知状态。取值:

  • 0:关闭通知
  • 1:启用通知
0
ConfigListstring

消息的通知范围配置。该值为 JSON 串,包含以下字段:

  • type:通知类型
  • configItemList:通知范围
[{"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"]}]}]
GmtCreatelong

创建时间戳。单位:毫秒。

1550828400000
ActionNamestring

通知名称。

TestRuleAction
Urlstring

通知参数。

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

用户的 UID。

12312412341
DingTalkLangstring

通知的语言。取值:

  • zh:中文
  • en:英文
zh
IntervalTimeinteger

时间间隔。单位:分钟。

1000
GmtModifiedlong

修改时间。

1550828400000
GroupIdListstring

分组 ID 列表。

"123,456"
Idinteger

通知消息 ID。

1

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionno permission无此服务的访问权限。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。