This topic describes the structure of an event message in DataWorks. It provides examples to show you the bodies of event messages for different types of events and describes the involved fields. Information in this topic helps you understand an event message and learn details of the status changes in DataWorks at the earliest opportunity.

Message structure

The following sample code provides an example of a complete event message:
{ 
 "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "beginWaitTimeTime": 165270057****,
    "dagId": 44655****,
    "dagType": 0,
    "taskType": 0,
    "modifyTime": 165270057****,
    "createTime": 165254323****,
    "appId": 3*****2,
    "tenantId": 235454***432001,
    "opCode": 31,
    "flowId": 1,
    "nodeId": 100269****,
    "beginWaitResTime": 165270057****,
    "taskId": 453268****,
    "status": 3
  },
  "id": "539fd8f4-4ea1-4625-aa8b-6c906674****",
  "source": "acs.dataworks",
  "specversion": "1.0",
  "subject": "",
  "time": "2020-11-19T21:04:41+08:00",
  "type": "dataworks:InstanceStatusChanges:InstanceStatusChanges",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}
The following table describes some fields in the preceding sample code.
Field Type Description
data object The body of the message. For more information about the message bodies for different types of events, see the following sections of this topic:
id String The unique ID of the message.
type String

The type of the event. Valid values include commit-file and deploy-file. For more information, see the Valid values of eventType section of this topic.

Note For more information about the remaining fields, see Overview.

Message body for an instance status change event

Sample code:
{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "beginWaitTimeTime": 165270057****,
    "dagId": 44655****,
    "dagType": 0,
    "taskType": 0,
    "modifyTime": 165270057****,
    "createTime": 165254323****,
    "appId": 3*****2,
    "tenantId": 235454***432001,
    "opCode": 31,
    "flowId": 1,
    "nodeId": 100269****,
    "beginWaitResTime": 165270057****,
    "taskId": 453268****,
    "status": 3
  },
  "id": "539fd8f4-4ea1-4625-aa8b-6c906674****",
  "source": "acs.dataworks",
  "specversion": "1.0",
  "subject": "",
  "time": "2020-11-19T21:04:41+08:00",
  "type": "dataworks:InstanceStatusChanges:InstanceStatusChanges",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}
Field Type Description
finishTime Long The time when the auto triggered node instance finished running.
beginWaitTimeTime Long The time when the auto triggered node instance started to wait for the scheduling time.
beginRunningTime Long The time when the auto triggered node instance started to run.
dagId Long DagId
dagType Integer The type of the DAG. Valid values:
  • 0: for auto triggered nodes
  • 1: for manually triggered nodes
  • 2: for smoke testing
  • 3: for nodes for which you backfill data
  • 4: for manually triggered workflows
  • 5: for temporary workflows
taskType Integer The type of the node. Valid values:
  • NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.
  • MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.
  • PAUSE(2): The node is a frozen node. The scheduling system still regularly runs the node but sets the node status to Failed when the scheduling system starts to run the node.
  • SKIP(3): The node is a dry-run node. The scheduling system still regularly runs the node but sets the node status to Succeeded when the scheduling system starts to run the node.
  • SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the node status to Succeeded when the scheduling system starts to run the node.
  • SKIP_CYCLE(5): The node is a node that is scheduled by the week or month and is waiting for the scheduling time to arrive. The scheduling system still regularly runs the node but sets the node status to Succeeded when the scheduling system starts to run the node.
  • CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.
  • REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the node status to Succeeded.
modifyTime Long The time when the node instance was modified.
createTime Long The time when the node instance was created.
appId Long The ID of the workspace. You can call the ListProjects operation to query the ID of a workspace.
tenantId Long The ID of the tenant that manages the workspace to which the auto triggered node instance belongs.
opCode Integer The operation code of the auto triggered node instance. You can ignore the field value.
flowId Long The ID of the workflow. For an auto triggered node instance, the field value is 1. For a manually triggered workflow or an auto triggered node instance of the internal workflow type, the field value is the actual workflow ID.
nodeId Long The ID of the node for which the auto triggered node instance was generated.
beginWaitResTime Long The time when the auto triggered node instance started to wait for resources.
taskId Long The ID of the auto triggered node instance.
status Integer The status of the node. Valid values:
  • 0: The node is not running.
  • 2: The node is waiting for the scheduling time to arrive. The scheduling time is specified by the dueTime or cycleTime parameter.
  • 3: The node is waiting for resources.
  • 4: The node is running.
  • 7: Tables that are specified in the node are issued to Data Quality for data check against monitoring rules in Data Quality.
  • 8: Branch conditions are being checked.
  • 5: The node failed to be run.
  • 6: The node is successfully run.

