GetAlertMessage_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	GetAlertMessage	系统规定参数。取值：GetAlertMessage。
AlertId	String	是	1421	报警ID，可调用ListAlertMessages获取。

返回数据

名称	类型	示例值	描述
RequestId	String	0000-ABCD-EFG****	请求的ID。用于定位日志，排查问题。
HttpStatusCode	Integer	200	HTTP状态码。
ErrorMessage	String	The specified parameters are invalid.	错误信息。
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	错误码。
Success	Boolean	true	调用是否成功。取值如下： true：调用成功。 false：调用失败。
Data	Object		返回数据详情。
RemindId	Long	1234	当Source（报警来源）为REMIND_ALERT（自定义报警）时，返回触发的自定义监控规则ID。
AlertMessageStatus	String	READY_TO_SEND	报警信息的发送状态。取值如下： READY_TO_SEND（准备发送） SEND_FAIL（发送失败） SEND_SUCCESS（发送成功） SEND_OVERLIMIT（报警超限）
AlertUser	String	9527952795****	报警信息接收人的阿里云UID。
AlertTime	Long	1553524393000	报警时间。
AlertMethod	String	SMS	报警方式。取值如下： MAIL（邮件） SMS（短信） PHONE（电话，仅DataWorks专业版及以上版本支持）
Source	String	REMIND_ALERT	报警来源。取值如下： REMIND_ALERT（自定义报警） TOPIC_ALERT（事件报警） SLA_ALERT（基线预警） NODE_CYCLE_ALERT（节点成环报警） NODE_LONELY_ALERT（节点孤立报警）
Content	String	节点出错	报警内容。
RemindName	String	自定义监控规则名称	当Source（报警来源）为REMIND_ALERT（自定义提醒）时，返回触发的自定义监控规则名称。
AlertId	Long	123	报警ID。
Instances	Array of Instance		当Source（报警来源）为REMIND_ALERT（自定义提醒）时，返回触发自定义监控规则的实例列表。其它类型的报警来源返回为空。
Status	String	NOT_RUN	实例状态。取值如下： NOT_RUN（未运行） WAIT_TIME（等待时间） WAIT_RESOURCE（等待资源） RUNNING（运行中） CHECKING（校检中） CHECKING_CONDITION（条件检测中） FAILURE（运行失败） SUCCESS（运行成功）
InstanceId	Long	12312312	实例的ID。
NodeName	String	节点名	节点的名称。
NodeId	Long	1234	节点的ID。
ProjectId	Long	1234	节点所在工作空间的ID。
Topics	Array of Topic		当Source（报警来源）为TOPIC_ALERT（全局事件告警）时，返回触发报警的事件列表。当报警来源为其它类型时，返回结果为空。
TopicName	String	9527出错	事件的名称。
InstanceId	Long	12345	事件关联的实例ID。
TopicId	Long	412431	事件的ID。
TopicOwner	String	9527952795****	事件责任人的阿里云UID。
NodeId	Long	1234	事件关联的任务节点ID。
TopicStatus	String	FIXING	事件的状态。取值如下： IGNORE（已忽略） NEW（新发现） FIXING（处理中） RECOVER（已恢复）
Nodes	Array of Node		不同的报警来源返回不同的节点列表：当Source（报警来源）为NODE_ CYCLE_ALERT（节点成环报警）时，返回成环的节点类型。当Source（报警来源）为NODELONELYALERT（节点孤立报警）时，返回孤立的节点类型。
Owner	String	95279527952****	节点责任人的阿里云UID。
NodeName	String	节点名	节点的名称。
NodeId	Long	1234	节点的ID。
ProjectId	Long	1234	节点所在工作空间的ID。
SlaAlert	Object		当Source（报警来源）为SLA_ALERT（基线报警）时，返回触发基线预警的基本实例信息。当报警来源为其它类型时，返回为空。
Status	String	SAFE	基线状态。取值如下： ERROR（异常） SAFE（安全） DANGEROUS（预警） OVER（破线）
BaselineOwner	String	952795279****	基线责任人的阿里云UID，多个UID之间使用英文逗号（,）分隔。
BaselineId	Long	15142123	基线的ID。
BaselineName	String	基线名	基线的名称。
Bizdate	Long	1553443200000	基线实例的业务日期时间戳。
ProjectId	Long	1234	基线所在工作空间的ID。
InGroupId	Integer	1	基线实例的周期号：天基线为1，小时基线范围为[1,24]。

示例

请求示例

http(s)://[Endpoint]/?Action=GetAlertMessage
&AlertId=1421
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
    }
  }
}

错误码

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