本文介绍DataWorks开放消息的消息结构、不同事件类型事件的消息格式及各字段含义,帮助您快速获取和感知事件消息的状态变更信息。

消息总体格式

一个完整的事件消息由以下几个部分组成,示例如下。
{ 
  "messageBody": OBJECT,
  "messageId": "d62427a0-eb1d-4ec6-926e-8665068f7cbc",
  "eventType":"commit-file",
  "eventCategoryType":"file-change",
  "blockBusiness":true
}
各字段详细说明请参见下表:
字段名称 字段类型 说明
messageBody 对象 消息实体格式,具体请参见下文各事件类型的消息实体格式详情:
messageId 文本 用来定位事件消息的唯一ID。
eventType 文本

事件类型,取值包括commit-file(提交文件)、deploy-file(发布文件)等,全量取值及其对应的事件请参见下文的附录:事件详情(eventType)

eventCategoryType 文本 事件类目类型,取值包括instance-status-change(实例状态变更事件)、file-change(文件变更事件)等,全量取值及去对应的事件类目请参见下文的附录:事件类目详情(eventCategoryType)
blockBusiness 布尔 是否阻塞业务流程。
  • true:表示该消息为扩展点消息,会阻塞业务流程,需要联合扩展程序功能,通过回调API返回并处理业务流程后续状态。
  • false:表示该消息为普通消息,不会阻塞业务流程。

消息实体格式:实例状态变更事件

示例如下。
 {
        "finishTime": 1619148187000,
        "beginWaitTimeTime": 1619148161000,
        "beginRunningTime": 1619148163000,
        "dagId": *****,
        "dagType": 0,
        "taskType": 0,
        "modifyTime": 1619148187000,
        "createTime": 1619027108000,
        "appId": *****,
        "tenantId": *****,
        "opCode": 61,
        "flowId": *****,
        "nodeId": *****,
        "beginWaitResTime": 1619148161000,
        "taskId": *****,
        "status": 6
    }
字段名称 字段类型 说明
finishTime Long 调度任务实例运行完成的具体时间
beginWaitTimeTime Long 调度任务实例开始等待的具体时间
beginRunningTime Long 调度任务实例开始运行的具体时间
dagId Long DagId
dagType Integer
Dag的类型,取值如下:
  • 0:周期调度任务
  • 1:手动任务
  • 2:冒烟测试
  • 3:补数据
  • 4:手动业务流程
  • 5:临时业务流程
taskType Integer
任务实例的调度类型,取值如下
  • NORMAL(0):正常调度任务。该任务被日常调度。
  • MANUAL(1):手动任务。该任务不会被日常调度。
  • PAUSE(2):冻结任务。该任务被日常调度,但启动调度时直接被置为失败状态。
  • SKIP(3):空跑任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • SKIP_UNCHOOSE(4):临时工作流中未选择的任务,仅存在于临时工作流中,启动调度时直接被置为成功状态。
  • SKIP_CYCLE(5):未到运行周期的周或月任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • CONDITION_UNCHOOSE(6):上游实例中有分支(IF)节点,但是该下游节点未被分支节点选中,直接置为空跑任务。
  • REALTIME_DEPRECATED(7):实时生成的已经过期的周期实例,该类型的任务直接被置为成功状态。
modifyTime Long 任务实例的修改时间。
createTime Long 任务实例的创建时间。
appId Long 工作空间的ID。
tenantId Long 调度任务实例的租户ID。
opCode Integer 调度任务实例的操作码:该字段可忽略。
flowId Long 业务流程的ID,周期调度任务实例的业务流程默认为1,手动业务流程和内部工作流调度任务实例为实际的业务流程ID
nodeId Long 调度任务实例对应的节点ID。
beginWaitResTime Long 调度任务实例开始等资源的具体时间。
taskId Long 调度任务实例ID。
status Integer
任务的状态,取值如下:
  • 0:未运行
  • 2:等待定时时间dueTime或cycleTime到来
  • 3:等待资源
  • 4:运行中
  • 5:执行失败
  • 6:执行成功
  • 7:表被下发给数据质量进行数据校检
  • 8:正在进行分支条件校检

消息实体格式:文件变更事件(文件提交、发布、运行、删除)