Message body for a file change event (file commit, deployment, execution, and deletion)

Sample code:
  • Sample code for file commit and deployment
    {
      "datacontenttype": "application/json;charset=utf-8",
      "data": {
        "operator": "**************",  // The operator.
        "projectId": 12*****56,
        "tenantId": 12*****56,
        "nodeId": 12****,    // The node ID.
        "fileType": 12****, // The type of the file.
        "fileName": "********",
        "fileOwner": "****************",         // The owner of the file.
        "extensionBizId": "***************",    //
        "changeType": "UPDATE", //NEW UPDATE DELETE
        "fileCreateTime": "2021-01-15 14:03:02",
        "fileId": 12****,
        "fileVersion": 3,
        "dataSourceName":"odps_first"
      },
      "id": "539fd8f4-4ea1-4625-aa8b-6c906674****",
      "source": "acs.dataworks",
      "specversion": "1.0",
      "subject": "",
      "time": "2020-11-19T21:04:41+08:00",
      "type": "dataworks:FileChange:CommitFile",
      "aliyunaccountid": "123456789098****",
      "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
      "aliyuneventbusname": "default",
      "aliyunregionid": "cn-hangzhou",
      "aliyunpublishaddr": "172.25.XX.XX"
    }
    Field Type Description
    operator String The unique identifier (UID) of the Alibaba Cloud account that performed the operation.
    projectId Long The ID of the workspace.
    tenantId Long The ID of the tenant.
    nodeId Long The ID of the node that is run by the scheduling system.
    fileType Long The code type of the file. Valid values:
    • 6 (Shell nodes)
    • 10 (ODPS SQL nodes)
    • 11 (ODPS MR nodes)
    • 23 (Data Integration nodes)
    • 24 (ODPS script nodes)
    • 99 (zero load nodes)
    • 221 (PyODPS 2 nodes)
    • 225 (ODPS Spark nodes)
    • 227 (EMR Hive nodes)
    • 228 (EMR Spark nodes)
    • 229 (EMR Spark SQL nodes)
    • 230 (EMR MR nodes)
  • Sample code for file execution and deletion
    {
      "datacontenttype": "application/json;charset=utf-8",
      "data": {
        "operator": "**************",  // The operator.
        "projectId": 12****,
        "tenantId": 12****,
        "nodeId": 12****,    // The node ID.
        "fileType": 12****, // The type of the file.
        "fileName": "********",
        "fileOwner": "****************",         // The owner of the file.
        "extensionBizId": "***************",    //
        "fileCreateTime": "2021-01-15 14:03:02",
        "fileId": 12****
      },
      "id": "539fd8f4-4ea1-4625-aa8b-6c906674****",
      "source": "acs.dataworks",
      "specversion": "1.0",
      "subject": "",
      "time": "2020-11-19T21:04:41+08:00",
      "type": "dataworks:FileChange:DeleteFile",
      "aliyunaccountid": "123456789098****",
      "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
      "aliyuneventbusname": "default",
      "aliyunregionid": "cn-hangzhou",
      "aliyunpublishaddr": "172.25.XX.XX"
    }
    Field Type Description
    operator String The UID of the Alibaba Cloud account that performed the operation.
    projectId Long The ID of the workspace.
    tenantId Long The ID of the tenant.
    nodeId Long The ID of the node that is run by the scheduling system.
    fileType Long The code type of the file. Valid values:
    • 6 (Shell nodes)
    • 10 (ODPS SQL nodes)
    • 11 (ODPS MR nodes)
    • 23 (Data Integration nodes)
    • 24 (ODPS script nodes)
    • 99 (zero load nodes)
    • 221 (PyODPS 2 nodes)
    • 225 (ODPS Spark nodes)
    • 227 (EMR Hive nodes)
    • 228 (EMR Spark nodes)
    • 229 (EMR Spark SQL nodes)
    • 230 (EMR MR nodes)
    • 239 (OSS object inspection nodes)
    • 257 (EMR Shell nodes)

