调用ListAlertMessages获取报警信息的列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListAlertMessages |
要执行的操作。 |
BeginTime | String | 是 | 2020-04-02T00:00:00+0800 |
起始报警时间,需要使用yyyy-MM-dd'T'HH:mm:ssZ的UTC格式。 |
EndTime | String | 是 | 2020-04-04T00:00:00+0800 |
截止报警时间,需要使用yyyy-MM-dd'T'HH:mm:ssZ的UTC格式。 |
PageNumber | Integer | 是 | 1 |
分页的页数。默认值为1、最小值为1、最大值为30。 |
PageSize | Integer | 是 | 10 |
每页显示的条数,默认为10,最大100条。 |
RegionId | String | 是 | cn-shanghai |
可用区的唯一标识。 |
RemindId | Long | 是 | 9527 |
自定义规则的ID,当AlertRuleTypes(报警规则类型)包括USER_DEFINE自定义规则时生效。 |
AlertMethods | String | 否 | SMS,MAIL,PHONE |
报警方式,包括MAIL(邮件)、SMS(短信)和PHONE(电话,仅DataWorks专业版及以上版本支持)。多个报警方式之间使用英文逗号(,)分隔。 |
AlertUser | String | 否 | 123456 |
报警接收人的阿里云UID。 |
AlertRuleTypes | String | 否 | GLOBAL,USER_DEFINE,OHTER |
规则类型,包括GLOBAL(全局规则)、USER_DEFINE(自定义规则)和OTHER(其它)。多个规则类型之间使用英文逗号(,)分隔。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct |
返回的报警信息列表。 |
|
AlertMessages | Array of AlertMessages |
报警信息列表。 |
|
AlertId | Long | 1234 |
报警ID。 |
AlertMessageStatus | String | READY_TO_SEND |
发送状态,包括READY_TO_SEND(准备发送)、SEND_FAIL(发送失败)、SEND_SUCCESS(发送成功)和SEND_OVERLIMIT(报警超限)。 |
AlertMethod | String | SMS |
报警方式,包括MAIL(邮件)、SMS(短信)和 PHONE(电话,仅DataWorks专业版及以上版本支持)。 |
AlertTime | Long | 1553531401000 |
报警的时间戳。 |
AlertUser | String | 9527952795**** |
接收人的阿里云UID。 |
Content | String | 节点出错 |
报警的内容。 |
Instances | Array of Instances |
当Source(报警来源)为REMIND_ALERT(自定义提醒)时,返回触发自定义监控规则的实例列表。其它类型的报警来源返回为空。 |
|
InstanceId | Long | 12345 |
实例的ID。 |
NodeId | Long | 1234 |
节点的ID。 |
NodeName | String | 节点名称 |
节点的名称。 |
ProjectId | Long | 1234 |
节点所在工作空间的ID。 |
Status | String | NOT_RUN |
实例状态,包括NOT_RUN (未运行)、WAIT_TIME(等待时间)、WAIT_RESOURCE(等待资源)、RUNNING(运行中)、CHECKING(校检中)、CHECKING_CONDITION(条件检测中)、FAILURE(运行失败)和SUCCESS(运行成功)。 |
Nodes | Array of Nodes |
不同的报警来源返回不同的节点列表:
|
|
NodeId | Long | 1234 |
节点的ID。 |
NodeName | String | 节点名称 |
节点的名称。 |
Owner | String | 95279527952**** |
节点责任人的阿里云UID。 |
ProjectId | Long | 1234 |
节点所在工作空间的ID。 |
RemindId | Long | 1234 |
当Source(报警来源)为REMIND_ALERT(自定义报警)时,返回触发的自定义监控规则ID。 |
RemindName | String | 自定义监控规则名称 |
当Source(报警来源)为REMIND_ALERT(自定义提醒)时,返回触发的自定义监控规则名称。 |
SlaAlert | Struct |
当Source(报警来源)为SLA_ALERT(基线报警)时,返回触发基线预警的基本实例信息。当报警来源为其它类型时,返回为空。 |
|
BaselineId | Long | 1234 |
基线的ID。 |
BaselineName | String | 基线名称 |
基线的名称。 |
BaselineOwner | String | 952795279**** |
基线责任人的阿里云UID,多个UID之间使用英文逗号(,)分隔。 |
Bizdate | Long | 1553443200000 |
基线实例的业务日期时间戳。 |
InGroupId | Integer | 1 |
基线实例的周期号:天基线为1,小时基线范围为[1,24]。 |
ProjectId | Long | 1234 |
基线所在工作空间的ID。 |
Status | String | SAFE |
基线状态,包括ERROR(异常)、SAFE(安全)、DANGROUS(预警)和OVER(破线)。 |
Source | String | REMIND_ALERT |
报警来源,包括REMIND_ALERT(自定义报警)、TOPIC_ALERT(事件告警)、SLA_ALERT(基线预警)、NODE_CYCLE_ALERT(节点成环报警)和NODE_LONELY_ALERT(节点孤立报警)。 |
Topics | Array of Topics |
当Source(报警来源)为TOPIC_ALERT(全局事件告警)时,返回触发报警的事件列表。当报警来源为其它类型时,返回结果为空。 |
|
InstanceId | Long | 12345 |
事件关联的实例ID。 |
NodeId | Long | 1234 |
事件关联的节点ID。 |
TopicId | Long | 1234 |
事件的ID。 |
TopicName | String | 9527出错 |
事件的名称。 |
TopicOwner | String | 9527952795**** |
事件责任人的阿里云UID。 |
TopicStatus | String | FIXING |
事件状态,包括IGNORE(已忽略),NEW(新发现)、 FIXING(处理中)和RECOVER(已恢复)。 |
PageNumber | String | 1 |
当前的页数。 |
PageSize | String | 10 |
每页的大小。 |
TotalCount | String | 100 |
报警信息的总数。 |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
错误码。 |
ErrorMessage | String | The specified parameters are invalid. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP返回码。 |
RequestId | String | 0000-ABCD-EFG**** |
本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
Success | Boolean | true |
调用是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListAlertMessages
&BeginTime=2020-04-02T00:00:00+0800
&EndTime=2020-04-04T00:00:00+0800
&PageNumber=1
&PageSize=10
&RegionId=cn-shanghai
&RemindId=9527
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
<TotalCount>100</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<AlertMessages>
<AlertUser>12345</AlertUser>
<AlertMessageStatus>READY_TO_SEND</AlertMessageStatus>
<RemindId>9527</RemindId>
<AlertId>9527</AlertId>
<Content>节点出错</Content>
<AlertMethod>SMS</AlertMethod>
<AlertTime>1553531401000</AlertTime>
<Source>REMIND_ALERT</Source>
<RemindName>自定义监控规则名称</RemindName>
</AlertMessages>
<AlertMessages>
<Instances>
<Status>NOT_RUN</Status>
<NodeName>节点名称</NodeName>
<InstanceId>95279527</InstanceId>
<NodeId>1234</NodeId>
<ProjectId>1234</ProjectId>
</Instances>
<Instances>
<TopicOwner>9527952795****</TopicOwner>
<InstanceId>12345</InstanceId>
<NodeId>1234</NodeId>
<TopicId>1234</TopicId>
<TopicStatus>FIXING</TopicStatus>
<TopicName>9527出错</TopicName>
</Instances>
<Instances>
<Owner>12345</Owner>
<NodeName>节点名称</NodeName>
<NodeId>1234</NodeId>
<ProjectId>1234</ProjectId>
</Instances>
<Topics>
<Status>NOT_RUN</Status>
<NodeName>节点名称</NodeName>
<InstanceId>12345</InstanceId>
<NodeId>1234</NodeId>
<ProjectId>1234</ProjectId>
</Topics>
<Topics>
<TopicOwner>95279527****</TopicOwner>
<InstanceId>95279527</InstanceId>
<NodeId>9527</NodeId>
<TopicId>9527</TopicId>
<TopicStatus>FIXING</TopicStatus>
<TopicName>9527出错</TopicName>
</Topics>
<Topics>
<Owner>95279527****</Owner>
<NodeName>节点名称</NodeName>
<NodeId>9527</NodeId>
<ProjectId>9527</ProjectId>
</Topics>
<Nodes>
<Status>NOT_RUN</Status>
<NodeName>节点名称</NodeName>
<InstanceId>95279527</InstanceId>
<NodeId>9527</NodeId>
<ProjectId>9527</ProjectId>
</Nodes>
<Nodes>
<TopicOwner>95279527****</TopicOwner>
<InstanceId>95279527</InstanceId>
<NodeId>9527</NodeId>
<TopicId>9527</TopicId>
<TopicStatus>FIXING</TopicStatus>
<TopicName>9527出错</TopicName>
</Nodes>
<Nodes>
<Owner>95279527****</Owner>
<NodeName>节点名称</NodeName>
<NodeId>9527</NodeId>
<ProjectId>9527</ProjectId>
</Nodes>
</AlertMessages>
<AlertMessages>
<SlaAlert>
<BaselineId>9527</BaselineId>
<Status>SAFE</Status>
<BaselineOwner>95279527****</BaselineOwner>
<BaselineName>基线名称</BaselineName>
<ProjectId>9527</ProjectId>
<Bizdate>1553443200000</Bizdate>
<InGroupId>1</InGroupId>
</SlaAlert>
</AlertMessages>
</Data>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>
JSON
格式
{
"RequestId": "0000-ABCD-EFG****",
"HttpStatusCode": 200,
"Data": {
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1,
"AlertMessages": [
{
"AlertUser": 12345,
"AlertMessageStatus": "READY_TO_SEND",
"RemindId": 9527,
"AlertId": 9527,
"Content": "节点出错",
"AlertMethod": "SMS",
"AlertTime": 1553531401000,
"Source": "REMIND_ALERT",
"RemindName": "自定义监控规则名称"
},
{
"Instances": [
{
"Status": "NOT_RUN",
"NodeName": "节点名称",
"InstanceId": 95279527,
"NodeId": 1234,
"ProjectId": 1234
},
{
"TopicOwner": "9527952795****",
"InstanceId": 12345,
"NodeId": 1234,
"TopicId": 1234,
"TopicStatus": "FIXING",
"TopicName": "9527出错"
},
{
"Owner": 12345,
"NodeName": "节点名称",
"NodeId": 1234,
"ProjectId": 1234
}
],
"Topics": [
{
"Status": "NOT_RUN",
"NodeName": "节点名称",
"InstanceId": 12345,
"NodeId": 1234,
"ProjectId": 1234
},
{
"TopicOwner": "95279527****",
"InstanceId": 95279527,
"NodeId": 9527,
"TopicId": 9527,
"TopicStatus": "FIXING",
"TopicName": "9527出错"
},
{
"Owner": "95279527****",
"NodeName": "节点名称",
"NodeId": 9527,
"ProjectId": 9527
}
],
"Nodes": [
{
"Status": "NOT_RUN",
"NodeName": "节点名称",
"InstanceId": 95279527,
"NodeId": 9527,
"ProjectId": 9527
},
{
"TopicOwner": "95279527****",
"InstanceId": 95279527,
"NodeId": 9527,
"TopicId": 9527,
"TopicStatus": "FIXING",
"TopicName": "9527出错"
},
{
"Owner": "95279527****",
"NodeName": "节点名称",
"NodeId": 9527,
"ProjectId": 9527
}
]
},
{
"SlaAlert": {
"BaselineId": 9527,
"Status": "SAFE",
"BaselineOwner": "95279527****",
"BaselineName": "基线名称",
"ProjectId": 9527,
"Bizdate": 1553443200000,
"InGroupId": 1
}
}
]
},
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"ErrorMessage": "The specified parameters are invalid.",
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden.Access | Access is forbidden. Activate DataWorks first. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | 该地域还未开放DataWorks的API服务,请尝试其它地域。 |
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.Wkbench.ServiceError | An internal error occurred. | 服务开小差了。 |
500 | Invalid.Wkbench.Parameter | The specified parameters are invalid. | 参数错误。 |
403 | ResourceNotAuthorized.Api | You are not authorized to access the resources. | 您无法访问未取得授权的资源。 |
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. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
访问错误中心查看更多错误码。