示例如下:
  • 文件提交、发布事件
    {
        "operator": "**************",  //本次操作人
        "projectId": 123456,
        "tenantId": 123456,
        "nodeId": 123456,    //节点ID
        "fileType": 123456, //文件类型
        "fileName": "********",
        "fileOwner": "****************",         //文件责任人
        "extensionBizId": "***************",    //
        "changeType": "UPDATE", //NEW UPDATE DELETE
        "fileCreateTime": "2021-01-15 14:03:02",
        "fileId": 123456,
        "fileVersion": 3,
        "dataSourceName":"odps_first"
    }
  • 文件运行、删除事件
    {
        "operator": "**************",  //本次操作人
        "projectId": 123456,
        "tenantId": 123456,
        "nodeId": 123456,    //节点ID
        "fileType": 123456, //文件类型
        "fileName": "********",
        "fileOwner": "****************",         //文件责任人
        "extensionBizId": "***************",    //
        "fileCreateTime": "2021-01-15 14:03:02",
        "fileId": 123456
    }
字段名称 字段类型 说明
operator String 发布人用户UID
projectId Long 项目空间ID
tenantId Long 租户ID
nodeId Long 调度节点ID
fileType Long 文件的代码类型,常用的代码类型包括6(Shell) 、 10(ODPS SQL)、11(ODPS MR) 、 23(数据集成)、24(ODPS Script) 、 99(虚拟节点)、221(PyODPS 2) 、 225(ODPS Spark)、227(EMR Hive) 、 228(EMR Spark)、229(EMR Spark SQL) 、 230(EMR MR)、239(OSS对象检查) 、 257(EMR Shell)、258(EMR Spark Shell) 、 259(EMR Presto)、260(EMR Impala) 、 900(实时同步)、1089(跨租户节点) 、 1091(Hologres开发)、1093(Hologres SQL) 、 1100(赋值节点)、1221(PyODPS 3)。
fileName String 文件名称
fileOwner String owner
extensionBizId String 检查器实例唯一标识
changeType String 变更类型UPDATEDELETECREATE
fileCreateTime String 文件创建时间 ( yyyy-MM-dd HH:mm:ss )
fileId Long 文件ID
fileVersion Long 文件版本
dataSourceName String 数据源名称

消息实体格式:表变更事件

示例如下。
{
    "operator": "**************",
    "projectId": 123456,
    "tenantId": 123456,
    "extensionBizId": "123456",
    "tableName":"table1",
    "tableType":"ODPS",  // ODPS、EMR
    "maxComputeProject":"project1"
}
字段名称 字段类型 说明
operator String 发布人用户UID
projectId Long 项目空间ID
tenantId Long 租户ID
extensionBizId String 检查器实例唯一标识
tableName String 事件所发生的表名称
tableType String 表类型。
  • ODPS
  • EMR
maxComputeProject String MaxCompute的项目名称。

消息实体格式:节点变更事件

示例如下。
{
  "nodeName": "",
  "programType": "ODPS_SQL",
  "cronExpress": "00 20 00 * * ?",
  "schedulerType": "NORMAL",
  "ownerId": "191223248874****",
  "priority": 1,
  "baselineId": 11780****,
  "repeatability": true,
  "modifyTime": 1646364549642,
  "createTime": 1646364549642,
  "datasource": "odps_first",
  "tenantId": 28378948471****,
  "nodeId": 100347****,
  "projectId": 3****
}
字段名称 字段类型 说明
nodeName String 节点名称。
programType String 节点类型。常用的代码及其对应的文件类型包括:
  • 6(Shell)
  • 10(ODPS SQL)
  • 11(ODPS MR)
  • 24(ODPS Script)
  • 99(虚拟节点)
  • 221(PyODPS 2)
  • 225(ODPS Spark)
  • 227(EMR Hive)
  • 228(EMR Spark)
  • 229(EMR Spark SQL)
  • 230(EMR MR)
  • 239(OSS对象检查)
  • 257(EMR Shell)
  • 258(EMR Spark Shell)
  • 259(EMR Presto)
  • 260(EMR Impala)
  • 900(实时同步)
  • 1089(跨租户节点)
  • 1091(Hologres开发)
  • 1093(Hologres SQL)
  • 1100(赋值节点)
  • 1221(PyODPS 3)