Message body for a table change event (table commit to the development and production environments)

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "operator": "**************",
    "projectId": 12*****56,
    "tenantId": 12******56,
    "extensionBizId": "123456",
    "tableName":"table1",
    "tableType":"ODPS",  // The type of the table. Valid values: ODPS and EMR.
    "maxComputeProject":"project1"
  },
  "id": "539fd8f4-4ea1-4625-aa8b-6c906674c113",
  "source": "acs.dataworks",
  "specversion": "1.0",
  "subject": "",
  "time": "2020-11-19T21:04:41+08:00",
  "type": "dataworks:TableChange:CommitTable",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}
Field Type Description
operator String The UID of the Alibaba Cloud account that performed the operation.
projectId Long The ID of the workspace.
tenantId Long The ID of the tenant.
extensionBizId String The ID of check process in an extension.
tableName String The name of the table.
tableType String The type of the table. Valid values:
  • ODPS
  • EMR
maxComputeProject String The name of the MaxCompute project.

Message body for a node change event (node creation, modification, and deletion)

Sample code:
  • Sample code for node creation, modification, and deletion
    {
      "datacontenttype": "application/json;charset=utf-8",
      "data": {
        "nodeName": "",
        "programType": "ODPS_SQL",
        "cronExpress": "00 20 00 * * ?",
        "schedulerType": "NORMAL",
        "ownerId": "191223248874****",
        "priority": 1,
        "baselineId": 11780****,
        "repeatability": true,
        "modifyTime": 164636454****
        "createTime": 164636454****,
        "datasource": "odps_first",
        "tenantId": 28378****10656,
        "nodeId": 100***150,
        "projectId": 30**95,
        "operator": "**************"  // The operator.
      },
      "id": "539fd8f4-4ea1-4625-aa8b-6c906674****",
      "source": "acs.dataworks",
      "specversion": "1.0",
      "subject": "",
      "time": "2020-11-19T21:04:41+08:00",
      "type": "dataworks:NodeChange:NodeChangeDeleted",
      "aliyunaccountid": "123456789098****",
      "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
      "aliyuneventbusname": "default",
      "aliyunregionid": "cn-hangzhou",
      "aliyunpublishaddr": "172.25.XX.XX"
    }
    Field Type Description
    nodeName String The name of the node.
    programType String The type of the node. Valid values:
    • 6 (Shell nodes)
    • 10 (ODPS SQL nodes)
    • 11 (ODPS MR nodes)
    • 24 (ODPS script nodes)
    • 99 (zero load nodes)
    • 221 (PyODPS 2 nodes)
    • 225 (ODPS Spark nodes)
    • 227 (EMR Hive nodes)
    • 228 (EMR Spark nodes)
    • 229 (EMR Spark SQL nodes)
    • 230 (EMR MR nodes)
    • 239 (OSS object inspection nodes)
    • 257 (EMR Shell nodes)
    • 258 (EMR Spark Shell nodes)
    • 259 (EMR Presto nodes)
    • 260 (EMR Impala nodes)
    • 900 (real-time synchronization nodes)
    • 1089 (cross-tenant collaboration nodes)
    • 1091 (Hologres development nodes)
    • 1093 (Hologres SQL nodes)
    • 1100 (assignment nodes)
    • 1221 (PyODPS 3 nodes)
    You can call the ListFileType operation to query the code type of a file.
    cronExpress String The CRON expression that represents the periodic scheduling policy of the node.This parameter is equivalent to the Cron Expression parameter in the Schedule section of the Properties tab on the DataStudio page in the DataWorks console. After you configure the Scheduling Cycle and Run At parameters in the DataWorks console, DataWorks automatically generates the value of the Cron Expression parameter. Examples:
    • CRON expression for a node that is scheduled to run at 05:30 every day: 00 30 05 * * ?
    • CRON expression for a node that is scheduled to run at the fifteenth minute of each hour: 00 15 * * * ?
    • CRON expression for a node that is scheduled to run every 10 minutes: 00 00/10 * * * ?
    • CRON expression for a node that is scheduled to run every 10 minutes from 08:00 to 17:00 every day: 00 00-59/10 8-17 * * * ?
    • CRON expression for a node that is scheduled to run at 00:20 on the first day of each month: 00 20 00 1 * ?
    • CRON expression for a node that is scheduled to run every three months starting from 00:10 on January 1: 00 10 00 1 1-12/3 ?
    • CRON expression for a node that is scheduled to run at 00:05 every Tuesday and Friday: 00 05 00 * * 2,5
    The scheduling system of DataWorks imposes the following limits on CRON expressions:
    • A node can be scheduled to run at a minimum interval of 5 minutes.
    • A node can be scheduled to run at 00:05 every day at the earliest.
  • Sample code for node freezing, unfreezing, and undeployment
    {
      "datacontenttype": "application/json;charset=utf-8",
      "data": {
        "operator": "**************",
        "projectId": 12*****56,
        "tenantId": 12******56,
        "extensionBizId": "12****",
        "tableName":"table1",
        "tableType":"ODPS",  // The type of the table. Valid values: ODPS and EMR.
        "maxComputeProject":"project1"
      },
      "id": "539fd8f4-4ea1-4625-aa8b-6c906674****",
      "source": "acs.dataworks",
      "specversion": "1.0",
      "subject": "",
      "time": "2020-11-19T21:04:41+08:00",
      "type": "dataworks:TableChange:CommitTable",
      "aliyunaccountid": "123456789098****",
      "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
      "aliyuneventbusname": "default",
      "aliyunregionid": "cn-hangzhou",
      "aliyunpublishaddr": "172.25.XX.XX"
    }
    Field Type Description
    operator String The UID of the Alibaba Cloud account that performed the operation.
    projectId Long The ID of the workspace.
    tenantId Long The ID of the tenant.
    nodeIds Array The IDs of the nodes on which you performed the operation.
    extensionBizId String The ID of check process in an extension.

