ListAlertMessages_大数据开发治理平台 DataWorks_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
PageNumberinteger<int32>

分页的页数。默认值为 1、最小值为 1、最大值为 30。

示例值:1
PageSizeinteger<int32>

每页显示的条数,默认为 10,最大 100 条。

示例值:10
BeginTimestring

起始报警时间,需要使用 yyyy-MM-dd'T'HH:mm:ssZ 的 UTC 格式。

示例值:2020-04-02T00:00:00+0800
EndTimestring

截止报警时间,需要使用 yyyy-MM-dd'T'HH:mm:ssZ 的 UTC 格式。

示例值:2020-04-04T00:00:00+0800
RemindIdinteger<int64>

自定义规则的 ID,当 AlertRuleTypes 参数配置为 USER_DEFINE 自定义规则时生效。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:9527参考取值来源:
    ListReminds
AlertMethodsstring

报警方式,取值如下:展开详情

示例值:SMS,MAIL,PHONE参考取值来源:
    GetAlertMessage
AlertUserstring

报警接收人的阿里云 UID。

示例值:12345参考取值来源:
    GetAlertMessage
AlertRuleTypesstring

规则类型,包括 GLOBAL(全局规则)、USER_DEFINE(自定义规则)和 OTHER(其它)。多个规则类型之间使用英文逗号(,)分隔。

示例值:GLOBAL,USER_DEFINE,OTHER
BaselineIdinteger<int64>

基线 ID。当 AlertRuleTypes 参数配置为 GLOBAL 时生效。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1234参考取值来源:
    ListBaselines

返回参数

字段名称字段详情
HttpStatusCodeinteger<int32>

HTTP 返回码。

示例值:200
RequestIdstring

本次调用的唯一 ID。出现错误后,您可以根据该 ID 排查问题。

示例值:0000-ABCD-EFG****
ErrorMessagestring

错误信息。

示例值:The specified parameters are invalid.
ErrorCodestring

错误码。

示例值:Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。

示例值:true
Dataobject

返回的报警信息列表。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
403
Forbidden.Access
Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.诊断
429
Throttling.Api
The request for this resource has exceeded your available limit.诊断
429
Throttling.Api.Risk
The request for this resource has exceeded your daily available limit.诊断
429
Throttling.Resource
You have reached the limit for the resource. Please contact us by submitting a ticket.诊断
429
Throttling.System
The DataWorks system is busy. Try again later.诊断
429
Throttling.User
Your request is too frequent. Try again later.诊断
500
Forbidden.Not.Server
The dataworksAPI service is not available in this area. Please try it in another area.诊断
500
InternalError.System
An internal system error occurred. Try again later.诊断
500
InternalError.UserId.Missing
An internal system error occurred. Try again later.诊断

变更历史

暂无变更历史

相关示例