您可以调用ListFileType接口,查询文件的代码类型。
cronExpress String 周期调度的cron表达式,该参数与DataWorks控制台中,数据开发任务的调度配置 > 时间属性 > cron表达式对应。配置完调度周期定时调度时间后,DataWorks会自动生成相应cron表达式。示例如下:
  • 每天凌晨5点30分定时调度:00 30 05 * * ?
  • 每个小时的第15分钟定时调度:00 15 * * * ?
  • 每隔十分钟调度一次:00 00/10 * * * ?
  • 每天8点到17点,每隔十分钟调度一次:00 00-59/10 8-17 * * ?
  • 每月的1日0点20分自动调度:00 20 00 1 * ?
  • 从1月1日0点10分开始,每过3个月调度一次:00 10 00 1 1-12/3 ?
  • 每周二、周五的0点5分自动调度:00 05 00 * * 2,5
说明 由于DataWorks调度系统的规则,cron表达式有以下限制:
  • 最短调度间隔时间为5分钟。
  • 每天最早调度时间为0点5分。
schedulerType String 任务实例的调度类型,取值如下:
  • NORMAL(0):正常调度任务。该任务被日常调度。
  • MANUAL(1):手动任务。该任务不会被日常调度。
  • PAUSE(2):冻结任务。该任务被日常调度,但启动调度时直接被置为失败状态。
  • SKIP(3):空跑任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • SKIP_UNCHOOSE(4):临时工作流中未选择的任务,仅存在于临时工作流中,启动调度时直接被置为成功状态。
  • SKIP_CYCLE(5):未到运行周期的周或月任务。该任务被日常调度,但启动调度时直接被置为成功状态。
  • CONDITION_UNCHOOSE(6):上游实例中有分支(IF)节点,但是该下游节点未被分支节点选中,直接置为空跑任务。
  • REALTIME_DEPRECATED(7):实时生成的已经过期的周期实例,该类型的任务直接被置为成功状态。
ownerId String 节点责任人的阿里云用户ID。如果该参数为空,则默认使用节点调用者的阿里云用户ID。
priority Integer 任务优先级,1/3/5/7/8。
baselineId Long 基线ID。
repeatability Boolean 是否可以重复运行。
modifyTime Long 节点最后的修改时间。
createTime Long 节点的创建时间。
nodeId Long 节点ID。
projectId Long 节点所在的项目空间ID。
tenantId Long 节点所属的租户ID。

消息实体格式:补数据操作事件

示例如下。
{
  "excludeNodeIds":
  [],
  "rootNodeId": 1000083****,
  "startFutureInstanceImmediately": false,
  "useMultipleTimePeriods": true,
  "operator": "132087671033****",
  "multipleTimePeriods": "[{\"bizBeginTime\":\"2022-04-17\",\"bizEndTime\":\"2022-04-17\"}]",
  "parallelGroup": 1,
  "rootNodeProjectId": 1****,
  "isParallel": false,
  "name": "P_fff_20220418_215404",
  "tenantId": 16935091837****,
  "includeNodeIds":
  [
    1000083****
  ],
  "projectId": 1****,
  "order": "asc"
    }