Message body for a data backfill event

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "excludeNodeIds":[],
    "rootNodeId": 1000083****,
    "startFutureInstanceImmediately": false,
    "useMultipleTimePeriods": true,
    "operator": "132087671033****",
    "multipleTimePeriods": "[{\"bizBeginTime\":\"2022-04-17\",\"bizEndTime\":\"2022-04-17\"}]",
    "parallelGroup": 1,
    "rootNodeProjectId": 12*****8,
    "isParallel": false,
    "name": "P_fff_20220418_21*****",
    "tenantId": 16935*****3377,
    "includeNodeIds":
    [
      1000083****
    ],
    "projectId": 1****,
    "order": "asc",
    "extensionBizId": "12****"
  },
  "id": "539fd8f4-4ea1-4625-aa8b-6c906674****",
  "source": "acs.dataworks",
  "specversion": "1.0",
  "subject": "",
  "time": "2020-11-19T21:04:41+08:00",
  "type": "dataworks:BackfillDataOperate:BackfillData",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}
Field Type Description
name String The name of the workflow in which a data backfill operation is performed.
rootNodeId Long The ID of the root node in the workflow in which a data backfill operation is performed.
rootNodeProjectId Long The ID of the workspace to which the root node belongs. The root node is in the workflow in which a data backfill operation is performed.
includeNodeIds Array The IDs of the nodes for which you backfill data.
excludeNodeIds Array The IDs of the nodes for which no data needs to be backfilled. The system generates dry-run instances for all these nodes. After these dry-run instances are scheduled, the statuses of these instances are directly set to Succeeded, but the script is not run.
bizBeginTime String The time when the node started to run. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.
bizEndTime String The time when the node finished running. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.
isParallel Boolean Specifies whether data backfill instances in different periods of time can be run in parallel.
parallelGroup Integer The number of data backfill instance groups that are run in parallel. The value 1 indicates that data backfill instances are not grouped.
startFutureInstanceImmediately Boolean Specifies whether to immediately run node instances that are scheduled to run at future points in time.
order String The node execution sequence based on data timestamps. The value acs indicates that nodes are run based on data timestamps in chronological order.

Message body for an Approval Center event (request task creation and completion)

