优惠中心

新用户5折优惠券

邮件推送 - 5.4折优惠

了解更多

GetAlertMessage - 查询报警信息

更新时间:2024-11-21 08:34

调用GetAlertMessage接口,通过获取的AlertId查询报警信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

报警 ID,可调用 ListAlertMessages 获取。

1421

返回参数

名称类型描述示例值
名称类型描述示例值
object

Schema of Response

RequestIdstring

请求的 ID。用于定位日志,排查问题。

0000-ABCD-EFG****
HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

The specified parameters are invalid.
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
true
Dataobject

返回数据详情。

RemindIdlong

当 Source(报警来源)为 REMIND_ALERT(自定义报警)时,返回触发的自定义监控规则 ID。

1234
AlertMessageStatusstring

报警信息的发送状态。取值如下:

  • READY_TO_SEND(准备发送)
  • SEND_FAIL(发送失败)
  • SEND_SUCCESS(发送成功)
  • SEND_OVERLIMIT(报警超限)
READY_TO_SEND
AlertUserstring

报警信息接收人的阿里云 UID。

9527952795****
AlertTimelong

报警时间。

1553524393000
AlertMethodstring

报警方式。取值如下:

  • MAIL(邮件)
  • SMS(短信)
  • PHONE(电话,仅 DataWorks 专业版及以上版本支持)
SMS
Sourcestring

报警来源。取值如下:

  • REMIND_ALERT(自定义报警)
  • TOPIC_ALERT(事件报警)
  • SLA_ALERT(基线预警)
  • NODE_CYCLE_ALERT(节点成环报警)
  • NODE_LONELY_ALERT(节点孤立报警)
REMIND_ALERT
Contentstring

报警内容。

节点出错
RemindNamestring

当 Source(报警来源)为 REMIND_ALERT(自定义提醒)时,返回触发的自定义监控规则名称。

自定义监控规则名称
AlertIdlong

报警 ID。

123
Instancesarray<object>

当 Source(报警来源)为 REMIND_ALERT(自定义提醒)时,返回触发自定义监控规则的实例列表。其它类型的报警来源返回为空。

Instanceobject

实例信息。

Statusstring

实例状态。取值如下:

  • NOT_RUN(未运行)
  • WAIT_TIME(等待时间)
  • WAIT_RESOURCE(等待资源)
  • RUNNING(运行中)
  • CHECKING(校检中)
  • CHECKING_CONDITION(条件检测中)
  • FAILURE(运行失败)
  • SUCCESS(运行成功)
NOT_RUN
InstanceIdlong

实例的 ID。

12312312
NodeNamestring

节点的名称。

节点名
NodeIdlong

节点的 ID。

1234
ProjectIdlong

节点所在工作空间的 ID。

1234
Topicsarray<object>

当 Source(报警来源)为 TOPIC_ALERT(全局事件告警)时,返回触发报警的事件列表。当报警来源为其它类型时,返回结果为空。

Topicobject

事件信息。

TopicNamestring

事件的名称。

9527出错
InstanceIdlong

事件关联的实例 ID。

12345
TopicIdlong

事件的 ID。

412431
TopicOwnerstring

事件责任人的阿里云 UID。

9527952795****
NodeIdlong

事件关联的任务节点 ID。

1234
TopicStatusstring

事件的状态。取值如下:

  • IGNORE(已忽略)
  • NEW(新发现)
  • FIXING(处理中)
  • RECOVER(已恢复)
FIXING
Nodesarray<object>

不同的报警来源返回不同的节点列表: 当 Source(报警来源)为 NODE_ CYCLE_ALERT(节点成环报警)时,返回成环的节点类型。 当 Source(报警来源)为 NODELONELYALERT(节点孤立报警)时,返回孤立的节点类型。

Nodeobject

节点信息。

Ownerstring

节点责任人的阿里云 UID。

95279527952****
NodeNamestring

节点的名称。

节点名
NodeIdlong

节点的 ID。

1234
ProjectIdlong

节点所在工作空间的 ID。

1234
SlaAlertobject

当 Source(报警来源)为 SLA_ALERT(基线报警)时,返回触发基线预警的基本实例信息。当报警来源为其它类型时,返回为空。

Statusstring

基线状态。取值如下:

  • ERROR(异常)
  • SAFE(安全)
  • DANGEROUS(预警)
  • OVER(破线)
SAFE
BaselineOwnerstring

基线责任人的阿里云 UID,多个 UID 之间使用英文逗号(,)分隔。

952795279****
BaselineIdlong

基线的 ID。

15142123
BaselineNamestring

基线的名称。

基线名
Bizdatelong

基线实例的业务日期时间戳。

1553443200000
ProjectIdlong

基线所在工作空间的 ID。

1234
InGroupIdinteger

基线实例的周期号:天基线为 1,小时基线范围为[1,24]。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "0000-ABCD-EFG****",
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "RemindId": 1234,
    "AlertMessageStatus": "READY_TO_SEND",
    "AlertUser": "9527952795****",
    "AlertTime": 1553524393000,
    "AlertMethod": "SMS",
    "Source": "REMIND_ALERT",
    "Content": "节点出错",
    "RemindName": "自定义监控规则名称",
    "AlertId": 123,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "InstanceId": 12312312,
        "NodeName": "节点名",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "Topics": [
      {
        "TopicName": "9527出错",
        "InstanceId": 12345,
        "TopicId": 412431,
        "TopicOwner": "9527952795****",
        "NodeId": 1234,
        "TopicStatus": "FIXING"
      }
    ],
    "Nodes": [
      {
        "Owner": "95279527952****",
        "NodeName": "节点名",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "SlaAlert": {
      "Status": "SAFE",
      "BaselineOwner": "952795279****",
      "BaselineId": 15142123,
      "BaselineName": "基线名",
      "Bizdate": 1553443200000,
      "ProjectId": 1234,
      "InGroupId": 1
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
文档反馈
phone 联系我们

立即和Alibaba Cloud在线服务人员进行交谈,获取您想了解的产品信息以及最新折扣。

alicare alicarealicarealicare