字段名称 字段类型 说明
name String 补数据操作产生的工作流名称。
rootNodeId Long 补数据操作产生的工作流起始的根节点ID。
rootNodeProjectId Long 补数据操作产生的工作流的根节点所在的项目空间ID。
includeNodeIds Array 补数据的节点ID列表。
excludeNodeIds Array 无需补数据的节点ID列表,在这个列表中的节点会生成空跑实例,空跑实例被调度后会直接运行成功,不会执行脚本内容。
bizBeginTime String 任务的开始时间。仅小时调度任务需要设置该参数,格式为HH:mm:ss,取值范围为 00:00:00~23:59:59。
bizEndTime String 任务的结束时间。仅小时调度任务需要设置该参数,格式为HH:mm:ss,取值范围为 00:00:00~23:59:59。
isParallel Boolean 不同时间段的补数据操作是否可以并行运行。
parallelGroup Integer 并行运行的分组数,1表示不分组。
startFutureInstanceImmediately Boolean 如果补数据的业务日期是未来的时间段,是否跳过调度时间,立刻调起未来实例。
order String 业务日期运行的顺序,acs表示按业务日期正序运行,desc表示按业务日期倒序运行。
multipleTimePeriods String 分段选取业务时间段[{\"bizBeginTime\":\"2022-04-17\",\"bizEndTime\":\"2022-04-17\"}]
tenantId Long 租户ID。
projectId Long 补数据操作的项目ID。
operator String 补数据操作人。

消息实体格式:审批中心事件(审批任务创建、完成)

示例如下。
  • 审批任务创建通知
    {
      "appId":19****,
      "assignee":"28609853964174****",
      "assigneeName":"yupeng.sunyp",
      "createTime":165209436****,
      "eventType":"approval",
      "process":{
        "applicant":"28609853964174****",
        "applicantName":"yupeng.sunyp",
        "approvalContent":{
          "applyPeriod":"299796480****",
          "applyReason":"测试",
          "arrayData":[
            {
              "ownerBaseId":"182293110403****",
              "columns":[
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_070103.id",
                  "columnComment":"",
                  "columnName":"id"
                },
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_070103.name",
                  "columnComment":"",
                  "columnName":"name"
                },
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_070103.times",
                  "columnComment":"",
                  "columnName":"times"
                }
              ],
              "columnMetaList":[
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_070103.id",
                  "columnComment":"",
                  "columnName":"id"
                },
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_070103.name",
                  "columnComment":"",
                  "columnName":"name"
                },
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_070103.times",
                  "columnComment":"",
                  "columnName":"times"
                }
              ],
              "objectType":"TABLE",
              "odpsTable":"loghub_070103",
              "envType":1,
              "projectGuid":"odps.b_mc1",
              "objectGuid":"odps.b_mc1.loghub_070103",
              "tenantId":0,
              "objectName":"loghub_070103",
              "ownerAccountName":"ALIYUN$dataworks_3h1_1(dataworks_3h1_1)",
              "odpsProject":"B_MC1",
              "projectName":"B_MC1",
              "actions":[
                "Select",
                "Describe"
              ],
              "projectId":19****,
              "workspaceId":"19****"
            }
          ],
          "contentType":"application/json",
          "granteeAccounts":[
            {
              "granteeId":"28609853964174****",
              "granteeTypeSub":103,
              "granteeType":1,
              "granteeName":"RAM$dataworks_3h1_1:yupeng.sunyp"
            },
            {
              "granteeId":"23785763111910****",
              "granteeTypeSub":105,
              "granteeType":1,
              "granteeName":"RAM$dataworks_3h1_1:dev"
            }
          ],
          "odpsProjectName":"B_MC1",
          "projectEnv":"1",
          "resourceSummary":"loghub_070103",
          "tenantId":28074952195****,
          "workspaceId":19****
        },
        "assignmentCategory":"MaxCompute",
        "createTime":1652094363000,
        "processDefinitionId":"definition-3dcc9ce7-d29d-435d-a908-60d4355f****",
        "processId":"52853586998****",
        "status":"Pending",
        "title":"MaxComputeTable",
        "updateTime":1652094363000
      },
      "processId":"52853586998****",
      "status":"Submit",
      "taskId":"52853587001****",
      "tenantId":28074952195****,
      "updateTime":1652094364000
    }
  • 审批任务完成通知
    {
        "appId":22****,
        "assignee":"28609853964174****",
        "assigneeName":"yupeng.sunyp",
        "comments":"ces",
        "createTime":165209598****,
        "eventType":"approval",
        "process":{
            "applicant":"28609853964174****",
            "applicantName":"yupeng.sunyp",
            "approvalContent":{
                "applyPeriod":"299796480****",
                "applyReason":"测试",
                "arrayData":[
                    {
                        "ownerBaseId":"23826653973710****",
                        "columns":[
                            {
                                "columnType":"string",
                                "columnGuid":"odps.da_simple_202112.cdd.id",
                                "columnComment":"",
                                "columnName":"id"
                            }
                        ],
                        "columnMetaList":[
                            {
                                "columnType":"string",
                                "columnGuid":"odps.da_simple_202112.cdd.id",
                                "columnComment":"",
                                "columnName":"id"
                            }
                        ],
                        "objectType":"TABLE",
                        "odpsTable":"cdd",
                        "objectNameCn":"树大根深的",
                        "envType":1,
                        "projectGuid":"odps.da_simple_202112",
                        "objectGuid":"odps.da_simple_202112.cdd",
                        "tenantId":0,
                        "objectName":"cdd",
                        "ownerAccountName":"RAM$dataworks_3h1_1:wb-wjh926877(wb-wjh926877)",
                        "odpsProject":"da_simple_202112",
                        "projectName":"da_simple_202112",
                        "actions":[
                            "Select",
                            "Describe"
                        ],
                        "projectId":22****,
                        "workspaceId":"22****"
                    }
                ],
                "contentType":"application/json",
                "granteeAccounts":[
                    {
                        "granteeId":"28609853964174****",
                        "granteeTypeSub":103,
                        "granteeType":1,
                        "granteeName":"RAM$dataworks_3h1_1:yupeng.sunyp"
                    }
                ],
                "odpsProjectName":"da_simple_202112",
                "projectEnv":"1",
                "resourceSummary":"cdd",
                "tenantId":28074952195****,
                "workspaceId":22****
            },
            "assignmentCategory":"MaxCompute",
            "createTime":1652095981000,
            "processDefinitionId":"definition-6e6418e6-c65f-4f26-a673-88576b1c****",
            "processId":"52853918243****",
            "status":"Pending",
            "title":"MaxComputeTable",
            "updateTime":1652095981000
        },
        "processId":"52853918243****",
        "status":"Completed",
        "taskId":"52853918278****",
        "tenantId":28074952195****,
        "updateTime":1652096017000
    }