Sample code:

  • Sample code for request task creation
    {
      "datacontenttype": "application/json;charset=utf-8",
      "data": {
        "appId":19****,
      "assignee":"28609853964174****",
      "assigneeName":"yupeng.sunyp",
      "createTime":165209436****,
      "eventType":"approval",
      "process":{
        "applicant":"28609853964174****",
        "applicantName":"yupeng.sunyp",
        "approvalContent":{
          "applyPeriod":"299796480****",
          "applyReason":"test",
          "arrayData":[
            {
              "ownerBaseId":"182293110403****",
              "columns":[
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_07****.id",
                  "columnComment":"",
                  "columnName":"id"
                },
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_07****.name",
                  "columnComment":"",
                  "columnName":"name"
                },
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_07****.times",
                  "columnComment":"",
                  "columnName":"times"
                }
              ],
              "columnMetaList":[
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_07****.id",
                  "columnComment":"",
                  "columnName":"id"
                },
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_07****.name",
                  "columnComment":"",
                  "columnName":"name"
                },
                {
                  "columnType":"string",
                  "columnGuid":"odps.b_mc1.loghub_07****.times",
                  "columnComment":"",
                  "columnName":"times"
                }
              ],
              "objectType":"TABLE",
              "odpsTable":"loghub_07****",
              "envType":1,
              "projectGuid":"odps.b_mc1",
              "objectGuid":"odps.b_mc1.loghub_07****",
              "tenantId":0,
              "objectName":"loghub_07****",
              "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_07****",
          "tenantId":28074952195****,
          "workspaceId":194209
        },
        "assignmentCategory":"MaxCompute",
        "createTime":1652094363000,
        "processDefinitionId":"definition-3dcc9ce7-d29d-435d-a908-60d4355f****",
        "processId":"52853586998****",
        "status":"Pending",
        "title":"MaxComputeTable",
        "updateTime":165209436****
      },
      "processId":"52853586998****",
      "status":"Submit",
      "taskId":"52853587001****",
      "tenantId":28074952195****,
      "updateTime":165209436****
      },
      "id": "539fd8f4-4ea1-4625-aa8b-6c906674****",
      "source": "acs.dataworks",
      "specversion": "1.0",
      "subject": "",
      "time": "2020-11-19T21:04:41+08:00",
      "type": "dataworks:ApprovalChange:ApprovalChangeCreated",
      "aliyunaccountid": "123456789098****",
      "aliyunpublishtime": "2020-11-19T21:04:42.179PRC",
      "aliyuneventbusname": "default",
      "aliyunregionid": "cn-hangzhou",
      "aliyunpublishaddr": "172.25.XX.XX"
    }
  • Sample code for request task completion
    [
      {
        "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_test****",
        "projectName":"dataworks_pref_test****",
        "actions":[
          "Select",
          "Describe"
        ],
        "projectId":10****,
        "workspaceId":"10****"
      }
    ]
Field Type Description
appId Long The ID of the workspace.
assignee String The base ID of the Alibaba Cloud account used by the request approver.
assigneeName String The name of the Alibaba Cloud account used by the request approver.
comments String The comment.
createTime Long The timestamp at which the request order is created.
processId String The ID of the request processing order.
status String The status of the request processing order.
taskId String The ID of the request task.
tenantId String The ID of the tenant.
updateTime String The timestamp at which the request order is updated.
eventType String The type of the event.
process Object The process for the request task.
|--applicant String The base ID of the applicant.
|--applicantName String The name of the applicant.
|--assignmentCategory String The type of the content on which you request permissions.
|--createTime String The timestamp at which the request order is created. The value desc indicates that nodes are run based on data timestamps in reverse chronological order.
|--processDefinitionId String The unique ID of the defined approval workflow.
|--processId String The ID of the workflow.
|--status String The status of the workflow.
|--title String The title of the workflow.
|--updateTime Long The timestamp at which the request order is updated.
|--approvalContent Object The content of the request order.
|----applyPeriod String The validity period of the requested permissions.
|----applyReason String The reason for the request.
|----contentType String The data type of the content.
|----odpsProjectName String The name of the MaxCompute project.
|----resourceSummary String The description of the resource.
|----tenantId Long The ID of the tenant.
|----workspaceId Long The ID of the workspace.
|----projectEnv String The environment of the MaxCompute project.
|----granteeAccounts Array The accounts of the requesters.
|------granteeId String The ID of the requester.
|------granteeType String The authorization type.
|------granteeTypeSub String The account type of the requester. Valid values:
  • ACCOUNT_PRD(101): The account that is used for node scheduling in the production environment.
  • ACCOUNT_APP(102): The account for an application.
  • ACCOUNT_USER(103): The account for a user.
  • ACCOUNT_DEPT(104): The account for a department.
  • ACCOUNT_MOCK(106): The account for MOCK.
  • ACCOUNT_OTHER_USER(105): The account for another user.