字段名称 字段类型 说明
appId Long 工作空间ID
assignee String 审批单处理人的BaseId
assigneeName String 处理人name
comments String 备注
createTime Long 申请单创建时间戳
eventType String 事件类型
process Object 审批任务对象
|--applicant String 申请人BaseId
|--applicantName String 申请人名称
|--approvalContent Object 审批中心的审批单内容
|----applyPeriod String 申请时长
|----applyReason String 申请原因
|----arrayData Arrya 授权内容列表(见附录)
|----contentType String 文本的数据类型
|----granteeAccounts Arrya 授权列表
|------granteeId String 授权主ID
|------granteeType String 授权类型
|------granteeTypeSub String 授权主体子类下,代表账号类型,具体如下:
  • 生产云账号(生产调度使用的账号):ACCOUNT_PRD(101)
  • 应用云账号:ACCOUNT_APP(102)
  • 个人云账号:ACCOUNT_USER(103)
  • 部门云账号:ACCOUNT_DEPT(104)
  • MOCK账号:ACCOUNT_MOCK(106)
  • 他人云账号:ACCOUNT_OTHER_USER(105)
|------granteeName String 授权主体名称
|----odpsProjectName String 项目名称
|----projectEnv String 所属环境
|----resourcesSummary String 资源描述
|----tenantId Long 租户ID
|----workspaceId Long 工作空间ID
|--assignmentCategory String 申请的权限内容类型
|--createTime String 申请单创建时间戳“desc”表示按业务日期倒序运行
|--processDefinitionId String 定义的审批工作流的唯一标识ID
|--processId String 工作流ID
|--status String 工作流状态
|--title String 工作流标题
|--updateTime Long 申请单更新时间戳
processId String 审批单ID
status String 审批单状态
taskId String 审批任务ID
tenantId String 租户ID
updateTime String 申请单更新时间戳

消息实体格式:监控告警事件

  • 基线告警
    {
        "alarmType": "SLA_ALERT",
        "baselineId": 13700****,
        "baselineName": "ods层check任务专用 -- 小时级",
        "baselineStatus": 3,
        "bizDate": 165444480****,
        "inGroupId": 14,
        "nodeId": 1000039****,
        "projectId": 7634,
        "taskId": 307289****,
        "tenantId": 26095350312****
    }
    字段名称 字段类型 说明
    alarmType String 告警类型:
    • SLA_ALERT
    • REMIND_ALERT
    • TOPIC_ALERT
    baselineId Long 基线ID
    baselineName String 基线名称
    baselineStatus Integer 基线的状态,包括:
    • -1(异常)
    • 1(安全)
    • 2(预警)
    • 3(破线)
    bizDate Long 业务日期时间戳。
    inGroupId Integer 基线实例的周期号。天基线为1,小时基线的取值范围为[1,24]。
    nodeId Long 导致基线异常的节点ID
    projectId Long 基线所属项目空间ID
    taskId Long 导致基线异常的实例ID
    tenantId Long 租户ID
  • 事件告警
    {
        "alarmType": "TOPIC_ALERT",
        "nodeId": 1000031****,
        "projectId": 9109,
        "taskId": 307275****,
        "taskStatus": 5,
        "tenantId": 28074952195****,
        "topicId": 108****
    }
    字段名称 字段类型 说明
    alarmType String 告警类型:
    • SLA_ALERT
    • REMIND_ALERT
    • TOPIC_ALERT
    topicId Long 事件的ID
    taskStatus String 触发事件的节点的实例状态
    nodeId Long 触发事件的节点ID
    projectId Long 触发事件的节点所属项目空间ID
    taskId Long 触发事件的节点的实例ID
    tenantId Long 租户ID
  • 规则告警
    • 当规则对象为任务节点、基线、工作空间、业务流程时:
      {
          "alarmType": "REMIND_ALERT",
          "nodeIds": "1000040****,1000040****,1000040****",
          "projectId": 9876,
          "remindId": 7605,
          "remindName": "出错报警",
          "remindType": "ERROR",
          "remindUnit": "NODE",
          "taskIds": "307290****,307290****,307290****",
          "tenantId": 25902581602****
      }
      字段名称 字段类型 说明
      alarmType String 告警类型:
      • SLA_ALERT
      • REMIND_ALERT
      • TOPIC_ALERT
      nodeIds String 触发规则告警的节点列表
      remindId Long 规则ID
      remindType String 触发条件,包括:
      • FINISHED(完成)
      • UNFINISHED(未完成)
      • ERROR(出错)
      • CYCLE_UNFINISHED(周期未完成)
      • TIMEOUT(运行超时)
      projectId Long 节点所属的项目空间
      remindUnit String 对象的类型,包括NODE(任务节点)、GATEWAY_RES(调度独享资源组)、DI_RES(数据集成资源组)。
      tenantId Long 租户ID
      taskIds String 触发规则告警的实例列表
      remindName String 规则名称
    • 当规则对象为资源组时:
      {
          "alarmType": "REMIND_ALERT",
          "projectId": 2991,
          "remindId": 20000****,
          "remindName": "独享资源组告警",
          "remindType": "RES_GROUP_THRESHOLD",
          "remindUnit": "GATEWAY_RES",
          "resourceGroupIdentifier": "S_res_group_19582071655****_165096585****",
          "resourceGroupName": "emr_exclusive_scheduld",
          "resourceGroupType": "GATEWAY",
          "tenantId": 19582071655****
      }
      字段名称 字段类型 说明
      alarmType String 告警类型:
      • SLA_ALERT
      • REMIND_ALERT
      • TOPIC_ALERT
      remindId Long 规则ID
      remindType Stirng 触发条件,包括:
      • FINISHED(完成)
      • UNFINISHED(未完成)
      • ERROR(出错)
      • CYCLE_UNFINISHED(周期未完成)
      • TIMEOUT(运行超时)
      • RES_GROUP_THRESHOL (资源组利用率)
      • RES_GROUP_WAIT_AMOUNT(资源组等资源实例数)
      projectId Long 节点所属的项目空间
      remindUnit String 对象的类型,包括:
      • NODE(任务节点)
      • GATEWAY_RES(调度独享资源组)
      • DI_RES(数据集成资源组)
      tenantId Long 租户ID
      remindName String 规则名称
      resourceGroupIdentifier String 资源组的唯一标识符
      resourceGroupName String 资源组名称
      resourceGroupType String 资源组类型 ,包括:
      • GATEWAY(调度资源组)
      • DI(数据集成资源组)

附录:事件类目详情(eventCategoryType)

事件类型 事件码
实例状态变更事件 instance-status-change
文件变更事件 file-change
任务变更事件 task-change
实例变更事件 instance-change
表变更事件 table-change
节点变更事件 node-change
补数据变更事件 backfill-data-operate
审批中心事件 approval-change
监控告警事件 monitor-alert

附录:事件详情(eventType)

系统模块 事件名称 事件编码 事件分类
运维中心 新增节点 node-change-created 普通事件
更新节点 node-change-updated 普通事件
删除节点 node-change-deleted 普通事件
冻结节点 freeze-node 扩展点事件
解冻节点 unfreeze-node 扩展点事件
下线节点 undeploy-node 扩展点事件
补数据 backfill-data 扩展点事件
数据开发 提交文件 commit-file 扩展点事件
发布文件 deploy-file 扩展点事件
运行文件 run-file 扩展点事件
删除文件 delete-file 扩展点事件
提交表 commit-table 扩展点事件
发布表 deploy-table 扩展点事件
审批中心 创建申请单 approval-change-created 普通事件
完成申请单 approval-change-finished 普通事件
监控告警 运维中心告警 workbench-monitor-alert 普通事件