|------granteeName String The name of the requester.
|----arrayData Array The authorized content. For more information, see Authorized content.

Valid values of eventCategoryType

Event category Value of eventCategoryType
Instance status change events instance-status-change
File change events file-change
Table change events table-change
Node change events node-change
Data backfill change events backfill-data-operate
Approval Center events approval-change

Valid values of eventType

DataWorks module Event name Value of eventType Event type
Operation Center Create a node node-change-created Regular event
Update a node node-change-updated Regular event
Delete a node node-change-deleted Regular event
Freeze a node freeze-node Extension point event
Unfreeze a node unfreeze-node Extension point event
Undeploy a node undeploy-node Extension point event
Backfill data for a node backfill-data Extension point event
DataStudio Commit a file commit-file Extension point event
Deploy a file deploy-file Extension point event
Run a file run-file Extension point event
Delete a file delete-file Extension point event
Commit a table commit-table Extension point event
Deploy a table deploy-table Extension point event
Approval Center Create a request order approval-change-created Regular event
Complete a request order approval-change-finished Regular event

Authorized content

  • The following code shows the data in arrays when the value of the assignmentCategory field is MaxCompute:
    [
      {
        "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_test****",
        "projectName":"dataworks_pref_test****",
        "actions":[
          "Select",
          "Describe"
        ],
        "projectId":10****,
        "workspaceId":"10****"
      }
    ]
    Field Type Description
    ownerBaseId String The base ID of the table owner.
    ownerAccountName String The name of the table owner.
    objectType String The type of the object.
    odpsTable String The name of the table.
    envType String The type of the environment.
    projectGuid String The Globally Unique Identifier (GUID) of the MaxCompute project.
    objectGuid String The GUID of the object.
    objectName String The name of the object.
    odpsProject String The name of the MaxCompute project.
    projectName String The code of the MaxCompute project.
    projectId Long The ID of the project.
    workspaceId String The ID of the workspace.
    actions Array The actions.
    columns Array The columns.
    |--columnType String The type of the column.
    |--columnGuid String The GUID of the column.
    |--columnComment String The comment for the column.
    |--columnName String The name of the column.
    columnMetaList Array The metadata for the column.
    |--columnType String The type of the column.
    |--columnGuid String The GUID of the column.
    |--columnComment String The comment for the column.
    |--columnName String The name of the column.
  • The following code shows the data in arrays when the value of the assignmentCategory field is DataService:
    [
      {
        "resourceId":"DsApiDeploy/1822931104031845/workspaceId/227859/dsDeployId/1|417381955947846|1|280749521950784|22****",
        "ownerName":"ysf0111****",
        "resourceVersion":1,
        "name":"api_api",
        "dsDeployId":"1|417381955947846|1|280749521950784|22****",
        "workspaceName":"da_simple_20****",
        "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****"
      }
    ]
    Field Type Description
    resourceId String The ID of the resource.
    ownerName String The name of the resource owner.
    ownerId String The base ID of the resource owner.
    resourceVersion Long The version of the resource.
    name String The name of the resource.
    dsDeployId String The ID of the API published in DataService Studio.
    workspaceName String The name of the workspace.
    workspaceId String The ID of the workspace.
    id String The unique identifier of the resource.
    type String The type of the resource. Valid values:
    • 1 (API)
    • 2 (function)
    • 3 (service orchestration)
    url String The URL for DataService Studio.
  • The following code shows the data in arrays when the value of the assignmentCategory field is DataStudio:
    [
        {
            "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****"
        }
    ]
    Field Type Description
    sourceDatasourceType String The type of the source.
    sourceDatasourceName String The name of the source.
    sourceTableName String The name of the source table.
    targetDatasourceType String The type of the destination.
    targetDatasourceName String The name of the destination.
    targetTableName String The name of the destination table.