附录:授权内容列表

  • assignmentCategory类型为MaxCompute时,arrayData的数据内容。
    [
      {
        "ownerBaseId":"182293110403****",
        "columns":[
          {
            "columnType":"decimal(38,18)",
            "columnGuid":"odps.px_wokebench_1.oracle_dss_a1214_1136_1_invalid_column.i__d",
            "columnComment":"",
            "columnName":"i__d"
          }
        ],
        "columnMetaList":[
          {
            "columnType":"decimal(38,18)",
            "columnGuid":"odps.px_wokebench_1.oracle_dss_a1214_1136_1_invalid_column.i__d",
            "columnComment":"",
            "columnName":"i__d"
          }
        ],
        "objectType":"TABLE",
        "odpsTable":"oracle_dss_a1214_1136_1_invalid_column",
        "envType":1,
        "projectGuid":"odps.px_wokebench_1",
        "objectGuid":"odps.px_wokebench_1.oracle_dss_a1214_1136_1_invalid_column",
        "tenantId":0,
        "objectName":"oracle_dss_a1214_1136_1_invalid_column",
        "ownerAccountName":"ALIYUN$dataworks_3h1_1(dataworks_3h1_1)",
        "odpsProject":"dataworks_pref_test1113",
        "projectName":"dataworks_pref_test1113",
        "actions":[
          "Select",
          "Describe"
        ],
        "projectId":10****,
        "workspaceId":"10****"
      }
    ]
    字段名称 字段类型 说明
    ownerBaseId String 表拥有者的BaseId
    ownerAccountName String 表拥有者的名称
    objectType String 对象类型
    odpsTable String 表名称
    envType String 环境
    projectGuid String 项目Guid
    objectGuid String 对象名称
    objectName String odps项目名称
    odpsProject String 项目code
    projectName String 工作空间名称
    projectId Long 工作空间ID
    workspaceId String 操作类型列表
    actions Array 列列表
    columns Array 列类型
    |--columnType String 列类型
    |--columnGuid String 列Guid
    |--columnComment String 列备注
    |--columnName String 列名
    columnMetaList Array 列元数据列表
    |--columnType String 列类型
    |--columnGuid String 列Guid
    |--columnComment String 列备注
    |--columnName String 列名
  • assignmentCategory类型为DataService时,arrayData的数据内容。
    [
      {
        "resourceId":"DsApiDeploy/1822931104031845/workspaceId/227859/dsDeployId/1|417381955947846|1|280749521950784|22****",
        "ownerName":"ysf01115618",
        "resourceVersion":1,
        "name":"api_api",
        "dsDeployId":"1|417381955947846|1|280749521950784|22****",
        "workspaceName":"da_simple_202112",
        "id":"41738195594****",
        "type":1,
        "ownerId":"25888213955403****",
        "url":"https://ds-cn-shanghai.data.aliyun.com/?projectId=227859&type=api&id=417381955947846&version=1&defaultProjectId=22****",
        "workspaceId":"22****"
      }
    ]
    字段名称 字段类型 说明
    resourceId String 资源ID
    ownerName String 资源拥有者名称
    ownerId String 资源责任人BaseId
    resourceVersion Long 资源版本
    name String 资源名称
    dsDeployId String 数据服务标示资源的唯一ID
    workspaceName String 工作空间名称
    workspaceId String 工作空间ID
    id String 资源唯一ID
    type String 资源类型:
    • 1(API)
    • 2(函数)
    • 3(服务编排)
    url String 数据服务链接地址
  • assignmentCategory类型为DataStudio时,arrayData的数据内容。
    [
        {
            "sourceDatasourceType":"mysql",
            "sourceTableName":"test_datahub_type_copy",
            "targetDatasourceType":"odps",
            "sourceDatasourceName":"test_Approval",
            "targetTableName":"test_approval_test_datahub_type_copy",
            "targetDatasourceName":"odps_first",
            "workspaceId":"24****"
        },
        {
            "sourceDatasourceType":"mysql",
            "sourceTableName":"test_datahub_type_copy",
            "targetDatasourceType":"odps",
            "sourceDatasourceName":"test_Approval",
            "targetTableName":"test_approval_test_datahub_type_copy",
            "targetDatasourceName":"odps_first",
            "workspaceId":"24****"
        }
    ]
    字段名称 字段类型 说明
    sourceDatasourceType String 源端数据类型
    sourceDatasourceName String 源端数据名称
    sourceTableName String 源端表名称
    targetDatasourceType String 目的端数据类型
    targetDatasourceName String 目的端数据名称
    targetTableName String 目的端表名称
    workspaceId String 工作空间ID