Daftar Event dan Format Pesan untuk EventBridge - DataWorks

Topik ini menjelaskan jenis event, format pesan, dan definisi field untuk DataWorks.

Ikhtisar

DataWorks mengklasifikasikan event menjadi dua jenis, yaitu regular event dan extension point event, berdasarkan apakah suatu event dapat memblokir operasi internal DataWorks serta apakah layanan yang berlangganan dapat mengembalikan hasil pemrosesan.

regular event: Anda dapat berlangganan regular event melalui fitur Open Events (OpenEvent). Event ini tidak memblokir operasi pemicu.
extension point event: Setelah berlangganan jenis event ini, Anda dapat menggunakan fitur Extensions untuk menentukan respons kustom. Ketika suatu operasi memicu jenis event ini, DataWorks akan memblokir operasi tersebut hingga ekstensi kustom Anda mengembalikan hasil.

Topik ini menjelaskan event yang didukung oleh setiap modul, termasuk kategorinya (regular event atau extension point event), EventBridge Type, dan eventCode for Extensions.

Type: Field untuk memfilter pesan event. Lihat Aktifkan langganan pesan event untuk detailnya.
eventCode: Kode yang mengidentifikasi event tertentu. Selama pengembangan lokal, Anda dapat mengambil kode ini dari muatan (payload) pesan event dari DataWorks untuk mengidentifikasi event tersebut.

Workspace events

Modul tingkat ruang kerja menghasilkan event tingkat ruang kerja. Misalnya, DataStudio menghasilkan event ketika node dijalankan, dan Operation Center menghasilkan event ketika status instance yang dipicu otomatis berubah. Lihat Daftar Event di bawah ini untuk mengetahui event yang didukung oleh setiap modul, jenisnya (regular atau extension point), serta format pesan yang sesuai.

Tab Format pesan pada bagian ini hanya menyediakan pratinjau. Untuk format pesan lengkap yang dikirim ke EventBridge atau Function Compute, lihat Lampiran: Format pesan.

Daftar event DataStudio

Event

Jenis event	Event dan operasi	Regular event	Extension point event	Jenis EventBridge	Kode event ekstensi
Event perubahan node	Buat node Terjadi ketika Node baru diterapkan ke Lingkungan Produksi.			`dataworks:NodeChange:NodeChangeCreated`	`node-change-created`
Event perubahan node	Perbarui node Terjadi ketika Node dimodifikasi di Lingkungan Pengembangan. Terjadi ketika modifikasi diterapkan ke Lingkungan Produksi.			`dataworks:NodeChange:NodeChangeUpdated`	`node-change-updated`
Event perubahan file Node Resource Function	Pre-event untuk penghapusan file Terjadi sebelum Node dihapus dari Lingkungan Pengembangan. Catatan File yang dihapus dipindahkan ke Recycle Bin.			`dataworks:FileChange:DeleteFile`	`delete-file`
	Pre-event untuk commit file			`dataworks:FileChange:CommitFile`	`commit-file`
	Pre-event untuk deployment file			`dataworks:FileChange:DeployFile`	`deploy-file`
	Pre-event untuk menjalankan kode			`dataworks:FileChange:RunFile`	`run-file`
Event perubahan tabel	Pre-event untuk commit tabel			`dataworks:TableChange:CommitTable`	`commit-table`
Event perubahan tabel	Pre-event untuk deployment tabel			`dataworks:TableChange:DeployTable`	`deploy-table`

Format pesan

Event perubahan node

Contoh berikut menunjukkan format isi pesan (konten field data dalam pesan event) untuk event penambahan, modifikasi, atau penghapusan node.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "nodeName": "****",
    "programType": "ODPS_SQL",
    "cronExpress": "00 04 00 * * ?",
    "blockBusiness": false,
    "schedulerType": "NORMAL",
    "ownerId": "19****735",
    "priority": 1,
    "baselineId": 70***287,
    "operator": "19***735", // Pengguna yang melakukan tindakan.
    "eventCode": "node-change-created",
    "repeatability": true,
    "modifyTime": 17***864,
    "createTime": 17***864,
    "tenantId": 28***656,
    "nodeId": 70***003,
    "projectId": 9***4
  }
}

Tabel berikut menjelaskan properti objek data.

Parameter	Tipe	Deskripsi
nodeName	String	Nama Node.
programType	String	Tipe kode file. Anda dapat memanggil operasi API ListFileType atau lihat jenis Node yang didukung untuk daftar tipe kode yang valid.
cronExpress	String	Ekspresi Cron untuk penjadwalan periodik. Parameter ini sesuai dengan dari tugas DataStudio di Konsol DataWorks. DataWorks secara otomatis menghasilkan Ekspresi Cron setelah Anda mengonfigurasi Siklus Penjadwalan dan Waktu Terjadwal. Berikut beberapa contohnya: Jadwalkan Tugas untuk dijalankan setiap hari pukul 05:30: `00 30 05 * * ?` Jadwalkan Tugas untuk dijalankan pada menit ke-15 setiap jam: `00 15 * * * ?` Jadwalkan Tugas setiap 10 menit: `00 00/10 * * * ?` Jadwalkan Tugas setiap 10 menit dari pukul 08:00 hingga 17:00 setiap hari: `00 00-59/10 8-17 * * * ?` Jadwalkan Tugas untuk dijalankan pukul 00:20 pada tanggal 1 setiap bulan: `00 20 00 1 * ?` Jadwalkan Tugas setiap tiga bulan, dimulai dari 00:10 pada 1 Januari: `00 10 00 1 1-12/3 ?` Jadwalkan Tugas untuk dijalankan pukul 00:05 setiap hari Selasa dan Jumat: `00 05 00 * * 2,5` Catatan Batasan berikut berlaku untuk Ekspresi Cron: Interval penjadwalan minimum adalah 5 menit. Waktu terawal Tugas dapat dijadwalkan untuk dijalankan setiap hari adalah pukul 00:05.
schedulerType	String	Tipe penjadwalan Instance Tugas. Nilai yang valid adalah: NORMAL (0): Tugas otomatis yang dipicu secara normal. Tugas dijalankan sesuai jadwal rutinnya. MANUAL (1): Tugas Manual. Tugas tidak dijalankan sesuai jadwal rutin. PAUSE (2): Tugas yang Dibekukan. Tugas dijalankan sesuai jadwal rutin, tetapi Statusnya langsung diatur ke Gagal saat dieksekusi. SKIP (3): Tugas simulasi kering. Tugas dijalankan sesuai jadwal rutin, tetapi Statusnya langsung diatur ke Berhasil saat dieksekusi. SKIP_UNCHOOSE (4): Tugas yang tidak dipilih dalam Alur Kerja Sementara. Jenis ini hanya ada dalam Alur Kerja Sementara. Statusnya langsung diatur ke Berhasil saat dieksekusi. SKIP_CYCLE (5): Tugas mingguan atau bulanan yang belum mencapai waktu eksekusinya. Tugas dijalankan sesuai jadwal rutin, tetapi Statusnya langsung diatur ke Berhasil saat dieksekusi. CONDITION_UNCHOOSE (6): Tugas turunan yang tidak dipilih oleh Node cabang (IF) hulu. Tugas ini diperlakukan sebagai Tugas simulasi kering. REALTIME_DEPRECATED (7): Instance periodik yang dihasilkan secara real-time dan telah kedaluwarsa. Statusnya langsung diatur ke Berhasil.
ownerId	String	ID Akun Alibaba Cloud pemilik Node. Jika parameter ini kosong, nilai default-nya adalah ID Akun Alibaba Cloud pemanggil.
priority	Integer	Prioritas Tugas. Nilai yang valid adalah 1, 3, 5, 7, dan 8. Nilai yang lebih besar menunjukkan prioritas yang lebih tinggi.
baselineId	Long	ID Garis Dasar.
repeatability	Boolean	Menunjukkan apakah Node dapat dijalankan ulang. true: Node dapat dijalankan ulang. false: Node tidak dapat dijalankan ulang.
modifyTime	Long	Waktu terakhir Node dimodifikasi.
createTime	Long	Waktu Node dibuat.
nodeId	Long	ID Node.
projectId	Long	ID Ruang Kerja tempat Node berada.
tenantId	Long	ID Penyewa tempat Node tersebut berada.
operator	String	ID Pengguna (UID) operator yang membuat, memperbarui, atau menghapus Node.
eventCode	String	Kode event titik ekstensi.

Event perubahan file

Contoh berikut menunjukkan format pesan untuk event Commit dan Deploy file. Isi pesan adalah konten field data.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "fileName": "******",
    "extensionBizId": "eb******9ce",
    "changeType": "0",
    "blockBusiness": false,
    "dataSourceName": "0_******engine",
    "operator": "19***735",
    "eventCode": "commit-file",
    "fileCreateTime": "2024-07-12 11:08:50",
    "tenantId": 28***656,
    "fileOwner": "19***735",
    "fileVersion": 1,
    "projectId": 9***4,
    "fileType": 10,
    "fileId": 50***830,
    "resourceType": 1
  }
}

Tabel berikut menjelaskan properti objek data.

Parameter	Type	Deskripsi
operator	String	ID Pengguna (UID) operator yang melakukan commit atau deploy file.
projectId	Long	ID Ruang Kerja tempat file tersebut berada.
tenantId	Long	ID Penyewa.
nodeId	Long	ID Node terjadwal.
fileType	Long	Tipe kode file. Anda dapat memanggil operasi API ListFileType atau lihat jenis Node yang didukung untuk daftar tipe kode yang valid.
fileName	String	Nama file.
fileOwner	String	Pemilik file.
extensionBizId	String	ID proses checkpoint ekstensi.
changeType	String	Jenis perubahan yang dilakukan pada file. Nilai yang valid meliputi: 0: File dibuat. 1: File diperbarui. 2: File dihapus.
fileCreateTime	String	Waktu file dibuat, dalam format `yyyy-MM-dd HH:mm:ss`.
fileId	Long	ID file.
fileVersion	Long	Versi file.
dataSourceName	String	Nama sumber data.
eventCode	String	Kode event titik ekstensi.

Contoh berikut menunjukkan format pesan untuk event Delete dan Run file. Isi pesan adalah konten field data.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "fileName": "***",
    "extensionBizId": "bf******6e3",
    "blockBusiness": false,
    "operator": "19***735",
    "eventCode": "delete-file",
    "fileCreateTime": "2024-07-12 11:08:50", // Waktu file dibuat.
    "tenantId": 28***656,
    "fileOwner": "19***735", // Pemilik file.
    "nodeId": 70***003,
    "projectId": 9***4,
    "fileType": 10,
    "fileId": 50***830,
    "resourceType": 1
  }
}

Tabel berikut menjelaskan properti objek data.

Parameter	Tipe	Deskripsi
operator	String	ID Pengguna (UID) operator yang menghapus atau menjalankan file.
projectId	Long	ID Ruang Kerja tempat file tersebut berada.
tenantId	Long	ID Penyewa.
nodeId	Long	ID Node terjadwal.
fileType	Long	Tipe kode file. Anda dapat memanggil operasi API ListFileType atau lihat jenis Node yang didukung untuk daftar tipe kode yang valid.
fileName	String	Nama file.
fileOwner	String	Pemilik file.
extensionBizId	String	ID proses checkpoint ekstensi.
fileCreateTime	String	Waktu file dibuat, dalam format `yyyy-MM-dd HH:mm:ss`.
fileId	Long	ID file.
eventCode	String	Kode event titik ekstensi.

Event perubahan tabel

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "operator": "**************",
    "projectId": 12*****56,
    "tenantId": 12******56,
    "extensionBizId": "12***56",
    "tableName":"table1",
    "tableType":"ODPS",  
    "maxComputeProject":"project1"
  }
}

Tabel berikut menjelaskan properti objek data.

Parameter	Tipe	Deskripsi
operator	String	ID Pengguna (UID) operator yang melakukan commit atau deploy tabel.
projectId	Long	ID Ruang Kerja.
tenantId	Long	ID Penyewa.
extensionBizId	String	ID proses checkpoint ekstensi.
tableName	String	Nama tabel.
tableType	String	Jenis tabel. Satu-satunya nilai yang valid adalah ODPS.
maxComputeProject	String	Nama proyek MaxCompute.

Event integrasi data

Daftar event

Jenis Peristiwa

Event dan pemicu

Regular event

Extension point event

Tipe event EventBridge

Kode event ekstensi (eventCode)

Event Perubahan Node

Mulai Pekerjaan

dataworks:NodeChange:StartDiJob

start-diJob

Mulai Tugas Batch

dataworks:NodeChange:BatchStartDiJob

batch-start-diJob

Skema event

Event Perubahan Node: Mulai Pekerjaan

Contoh format isi pesan untuk Event Perubahan Node - Event Mulai Pekerjaan (yaitu konten field data dalam pesan event) adalah sebagai berikut.

// Pesan V1: Pekerjaan melibatkan kurang dari 500 tabel.
{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
        "eventCode": "start-diJob",
        "extensionBizId": "0a4***b8ae",
        "extensionBizName": "sync_mysql_to_odps_20240726_192307",
        "appId": 293624,
        "showTableMapping": true,
        "tenantId": 28***656,
        "blockBusiness": true,
        "id": 5280,
        "projectId": 9***4,
        "tableMapping": [
            {
                "srcTable": "xb_test_116",
                "dstDatasourceName": "odps_first",
                "srcDatabaseName": "xiaobo_sharding_79fz",
                "srcDatasourceName": "mysql_3357_pub_ip_1",
                "dstTable": "ods_xb_test_116"
            },
            {
                "srcTable": "xb_test_117",
                "dstDatasourceName": "odps_first",
                "srcDatabaseName": "xiaobo_sharding_79fz",
                "srcDatasourceName": "mysql_3357_pub_ip_1",
                "dstTable": "ods_xb_test_117"
            },
            {
                "srcTable": "xb_test_118",
                "dstDatasourceName": "odps_first",
                "srcDatabaseName": "xiaobo_sharding_79fz",
                "srcDatasourceName": "mysql_3357_pub_ip_1",
                "dstTable": "ods_xb_test_118"
            },
            {
                "srcTable": "xb_test_135",
                "dstDatasourceName": "odps_first",
                "srcDatabaseName": "xiaobo_sharding_79fz",
                "srcDatasourceName": "mysql_3357_pub_ip_1",
                "dstTable": "ods_xb_test_135"
            }
        ],
        "operator": "1504650005316516"
    }
}

// Pesan V2: Pekerjaan melibatkan kurang dari 500 tabel.
{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
        "extensionBizId": "59d***50fc",
        "extensionBizName": "sync_mysql_to_holo_20240911_170801",
        "blockBusiness": true,
        "operator": "19***735",
        "setting": {
            "lastStartPosition": "2024-09-11 12:00:00"
        },
        "eventCode": "start-diJob",
        "jobId": 5777,
        "forceRun": false,
        "appId": 293624,
        "showTableMapping": true,
        "tenantId": 28***656,
        "startAsV2": false,
        "tableMapping": [
            {
                "srcTable": "test_verify1",
                "dstDatasourceName": "molin_db",
                "srcDatabaseName": "di_test",
                "srcDatasourceName": "mysql_public",
                "dstTable": "test_verify1"
            },
            {
                "srcTable": "test_verify1_dst",
                "dstDatasourceName": "molin_db",
                "srcDatabaseName": "di_test",
                "srcDatasourceName": "mysql_public",
                "dstTable": "test_verify1_dst"
            },
            {
                "srcTable": "mysql_0_timetest2",
                "dstDatasourceName": "molin_db",
                "srcDatabaseName": "di_test",
                "srcDatasourceName": "mysql_public",
                "dstTable": "mysql_0_timetest2"
            }
        ]
    }
}

// Pesan V2: Pekerjaan melibatkan lebih dari 500 tabel, sehingga "showTableMapping" bernilai false.
{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
        "eventCode": "start-diJob",
        "jobId": 5502,
        "forceRun": false,
        "extensionBizId": "f4c***7cbc",
        "extensionBizName": "sync_mysql_to_holo_20240412_213634",
        "appId": 330914,
        "showTableMapping": false,
        "tenantId": 28***656,
        "blockBusiness": true,
        "startAsV2": false,
        "operator": "19***735",
        "setting": {
            "lastStartPosition": "2024-04-12 22:07:02",
            "startDateTime": "2024-09-10 17:00:00",
            "timeZone": "Asia/Shanghai"
        }
    }
}

// Contoh dengan ekspresi reguler dalam nama tabel.
{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
        "eventCode": "start-diJob",
        "jobId": 5778,
        "forceRun": false,
        "extensionBizId": "a5d***75ba",
        "extensionBizName": "sync_mysql_to_holo_20240912_170517",
        "appId": 293624,
        "showTableMapping": true,
        "tenantId": 28***656,
        "blockBusiness": true,
        "startAsV2": false,
        "tableMapping": [
            {
                "srcTable": "test.*",
                "dstDatasourceName": "molin_db",
                "srcDatabaseName": ".*",
                "srcDatasourceName": "mysql_public",
                "dstTable": "aaa"
            },
            {
                "srcTable": "shard.*",
                "dstDatasourceName": "molin_db",
                "srcDatabaseName": ".*",
                "srcDatasourceName": "mysql_public",
                "dstTable": "vvv"
            }
        ],
        "operator": "19***735"
    }
}

Tabel berikut menjelaskan field dalam muatan event.

Parameter	Tipe	Deskripsi
projectId	Long	ID Ruang Kerja DataWorks.
operator	String	UID pengguna yang memicu event.
extensionBizName	String	Nama solusi.
showTableMapping	Boolean	Menentukan apakah detail Pemetaan Tabel dikembalikan. true: Detail dikembalikan. false: Detail tidak dikembalikan. Jika pekerjaan melibatkan lebih dari 500 tabel, parameter ini secara default bernilai `false`.
tableMapping	JSONArray	Array yang berisi detail Pemetaan Tabel.
srcDatasourceName	String	Nama sumber data asal.
srcDatabaseName	String	Nama database asal.
srcTable	String	Nama tabel asal.
dstDatasourceName	String	Nama sumber data tujuan.
dstTable	String	Nama tabel tujuan.
tenantId	Long	ID penyewa.
eventCode	String	Kode untuk Event Ekstensi.

Node Change Event: Batch Start Jobs

Berikut adalah contoh format isi pesan (konten field data dalam pesan event) untuk Event Perubahan Node - Event Pembaruan batch Mulai Pekerjaan.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
        "needErrorMessage": false,
        "extensionBizId": "2de***c4c6",
        "extensionBizName": "sync_mysql_to_holo_20240911_170801,sync_mysql_to_odps_20240726_192307",
        "errorMessageOnlyFailedFileIds": false,
        "blockBusiness": true,
        "env": "prod",
        "operator": "15***516",
        "setting": {
            "startDateTime": "2024-09-12 14:00:00",
            "timeZone": "Asia/Shanghai"
        },
        "jobIds": [
            5777,
            5679
        ],
        "eventCode": "batch-start-diJob",
        "tableMappings": [
            {
                "extensionBizName": "sync_mysql_to_holo_20240911_170801",
                "id": 5777,
                "tableMapping": [
                    {
                        "srcTable": "test_verify1",
                        "dstDatasourceName": "molin_db",
                        "srcDatabaseName": "di_test",
                        "srcDatasourceName": "mysql_public",
                        "dstTable": "test_verify1"
                    },
                    {
                        "srcTable": "test_verify1_dst",
                        "dstDatasourceName": "molin_db",
                        "srcDatabaseName": "di_test",
                        "srcDatasourceName": "mysql_public",
                        "dstTable": "test_verify1_dst"
                    },
                    {
                        "srcTable": "mysql_0_timetest2",
                        "dstDatasourceName": "molin_db",
                        "srcDatabaseName": "di_test",
                        "srcDatasourceName": "mysql_public",
                        "dstTable": "mysql_0_timetest2"
                    }
                ]
            },
            {
                "extensionBizName": "sync_mysql_to_odps_20240726_192307",
                "id": 5679,
                "tableMapping": [
                    {
                        "srcTable": "xb_test_116",
                        "dstDatasourceName": "odps_first",
                        "srcDatabaseName": "xiaobo_sharding_79fz",
                        "srcDatasourceName": "mysql_3357_pub_ip_1",
                        "dstTable": "ods_xb_test_116"
                    },
                    {
                        "srcTable": "xb_test_117",
                        "dstDatasourceName": "odps_first",
                        "srcDatabaseName": "xiaobo_sharding_79fz",
                        "srcDatasourceName": "mysql_3357_pub_ip_1",
                        "dstTable": "ods_xb_test_117"
                    },
                    {
                        "srcTable": "xb_test_118",
                        "dstDatasourceName": "odps_first",
                        "srcDatabaseName": "xiaobo_sharding_79fz",
                        "srcDatasourceName": "mysql_3357_pub_ip_1",
                        "dstTable": "ods_xb_test_118"
                    },
                    {
                        "srcTable": "xb_test_135",
                        "dstDatasourceName": "odps_first",
                        "srcDatabaseName": "xiaobo_sharding_79fz",
                        "srcDatasourceName": "mysql_3357_pub_ip_1",
                        "dstTable": "ods_xb_test_135"
                    }
                ]
            }
        ],
        "appId": 293624,
        "showTableMapping": true,
        "tenantId": 52***018,
        "projectId": 9***4
    }
}

Tabel berikut menjelaskan field dalam muatan event.

Parameter	Tipe	Deskripsi
projectId	Long	ID Ruang Kerja DataWorks.
operator	String	UID pengguna yang memicu event.
extensionBizName	String	Nama solusi.
setting	JSONObject	Pengaturan startup untuk pekerjaan.
startDateTime	String	Waktu mulai terjadwal.
timeZone	String	Zona Waktu Startup
tableMappings	JSONArray	Array objek, masing-masing berisi detail Pemetaan Tabel untuk pekerjaan tertentu.
srcDatasourceName	String	Nama sumber data asal.
srcDatabaseName	String	Nama database asal.
srcTable	String	Nama tabel asal.
dstDatasourceName	String	Nama sumber data tujuan.
dstTable	String	Nama tabel tujuan.
showTableMapping	Boolean	Menentukan apakah detail Pemetaan Tabel dikembalikan. true: Detail dikembalikan. false: Detail tidak dikembalikan. Jika pekerjaan melibatkan lebih dari 500 tabel, parameter ini secara default bernilai `false`.
tenantId	Long	ID penyewa.
eventCode	String	Kode untuk Event Ekstensi.

Event pusat operasi

Daftar event

Penting

Mengubah grup sumber daya penjadwalan atau pemilik memicu event node-change-updated.

Jenis peristiwa	Event dan pemicu	Regular event	Extension point event	Tipe event EventBridge	Kode event ekstensi
Event Perubahan Node	Hapus Node Menerbitkan operasi hapus untuk mencabut penerapan Node dari Lingkungan Produksi. Menghapus Node dari Recycle Bin.			`dataworks:NodeChange:NodeChangeDeleted`	`node-change-deleted`
	Pre-event untuk pencabutan penerapan Node Mencabut penerapan Node terjadwal dari Lingkungan Produksi. Catatan Operasi ini juga menghapus Node dari DataStudio dan memindahkannya ke Recycle Bin.			`dataworks:NodeChange:UndeployNode`	`undeploy-node`
	Pre-event untuk pembekuan Node Penting Event ini juga memicu event `node-change-updated`.			`dataworks:NodeChange:FreezeNode`	`freeze-node`
	Pra-event untuk pembatalan pembekuan Node Penting Event ini juga memicu event `node-change-updated`.			`dataworks:NodeChange:UnfreezeNode`	`unfreeze-node`
Event Pengisian Ulang Data	Pre-event untuk Pengisian Ulang Data			`dataworks:BackfillDataOperate:BackfillData`	`backfill-data`
Perubahan Status Instance	Instance terjadwal mengalami perubahan status			`dataworks:InstanceStatusChanges:InstanceStatusChanges`	`instance-status-changes`
Event Perubahan Instance	Bekukan Instance			`dataworks:InstanceChange:FreezeInstance`	`freeze-instance`
	Batalkan pembekuan Instance			`dataworks:InstanceChange:UnfreezeInstance`	`unfreeze-instance`
	Hentikan Instance			`dataworks:InstanceChange:KillInstance`	`kill-instance`
	Jalankan ulang Instance Jalankan ulang Instance saat ini. Jalankan ulang Instance turunan.			`dataworks:InstanceChange:RerunInstance`	`rerun-instance`
	Atur status Instance menjadi Berhasil			`dataworks:InstanceChange:SetInstanceSuccess`	`set-instance-success`
	Hapus Dependensi Hulu yang ditentukan dari Instance			`dataworks:InstanceChange:DeleteTaskInstanceDependencies`	`delete-task-instance-dependencies`
	Pre-event untuk pembekuan Instance			`dataworks:InstanceChange:PreFreezeInstance`	`pre-freeze-instance`
	Pre-event untuk pembatalan pembekuan Instance			`dataworks:InstanceChange:PreUnfreezeInstance`	`pre-unfreeze-instance`
	Pre-event untuk menjalankan ulang Instance			`dataworks:InstanceChange:PreRerunInstance`	`pre-rerun-instance`
	Pre-event untuk mengatur status Instance menjadi Berhasil			`dataworks:InstanceChange:PreSetInstanceSuccess`	`pre-set-instance-success`
	Pre-event untuk menghentikan Instance			`dataworks:InstanceChange:PreKillInstance`	`pre-kill-instance`
	Hapus Instance yang kedaluwarsa			`dataworks:InstanceChange:ExpiredTaskInstancesDeleted`	`expired-task-instances-deleted`
Perubahan Status Alur Kerja	Status Alur Kerja berubah Mengisi ulang data Instance Menjalankan Alur Kerja yang dipicu secara manual			`dataworks:DagStatusChanges:DagStatusChanges`	`dag-status-changes`
Pemantauan dan Peringatan	Peringatan pemantauan terjadi.			`dataworks:MonitorAlert:WorkbenchMonitorAlert`	`workbench-monitor-alert`

Format pesan

Event perubahan node (hapus, cabut penerapan, bekukan, dan batalkan pembekuan)

Contoh isi pesan untuk event penghapusan node (konten field data dalam pesan event) adalah sebagai berikut.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "nodeName": "",
    "programType": "ODPS_SQL",
    "cronExpress": "00 20 00 * * ?",
    "schedulerType": "NORMAL",
    "ownerId": "19****735",
    "priority": 1,
    "baselineId": 117801853,
    "repeatability": true,
    "modifyTime": 1646364549642,
    "createTime": 1646364549642,
    "datasource": "odps_source",
    "tenantId": 28378****10656,
    "nodeId": 100***150,
    "projectId": 30**95,
    "operator": "19***735"  // UID operator.
  }
}

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
nodeName	String	Nama Node.
programType	String	Tipe kode Node. Untuk melihat tipe kode yang didukung, panggil API ListFileType atau lihat jenis node yang didukung.
cronExpress	String	Ekspresi cron yang menentukan kapan Node dijalankan. Parameter ini sesuai dengan untuk node DataStudio di konsol DataWorks. DataWorks secara otomatis menghasilkan ekspresi cron setelah Anda mengonfigurasi Siklus Penjadwalan dan Waktu Terjadwal. Contoh: Dijadwalkan untuk dijalankan pukul 5:30 pagi setiap hari: `00 30 05 * * ?` Dijadwalkan untuk dijalankan pada menit ke-15 setiap jam: `00 15 * * * ?` Jadwal setiap sepuluh menit: `00 00/10 * * * ?` Berjalan setiap 10 menit dari pukul 8:00 hingga 17:00 setiap hari: `00 00-59/10 8-17 * * * ?` Berjalan otomatis pukul 00:20 pada tanggal 1 setiap bulan: `00 20 00 1 * ?` Dimulai pukul 00:10 pada 1 Januari, berjalan sekali setiap 3 bulan: `00 10 00 1 1-12/3 ?` Dijadwalkan otomatis pukul 00:05 setiap hari Selasa dan Jumat: `00 05 00 * * 2,5` Catatan Batasan pada ekspresi cron: Interval penjadwalan minimum adalah 5 menit. Waktu penjadwalan paling awal setiap hari adalah pukul 00:05.
schedulerType	String	Tipe penjadwalan Node. Nilai yang valid: 0 (NORMAL): Node yang dijadwalkan secara normal. Penjadwal secara berkala menghasilkan dan menjalankan instance untuk Node. 1 (MANUAL): Node yang dipicu secara manual. Penjadwal tidak secara berkala menghasilkan instance untuk Node ini. 2 (PAUSE): Node yang dibekukan. Penjadwal menghasilkan instance dan langsung mengatur statusnya menjadi GAGAL. 3 (SKIP): Node simulasi kering. Penjadwal menghasilkan instance dan langsung mengatur statusnya menjadi BERHASIL. 4 (SKIP_UNCHOOSE): Node yang tidak dipilih untuk dieksekusi dalam alur kerja sementara. Penjadwal menghasilkan instance dan langsung mengatur statusnya menjadi BERHASIL. 5 (SKIP_CYCLE): Node mingguan atau bulanan yang waktu eksekusinya belum tiba dalam siklus saat ini. Penjadwal menghasilkan instance dan langsung mengatur statusnya menjadi BERHASIL. 6 (CONDITION_UNCHOOSE): Node yang kondisinya tidak terpenuhi di node cabang hulu (node IF). Penjadwal menghasilkan instance dan langsung mengatur statusnya menjadi BERHASIL. 7 (REALTIME_DEPRECATED): Node real-time yang menghasilkan Instans tersebut telah kedaluwarsa. Penjadwal menetapkan status Instans menjadi SUCCEEDED.
ownerId	String	ID akun Alibaba Cloud pemilik Node. Jika kosong, nilai default-nya adalah ID akun Alibaba Cloud pemanggil.
priority	Integer	Prioritas instance. Nilai yang valid adalah 1, 3, 5, 7, dan 8. Nilai yang lebih tinggi menunjukkan prioritas yang lebih tinggi.
baselineId	Long	ID garis dasar.
repeatability	Boolean	Menunjukkan apakah Node dapat dijalankan ulang. Nilai yang valid: true: Node dapat dijalankan ulang. false: Node tidak dapat dijalankan ulang.
modifyTime	Long	Waktu terakhir Node dimodifikasi, dalam milidetik sejak epoch Unix.
createTime	Long	Waktu Node dibuat, dalam milidetik sejak epoch Unix.
nodeId	Long	ID Node.
projectId	Long	ID ruang kerja tempat Node berada.
tenantId	Long	ID Penyewa tempat Node tersebut berada.
operator	String	UID pengguna yang membuat, memodifikasi, atau menghapus Node.

Contoh berikut menunjukkan format isi pesan (konten field data dalam pesan event) untuk event pembekuan, pembatalan pembekuan, dan pencabutan penerapan node.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "operator": "19***735",
    "projectId": 12***56,
    "tenantId": 28***656,
    "nodeIds":[1,2,3],
    "extensionBizId": "12***56"
  }
}

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
operator	String	UID pengguna yang melakukan operasi pembekuan, pembatalan pembekuan, atau pencabutan penerapan.
projectId	Long	ID ruang kerja tempat Node berada.
tenantId	Long	ID Penyewa.
nodeIds	Array	Array ID Node yang terpengaruh oleh operasi.
extensionBizId	String	ID proses bisnis untuk alur kerja pembatasan ekstensi.

Pengisian ulang data

JSON berikut menunjukkan contoh pesan untuk event Pengisian Ulang Data. Parameter yang dijelaskan dalam tabel di bawah ini bersarang dalam objek data.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "excludeNodeIds":[],
    "rootNodeId": 1000****271,
    "startFutureInstanceImmediately": false,
    "useMultipleTimePeriods": true,
    "operator": "19***735",
    "eventCode": "backfill-data",
    "multipleTimePeriods": "[{\"bizBeginTime\":\"2022-04-17\",\"bizEndTime\":\"2022-04-17\"}]",
    "parallelGroup": 1,
    "rootNodeProjectId": 12*****8,
    "isParallel": false,
    "name": "P_fff_20220418_215404",
    "tenantId": 16935*****3377,
    "includeNodeIds":
    [
      10***271
    ],
    "projectId": 9***4,
    "order": "asc",
    "extensionBizId": "12***56"
  }
}

Tabel berikut menjelaskan field-field tersebut.

Parameter	Tipe	Deskripsi
name	String	Nama Alur Kerja Pengisian Ulang Data.
rootNodeId	Long	ID Node root dari Alur Kerja Pengisian Ulang Data.
rootNodeProjectId	Long	ID Ruang Kerja yang berisi Node root dari Alur Kerja Pengisian Ulang Data.
includeNodeIds	Array	Array ID Node yang disertakan dalam proses Pengisian Ulang Data.
excludeNodeIds	Array	Array ID Node yang dikecualikan dari operasi Pengisian Ulang Data. Sistem menghasilkan Instance Simulasi Kering untuk setiap Node yang dikecualikan. Instance ini langsung ditandai sebagai Berhasil setelah penjadwalan dan tidak menjalankan skripnya.
bizBeginTime	String	Waktu mulai tugas. Parameter ini hanya diperlukan untuk tugas yang dijadwalkan per jam. Format: `HH:mm:ss`. Nilai yang valid: 00:00:00 hingga 23:59:59.
bizEndTime	String	Waktu akhir tugas. Parameter ini hanya diperlukan untuk tugas yang dijadwalkan per jam. Format: `HH:mm:ss`. Nilai yang valid: 00:00:00 hingga 23:59:59.
isParallel	Boolean	Menentukan apakah instance Pengisian Ulang Data untuk Timestamp Data yang berbeda dapat berjalan secara paralel. true: Instance berjalan secara paralel. false: Instance berjalan secara berurutan.
parallelGroup	Integer	Jumlah grup untuk eksekusi paralel. Nilai 1 menunjukkan bahwa instance tidak dibagi menjadi grup.
startFutureInstanceImmediately	Boolean	Menentukan apakah melewati Waktu Terjadwal dan menjalankan instance bertanggal masa depan segera. true: Melewati Waktu Terjadwal dan menjalankan instance bertanggal masa depan segera. false: Menunggu Waktu Terjadwal sebelum menjalankan instance bertanggal masa depan.
order	String	Menentukan urutan eksekusi instance berdasarkan Timestamp Datanya. asc: Menjalankan instance dalam urutan kronologis (ascending) berdasarkan Timestamp Datanya. desc: Menjalankan instance dalam urutan terbalik-kronologis (descending) berdasarkan Timestamp Datanya.
multipleTimePeriods	String	String JSON yang menentukan beberapa periode waktu non-kontinyu untuk Timestamp Data. Contoh: `[{\"bizBeginTime\":\"2022-04-17\",\"bizEndTime\":\"2022-04-17\"}]`.
tenantId	Long	ID Penyewa.
projectId	Long	ID Ruang Kerja tempat operasi Pengisian Ulang Data dilakukan.
operator	String	ID Pengguna operator.
extensionBizId	String	ID proses pemeriksaan dalam ekstensi.
eventCode	String	Kode Event titik ekstensi.

Event perubahan status node

Contoh berikut menunjukkan muatan event untuk event perubahan status node. Muatan tersebut adalah nilai field data.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "beginWaitTimeTime": 1652700576000,
    "dagId": 446***330,
    "dagType": 0,
    "eventCode": "instance-status-changes",
    "taskType": 0,
    "modifyTime": 1652700577000,
    "createTime": 1652543233000,
    "appId": 3*****2,
    "tenantId": 235454***432001,
    "opCode": 31,
    "flowId": 1,
    "nodeId": 100***219,
    "beginWaitResTime": 1652700577000,
    "taskId": 453***169,
    "status": 3
  }
}

Tabel berikut menjelaskan field dalam contoh di atas.

Parameter	Tipe	Deskripsi
finishTime	Long	Timestamp yang menunjukkan kapan Instance Node selesai berjalan.
beginWaitTimeTime	Long	Timestamp yang menunjukkan kapan Instance Node mulai menunggu untuk dijalankan.
beginRunningTime	Long	Timestamp yang menunjukkan kapan Instance Node mulai berjalan.
dagId	Long	Anda dapat menggunakan `DagId` untuk mendapatkan detail DAG.
dagType	Integer	Jenis DAG. Nilai yang valid: 0: Node yang Dipicu Otomatis 1: Node yang Dipicu Secara Manual 2: Smoke Testing 3: Pengisian Ulang Data 4: Alur Kerja Sementara 5: Alur Kerja yang Dipicu Secara Manual
taskType	Integer	Jenis Node. Nilai yang valid: 0: NORMAL. Node yang dipicu otomatis dan berjalan sesuai jadwal rutin. 1: MANUAL. Node yang dipicu secara manual dan tidak berjalan sesuai jadwal rutin. 2: PAUSE. Node yang Dibekukan. Diatur secara rutin, tetapi statusnya diatur ke Gagal saat dijalankan. 3: SKIP. Node Simulasi Kering. Diatur secara rutin, tetapi statusnya diatur ke Berhasil saat dijalankan. 4: SKIP_UNCHOOSE. Node yang tidak dipilih dalam Alur Kerja Sementara. Jenis ini hanya ada dalam Alur Kerja Sementara. Statusnya diatur ke Berhasil saat dieksekusi. 5: SKIP_CYCLE. Node mingguan atau bulanan yang waktu eksekusinya belum tiba. Diatur secara rutin, tetapi statusnya diatur ke Berhasil saat dieksekusi. 6: CONDITION_UNCHOOSE. Node yang tidak dipilih oleh Node Cabang Hulu. Statusnya diatur ke Berhasil. 7: REALTIME_DEPRECATED. Instance periodik real-time yang telah kedaluwarsa. Statusnya diatur ke Berhasil.
modifyTime	Long	Timestamp yang menunjukkan kapan Instance Node terakhir dimodifikasi.
createTime	Long	Timestamp yang menunjukkan kapan Instance Node dibuat.
appId	Long	ID Ruang Kerja. Untuk menemukan ID ini, panggil operasi ListProjects.
tenantId	Long	ID Penyewa yang memiliki Ruang Kerja yang berisi Instance Node.
opCode	Integer	Kode operasi untuk Instance Node. Anda dapat mengabaikan field ini.
flowId	Long	ID Alur Kerja. Untuk Instance Node yang dipicu otomatis, ID Alur Kerja default adalah 1. Untuk Instance dalam Alur Kerja yang dipicu secara manual atau Alur Kerja internal, field ini menunjukkan ID Alur Kerja yang sebenarnya.
nodeId	Long	ID Node induk dari Instance.
beginWaitResTime	Long	Timestamp yang menunjukkan kapan Instance Node mulai menunggu sumber daya.
taskId	Long	ID Instance Node.
status	Integer	Status Instance Node. Nilai yang valid: 1: Belum dijalankan 2: Menunggu waktu terjadwal yang ditentukan oleh dueTime atau cycleTime. 3: Menunggu sumber daya 4: Sedang berjalan 7: Dikirim untuk Validasi Data 8: Memeriksa Kondisi Cabang 5: Gagal 6: Berhasil
eventCode	String	Kode untuk event titik ekstensi.

Event perubahan instance

Contoh JSON berikut menunjukkan muatan untuk event perubahan instance. Muatan ini adalah nilai field data.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "eventCode": "freeze-instance",
    "operator": "19***735",
    "projectId": 12***8,
    "projectType": "PROD",
    "taskIds": [
      523***9736
    ],
    "tenantId": 28***656
  }
}

Tabel berikut menjelaskan properti dalam muatan.

Parameter	Tipe	Deskripsi
operator	String	UID Pengguna yang melakukan Operasi pada Instance, seperti Bekukan, Batalkan Pembekuan, Hentikan, Jalankan Ulang, atau atur ke Berhasil.
projectType	String	Lingkungan Waktu Proses. Nilai yang valid: PROD: Lingkungan Produksi. DEV: Lingkungan Pengembangan.
taskIds	List<Long>	Daftar ID Instance.
projectId	Long	ID Ruang Kerja DataWorks.
tenantId	Long	ID Penyewa yang mengelola Ruang Kerja yang berisi Instance.
eventCode	String	Kode Event yang mengidentifikasi Operasi spesifik.

Pre-event perubahan instance

Berikut adalah contoh format isi pesan untuk pre-event perubahan instance. Isi pesan adalah konten field data dalam pesan event.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "eventCode": "pre-freeze-instance",
    "extensionBizId": "055***afaa",
    "extensionBizName": "Nama Node",
    "projectId": 9***4,
    "taskIds": [
      523536569736
    ],
    "tenantId": 28***656,
    "operator": "19***735"
  }
}

Tabel berikut menjelaskan field dalam muatan data.

Parameter	Tipe	Deskripsi
extensionBizId	String	ID proses checkpoint ekstensi.
extensionBizName	String	Nama objek target, seperti Node. Jika operasi menargetkan beberapa objek, field ini mungkin menampilkan nama representatif diikuti elipsis (...).
projectId	Long	ID Ruang Kerja DataWorks.
taskIds	List<Long>	ID instance yang terpengaruh.
tenantId	String	ID Penyewa dari Ruang Kerja instance.
operator	Long	UID pengguna yang memulai operasi.
eventCode	String	Kode Event untuk titik ekstensi.

Event perubahan instance: Menghapus instance yang kedaluwarsa

Contoh berikut menunjukkan isi pesan untuk event penghapusan instance yang kedaluwarsa, yaitu konten field data dalam pesan event.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
        "eventCode": "expired-task-instances-deleted",
        "deletedTaskInstanceIds": [
            524***035,
            524***498,
            524***637
        ],
        "appId": 307303,
        "tenantId": 28***656,
        "blockBusiness": false,
        "owner": "1107***538",
        "operationTime": 1734505954897
    }
}

Tabel berikut menjelaskan field dalam objek data.

Parameter	Tipe	Deskripsi
deletedTaskInstanceIds	List	Daftar ID instance yang dihapus.
owner	String	ID pengguna pemilik instance.
operationTime	Long	Waktu operasi, direpresentasikan sebagai timestamp epoch Unix dalam milidetik.
blockBusiness	Boolean	Menunjukkan apakah menghentikan alur jika ekstensi ada. true: Menghentikan alur. false: Mengizinkan alur untuk melanjutkan.
appId	Long	ID ruang kerja DataWorks.
tenantId	String	ID penyewa ruang kerja yang berisi instance.
operator	Long	UID pengguna operator.
eventCode	String	Kode event yang mengidentifikasi titik ekstensi.

Hapus dependensi hulu

Contoh berikut menunjukkan field data untuk event yang menghapus dependensi hulu dari instance tugas.

{
    "datacontenttype": "application/json;charset=utf-8",
    "aliyunaccountid": "110******38",
    "aliyunpublishtime": "2024-12-18T07:12:35.463Z",
    "data": {
        "eventCode": "delete-task-instance-dependencies",
        "upstreamTaskInstanceIds": [
            52******35,
            52******98,
            52******37
        ],
        "appId": 3***03,
        "tenantId": 52******36,
        "blockBusiness": false,
        "taskInstanceId": 52******49,
        "operator": "19***735",
        "operationTime": 1734505954897
    }
}

Tabel berikut menjelaskan field-field tersebut.

Parameter	Tipe	Deskripsi
taskInstanceId	Long	ID instance turunan.
upstreamTaskInstanceIds	List	ID dependensi hulu yang akan dihapus.
operator	String	UID operator.
operationTime	Long	Timestamp operasi.

Event perubahan status alur kerja

Berikut adalah contoh format isi pesan untuk event perubahan status alur kerja. Isi pesan adalah konten field data dalam pesan event.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "bizDate": "2022-11-07 00:00:00",
    "createTime": "2022-11-08 10:56:32",
    "dagId": 500358972116,
    "dagName": "P_test_spark_true_copy_20221108_105631",
    "eventCode": "dag-status-changes",
    "dagType": 3,
    "flowId": 1,
    "flowName": "ATCLOUD_FLOW",
    "operator": "11****538",
    "projectEnv": "PROD",
    "projectId": 25***63,
    "status": 6,
    "tenantId": 52***736
  }
}

Tabel ini menjelaskan setiap field dalam muatan event.

Parameter	Tipe	Deskripsi
bizDate	String	Tanggal bisnis alur kerja. Formatnya adalah `yyyy-mm-dd hh24:mi:ss`.
createTime	String	Waktu pembuatan alur kerja. Formatnya adalah `yyyy-mm-dd hh24:mi:ss`.
dagId	Long	ID unik Alur Kerja. Gunakan ID ini untuk mengambil detail Alur Kerja.
dagName	String	Nama Alur Kerja.
dagType	Integer	Jenis Alur Kerja. Nilai yang valid: 0: Tugas Terjadwal 1: Tugas Manual 2: Pengujian Asap 3: Pengisian Ulang Data 4: Alur Kerja Sementara 5: Alur Kerja yang Dipicu Secara Manual
flowId	Integer	ID Proses Bisnis yang terkait dengan Alur Kerja.
flowName	String	Nama Proses Bisnis yang terkait dengan Alur Kerja.
operator	String	UID pengguna yang membuat Alur Kerja.
projectEnv	String	Lingkungan tempat Alur Kerja dijalankan. Nilai yang valid: DEV: Lingkungan Pengembangan PROD: Lingkungan Produksi
tenantId	Long	ID penyewa ruang kerja.
projectId	Long	ID Ruang Kerja.
status	Integer	Status Alur Kerja. Nilai yang valid: 1: Belum dijalankan 4: Sedang berjalan 5: Gagal 6: Berhasil
eventCode	String	Kode event ekstensi.

Pemantauan dan peringatan

Berikut adalah contoh isi pesan untuk Peringatan Garis Dasar (konten field data).

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "eventCode": "workbench-monitor-alert",
    "alarmType": "SLA_ALERT",
    "baselineId": 137***723,
    "baselineName": "ods layer check task dedicated -- hourly",
    "baselineStatus": 3,
    "bizDate": 1654444800000,
    "inGroupId": 14,
    "nodeId": 1000***8734,
    "projectId": 76***34,
    "taskId": 307***3778,
    "tenantId": 28***656
  }
}

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
alarmType	String	Jenis Alarm. Nilai yang valid: SLA_ALERT REMIND_ALERT TOPIC_ALERT
baselineId	Long	ID Garis Dasar.
baselineName	String	Nama Garis Dasar.
baselineStatus	Integer	Status Garis Dasar. Nilai yang valid: -1: Error 1: Aman 2: Peringatan 3: Dilanggar
bizDate	Long	Tanggal Bisnis, sebagai timestamp Unix.
inGroupId	Integer	Nomor siklus instance garis dasar. Nilainya adalah `1` untuk garis dasar harian, dan rentang nilainya adalah `[1,24]` untuk garis dasar per jam.
nodeId	Long	ID Node yang memicu Peringatan Garis Dasar.
projectId	Long	ID Ruang Kerja tempat Garis Dasar berada.
taskId	Long	ID Instance yang memicu Peringatan Garis Dasar.
tenantId	Long	ID Penyewa.
eventCode	String	Kode unik untuk Event ekstensi.

Contoh format isi pesan untuk peringatan event (yaitu konten field data dalam pesan) adalah sebagai berikut.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "alarmType": "TOPIC_ALERT",
    "nodeId": 1000***315,
    "projectId": 91***09,
    "taskId": 307***0357,
    "taskStatus": 5,
    "tenantId": 28***656,
    "topicId": 1084769
  }
}

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
alarmType	String	Jenis Alarm. Nilai yang valid: SLA_ALERT REMIND_ALERT TOPIC_ALERT
topicId	Long	ID Event.
taskStatus	String	Status Instance Node yang memicu Event.
nodeId	Integer	ID Node yang memicu Event.
projectId	Long	ID Ruang Kerja tempat Node pemicu berada.
taskId	Long	ID Instance Node yang memicu Event.
tenantId	Long	ID Penyewa.

Contoh berikut menunjukkan format isi pesan (konten field data) untuk peringatan berbasis aturan tugas.

Catatan

Aturan dapat diterapkan pada objek seperti Node, Garis Dasar, Ruang Kerja, dan Alur Kerja.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "alarmType": "REMIND_ALERT",
    "nodeIds": "1000***5472,1000***5473,1000***5474",
    "projectId": 9***4,
    "remindId": 7605,
    "remindName": "Error alert",
    "remindType": "ERROR",
    "remindUnit": "NODE",
    "taskIds": "307***0896,307***0870,307***0855",
    "tenantId": 28***656
  }
}

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
alarmType	String	Jenis Alarm. Nilai yang valid: SLA_ALERT REMIND_ALERT TOPIC_ALERT
nodeIds	String	Daftar ID Node yang dipisahkan koma yang memicu peringatan.
remindId	Long	ID aturan.
remindType	String	Kondisi Pemicu untuk aturan. Nilai yang valid: FINISHED: Eksekusi selesai. UNFINISHED: Eksekusi belum selesai. ERROR: Eksekusi gagal. CYCLE_UNFINISHED: Eksekusi belum selesai dalam siklus penjadwalan. TIMEOUT: Eksekusi melebihi waktu.
projectId	Long	ID Ruang Kerja tempat Node pemicu berada.
remindUnit	String	Jenis objek yang memicu aturan. Nilai yang valid: NODE: Node. GATEWAY_RES: Grup Sumber Daya Eksklusif untuk Penjadwalan. DI_RES: Grup Sumber Daya untuk Integrasi Data.
tenantId	Long	ID Penyewa.
taskIds	String	Daftar ID Instance yang dipisahkan koma yang memicu peringatan.
remindName	String	Nama aturan.

Berikut adalah contoh format isi pesan untuk peringatan berbasis aturan untuk grup sumber daya. Isi pesan adalah konten field data dalam pesan.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "alarmType": "REMIND_ALERT",
    "projectId": 9***4,
    "remindId": 200***186,
    "remindName": "Exclusive resource group alert",
    "remindType": "RES_GROUP_THRESHOLD",
    "remindUnit": "GATEWAY_RES",
    "resourceGroupIdentifier": "S_res_group_195820716552192_1650965857744",
    "resourceGroupName": "emr_exclusive_scheduld",
    "resourceGroupType": "GATEWAY",
    "tenantId": 28***656
  }
}

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
alarmType	String	Jenis Alarm. Nilai yang valid: SLA_ALERT REMIND_ALERT TOPIC_ALERT
remindId	Long	ID aturan.
remindType	String	Kondisi Pemicu untuk aturan. Nilai yang valid: FINISHED: Eksekusi selesai. UNFINISHED: Eksekusi belum selesai. ERROR: Eksekusi gagal. CYCLE_UNFINISHED: Eksekusi belum selesai dalam siklus penjadwalan. TIMEOUT: Eksekusi melebihi waktu. RES_GROUP_THRESHOLD: Utilisasi sumber daya Grup Sumber Daya mencapai ambang batas yang ditentukan. RES_GROUP_WAIT_AMOUNT: Jumlah Instance yang menunggu sumber daya dalam Grup Sumber Daya mencapai ambang batas yang ditentukan.
projectId	Long	ID Ruang Kerja tempat Grup Sumber Daya berada.
remindUnit	String	Jenis objek yang memicu aturan. Nilai yang valid: NODE: Node. GATEWAY_RES: Grup Sumber Daya Eksklusif untuk Penjadwalan. DI_RES: Grup Sumber Daya untuk Integrasi Data.
tenantId	Long	ID Penyewa.
remindName	String	Nama aturan.
resourceGroupIdentifier	String	Identifikasi Unik Grup Sumber Daya.
resourceGroupName	String	Nama Grup Sumber Daya.
resourceGroupType	String	Jenis Grup Sumber Daya. Nilai yang valid: GATEWAY: Grup Sumber Daya untuk Penjadwalan. DI: Grup Sumber Daya untuk Integrasi Data.

Event Pusat Keamanan

Daftar event

Jenis peristiwa	Event dan operasi sumber	Regular event	Extension point event	Tipe event di EventBridge	Kode event di ekstensi (eventCode)
Pusat Persetujuan	Pembuatan Permintaan Izin			`dataworks:ApprovalChange:ApprovalChangeCreated`	`approval-change-created`
Pusat Persetujuan	Penyelesaian Permintaan Izin			`dataworks:ApprovalChange:ApprovalChangeFinished`	`approval-change-finished`
Pusat Keamanan (Permintaan Izin Tabel)	Permintaan Izin Tabel (Sebelum Pembuatan)			`dataworks:ApprovalChange:ApprovalChangeBeforeCreate`	`approval-change-before-create`

Format pesan

Pusat persetujuan

Contoh format isi pesan untuk pre-event pembuatan permintaan izin (yaitu konten field data dalam pesan event) adalah sebagai berikut.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "appId":194209,
    "assignee":"286098539641742899",
    "assigneeName":"yupeng.sunyp",
    "createTime":1652094363000,
    "eventType":"approval",
    "process":{
      "applicant":"286098539641742899",
      "applicantName":"yupeng.sunyp",
      "approvalContent":{
        "applyPeriod":"2997964800000",
        "applyReason":"Test",
        "arrayData":[
          {
            "ownerBaseId":"1822***45",
            "objectType":"TABLE",
            "odpsTable":"loghub_070103",
            "envType":1,
            "projectGuid":"odps.b_mc1",
            "objectGuid":"odps.b_mc1.loghub_070103",
            "tenantId":28***656,
            "objectName":"loghub_070103",
            "ownerAccountName":"ALIYUN$******(******)",
            "odpsProject":"B_MC1",
            "projectName":"B_MC1",
            "actions":[
              "Select",
              "Describe"
            ],
            "projectId":9***4,
            "workspaceId":"9***4"
          }
        ],
        "contentType":"application/json",
        "granteeAccounts":[
          {
            "granteeId":"2860985***99",
            "granteeTypeSub":103,
            "granteeType":1,
            "granteeName":"RAM$dataworks_3h1_1:yupeng.sunyp"
          },
          {
            "granteeId":"237857631119109360",
            "granteeTypeSub":105,
            "granteeType":1,
            "granteeName":"RAM$dataworks_3h1_1:dev"
          }
        ],
        "odpsProjectName":"B_MC1",
        "projectEnv":"1",
        "resourceSummary":"loghub_070103",
        "tenantId":28***656,
        "workspaceId":194209
      },
      "assignmentCategory":"MaxCompute",
      "createTime":1652094363000,
      "processDefinitionId":"definition-3dcc9ce7-d29d-435d-a908-60d4355ff5e2",
      "processId":"528535869984706",
      "status":"Pending",
      "title":"MaxComputeTable",
      "updateTime":1652094363000
    },
    "processId":"528535869984706",
    "status":"Submit",
    "eventCode": "approval-change-created",
    "taskId":"528535870015424",
    "tenantId":28***656,
    "updateTime":1652094364000
  }
}{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "appId":227859,
    "assignee":"286098539641742899",
    "eventCode": "approval-change-finished",
    "assigneeName":"******.******",
    "comments":"ces",
    "createTime":1652095981000,
    "eventType":"approval",
    "process":{
        "applicant":"286098***2899",
        "applicantName":"yupeng.sunyp",
        "approvalContent":{
            "applyPeriod":"2997964800000",
            "applyReason":"Test",
            "arrayData":[
                {
                    "ownerBaseId":"2382***884", 
                    "objectType":"TABLE",
                    "odpsTable":"cdd",
                    "objectNameCn":"******",
                    "envType":1,
                    "projectGuid":"odps.da_simple_202112",
                    "objectGuid":"odps.da_simple_202112.cdd",
                    "tenantId":0,
                    "objectName":"cdd",
                    "ownerAccountName":"RAM$******(******)",
                    "odpsProject":"da_simple_202112",
                    "projectName":"da_simple_202112",
                    "actions":[
                        "Select",
                        "Describe"
                    ],
                    "projectId":9***4,
                    "workspaceId":"9***4"
                }
            ],
            "contentType":"application/json",
            "granteeAccounts":[
                {
                    "granteeId":"286***899",
                    "granteeTypeSub":103,
                    "granteeType":1,
                    "granteeName":"RAM$dataworks_3h1_1:yupeng.sunyp"
                }
            ],
            "odpsProjectName":"da_simple_202112",
            "projectEnv":"1",
            "resourceSummary":"cdd",
            "tenantId":28***656,
            "workspaceId":227859
        },
        "assignmentCategory":"MaxCompute",
        "createTime":1652095981000,
        "processDefinitionId":"definition-6e6418e6-c65f-4f26-a673-88576b1c1e4a",
        "processId":"528***192",
        "status":"Pending",
        "title":"MaxComputeTable",
        "updateTime":1652095981000
    }

Tabel berikut menjelaskan field-field tersebut.

Parameter	Tipe	Deskripsi
appId	Long	ID Ruang Kerja.
assignee	String	ID pengguna Pemberi Persetujuan.
assigneeName	String	Nama Pemberi Persetujuan.
comments	String	Komentar pada Permintaan Persetujuan.
createTime	Long	Timestamp saat Permintaan Persetujuan dibuat, dalam milidetik.
processId	String	ID Alur Kerja.
status	String	Status transisi event, seperti Submit.
taskId	String	ID tugas persetujuan.
tenantId	String	ID Penyewa.
updateTime	Long	Timestamp saat event terakhir diperbarui, dalam milidetik.
eventType	String	Jenis event.
process	Object	Objek Alur Kerja.
applicant	String	ID pengguna Pemohon.
applicantName	String	Nama Pemohon.
assignmentCategory	String	Kategori konten Permintaan Persetujuan, seperti `MaxCompute`.
createTime	Long	Timestamp saat Permintaan Persetujuan dibuat, dalam milidetik.
processDefinitionId	String	ID definisi Alur Kerja.
processId	String	ID Alur Kerja.
status	String	Status saat ini dari Alur Kerja, seperti Pending.
title	String	Judul Alur Kerja.
updateTime	Long	Timestamp saat Alur Kerja terakhir diperbarui, dalam milidetik.
approvalContent	Object	Objek yang berisi detail Permintaan Persetujuan.
applyPeriod	String	Waktu kedaluwarsa untuk izin yang diminta, ditentukan sebagai Timestamp dalam milidetik.
applyReason	String	Alasan Permintaan Persetujuan.
contentType	String	Jenis konten persetujuan.
odpsProjectName	String	Nama Proyek MaxCompute.
resourceSummary	String	Ringkasan Sumber Daya.
tenantId	Long	ID Penyewa.
workspaceId	Long	ID Ruang Kerja.
projectEnv	String	Lingkungan Proyek yang disetujui.
granteeAccounts	Array	Array objek Penerima.
.granteeId	String	ID Penerima.
granteeType	Integer	Jenis Penerima.
granteeTypeSub	Integer	Subjenis Penerima.
granteeName	String	Nama Penerima. Untuk pengguna Resource Access Management (RAM), namanya diformat seperti `RAM$dataworks_3h1_1:yupeng.sunyp`.
arrayData	Array	Array objek yang menjelaskan izin yang diminta. Untuk informasi selengkapnya, lihat Referensi pengembang: Daftar event dan format pesan.
eventType	String	Jenis event.

Contoh berikut menunjukkan format isi pesan untuk event penyelesaian permintaan persetujuan. Isi pesan adalah konten field data dalam pesan event.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "appId": 227859,
    "assignee": "286098539641742899",
    "eventCode": "approval-change-finished",
    "assigneeName": "******.******",
    "comments": "ces",
    "createTime": 1652095981000,
    "eventType": "approval",
    "process": {
      "applicant": "2860****899",
      "applicantName": "yupeng.sunyp",
      "approvalContent": {
        "applyPeriod": "2997***0000",
        "applyReason": "Test",
        "arrayData": [
          {
            "ownerBaseId": "2382***8*884",
            "objectType": "TABLE",
            "odpsTable": "cdd",
            "objectNameCn": "******",
            "envType": 1,
            "projectGuid": "odps.da_simple_202112",
            "objectGuid": "odps.da_simple_202112.cdd",
            "tenantId": 0,
            "objectName": "cdd",
            "ownerAccountName": "RAM$******(******)",
            "odpsProject": "da_simple_202112",
            "projectName": "da_simple_202112",
            "actions": [
              "Select",
              "Describe"
            ],
            "projectId": 9***4,
            "workspaceId": "9***4"
          }
        ],
        "contentType": "application/json",
        "granteeAccounts": [
          {
            "granteeId": "286***899",
            "granteeTypeSub": 103,
            "granteeType": 1,
            "granteeName": "RAM$dataworks_3h1_1:yupeng.sunyp"
          }
        ],
        "odpsProjectName": "da_simple_202112",
        "projectEnv": "1",
        "resourceSummary": "cdd",
        "tenantId": 28***656,
        "workspaceId": 227859
      },
      "assignmentCategory": "MaxCompute",
      "createTime": 1652095981000,
      "processDefinitionId": "definition-6e6418e6-c65f-4f26-a673-88576b1c1e4a",
      "processId": "528***192",
      "status": "Pending",
      "title": "MaxComputeTable",
      "updateTime": 1652095981000
    }
  }
}

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
appId	Long	ID ruang kerja.
assignee	String	Base ID penerima tugas.
assigneeName	String	Nama penerima tugas.
comments	String	Komentar untuk Permintaan Persetujuan.
createTime	Long	Timestamp, dalam milidetik, saat Permintaan Persetujuan dibuat.
processId	String	ID Permintaan Persetujuan.
status	String	Status Permintaan Persetujuan.
taskId	String	ID tugas persetujuan.
tenantId	String	ID penyewa.
updateTime	String	Timestamp, dalam milidetik, saat Permintaan Persetujuan terakhir diperbarui.
eventType	String	Jenis event.
process	Object	Detail proses persetujuan.
applicant	String	Base ID pemohon.
applicantName	String	Nama pemohon.
assignmentCategory	String	Kategori persetujuan, seperti MaxCompute.
createTime	Long	Timestamp, dalam milidetik, saat Workflow dibuat.
processDefinitionId	String	ID definisi Workflow.
processId	String	ID instance Workflow.
status	String	Status Workflow.
title	String	Judul Workflow.
updateTime	Long	Timestamp, dalam milidetik, saat Workflow terakhir diperbarui.
approvalContent	Object	Objek yang berisi detail permintaan.
applyPeriod	String	Periode validitas yang diminta untuk izin.
applyReason	String	Alasan permintaan.
contentType	String	Jenis Konten data.
odpsProjectName	String	Nama proyek MaxCompute.
resourceSummary	String	Ringkasan sumber daya.
tenantId	Long	ID penyewa.
workspaceId	Long	ID ruang kerja.
projectEnv	String	Lingkungan proyek.
granteeAccounts	Array	Array objek yang merepresentasikan Penerima.
granteeId	String	ID Penerima.
granteeType	String	Jenis Penerima.
granteeTypeSub	String	Subjenis Penerima, yang menentukan jenis akun. Nilai yang valid meliputi: ACCOUNT_PRD(101): Akun Alibaba Cloud yang digunakan untuk penjadwalan produksi. ACCOUNT_APP(102): Akun Alibaba Cloud untuk aplikasi. ACCOUNT_USER(103): Akun Alibaba Cloud pribadi. ACCOUNT_DEPT(104): Akun Alibaba Cloud departemen. ACCOUNT_MOCK(106): Akun tiruan. ACCOUNT_OTHER_USER(105): Akun Alibaba Cloud pengguna lain.
granteeName	String	Nama Penerima.
arrayData	Array	Array objek yang merepresentasikan sumber daya yang akan diotorisasi. Untuk informasi selengkapnya, lihat Referensi Pengembang: Daftar Event dan Format Pesan.
eventType	String	Jenis event.

Pusat keamanan (Pre-event permintaan izin tabel)

Berikut adalah contoh format isi pesan untuk pre-event permintaan izin tabel, yaitu konten field data dalam pesan event.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "eventType": "approval-create-before",
    "operator":"19***735",
    "order":{
      "applyReason":"Test",
      "deadlineDate":"1",
      "deadlineType":"month",
      "granteeObjectList":[
        {
          "granteeId":"1239****8872"
        }
      ],
      "projectMeta":{
        "envCode":1,
        "labelSecurity":false,
        "objectMetaList":[
          {
            "action":[
              "Select",
              "Describe"
            ],
            "name":"tablei",
            "projectGuid":"odps.d11aa"
          }
        ],
        "projectId":2****0,
        "projectName":"d11aa"
      }
    },
    "projectId":2****0,
    "tenantId":5564****6465
  }
}

Tabel berikut menjelaskan field dalam objek data.

Parameter	Type	Deskripsi
operator	String	UID Pengguna pihak yang berwenang yang menginisiasi permintaan izin.
projectId	Long	ID Ruang Kerja tempat Tindakan diinisiasi.
tenantId	Long	ID Penyewa tempat Tindakan diinisiasi.
order	Object	Objek yang berisi detail permintaan izin.
applyReason	String	Alasan permintaan izin.
deadlineDate	String	Durasi periode validitas.
deadlineType	String	Unit waktu untuk periode validitas. Misalnya, `Day` dan `Month`.
granteeObjectList	Array	Daftar penerima izin.
granteeId	String	Identifikasi unik penerima, yaitu ID Pengguna RAM.
projectMeta	Object	Objek yang berisi metadata tentang Ruang Kerja.
envCode	Integer	Identifikasi untuk lingkungan Ruang Kerja. Nilai yang valid adalah:
labelSecurity	Boolean	Menunjukkan apakah kontrol akses berbasis label diaktifkan. `true`: Diaktifkan. `false`: Dinonaktifkan.
objectMetaList	Array	Daftar objek yang mendefinisikan sumber daya target dan Tindakan yang akan diotorisasi untuknya.
action	Array	Daftar Tindakan untuk diberikan pada sumber daya. Misalnya, `Select` dan `Describe`.
name	String	Nama tabel tempat izin diminta.
projectGuid	String	GUID (Globally Unique Identifier) dari Ruang Kerja tempat tabel tersebut berada.
projectName	String	Nama Ruang Kerja tempat tabel tersebut berada.
eventType	String	Jenis event.

Data otorisasi MaxCompute

Ketika permintaan persetujuan atau permintaan izin tabel di DataWorks memicu event di Pusat Keamanan, pesan yang dikirim ke EventBridge berisi field arrayData. Jika assignmentCategory bernilai MaxCompute, field arrayData memiliki struktur sebagai berikut:

{
    "ownerBaseId":"1822931104031845",
    "objectType":"TABLE",
    "odpsTable":"oracle_************",
    "envType":1,
    "projectGuid":"odps.***********",
    "objectGuid":"odps.******.******",
    "tenantId":0,
    "objectName":"oracle_******",
    "ownerAccountName":"ALIYUN***************",
    "odpsProject":"dataworks******",
    "projectName":"dataworks******",
    "actions":[
      "Select",
      "Describe"
    ],
    "projectId":9***4,
    "workspaceId":"9***4"
  }

Tabel berikut menjelaskan field-field tersebut.

Parameter	Tipe	Deskripsi
ownerBaseId	String	ID pemilik tabel.
ownerAccountName	String	Nama akun pemilik tabel.
objectType	String	Jenis objek.
odpsTable	String	Nama tabel.
envType	Integer	Lingkungan tabel.
projectGuid	String	GUID (Globally Unique Identifier) proyek.
objectGuid	String	GUID (Globally Unique Identifier) objek.
objectName	String	Nama objek.
odpsProject	String	Nama proyek MaxCompute.
projectName	String	Nama proyek di DataWorks.
projectId	Long	ID proyek.
workspaceId	String	ID ruang kerja.
actions	Array	Daftar tindakan yang diminta.

Muatan event otorisasi DataService

Di DataWorks, ketika persetujuan dipicu atau permintaan izin tabel diajukan di Pusat Keamanan, pesan yang dikirim ke EventBridge menyertakan field arrayData. Ketika assignmentCategory bernilai DataService, konten field arrayData adalah sebagai berikut:

{
    "resourceId":"DsApiDeploy/******/workspaceId/******/dsDeployId/******",
    "ownerName":"******",
    "resourceVersion":1,
    "name":"api_api",
    "dsDeployId":"******",
    "workspaceName":"da_******",
    "id":"******",
    "type":1,
    "ownerId":"19****735",
    "url":"https://******.data.aliyun.com/?projectId=******&type=api&id=******&version=***&defaultProjectId=******",
    "workspaceId":"******"
  }

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
resourceId	String	Identifikasi komposit Sumber Daya, digunakan untuk otorisasi.
ownerName	String	Nama pemilik Sumber Daya.
resourceVersion	Long	Versi Sumber Daya.
name	String	Nama Sumber Daya.
dsDeployId	String	ID deployment dari DataService.
workspaceName	String	Nama Ruang Kerja.
id	String	ID unik aset DataService.
type	Integer	Jenis Sumber Daya. Nilai yang valid meliputi: 1: API 2: Function 3: Service Orchestration
ownerId	String	BaseID pemilik Sumber Daya.
url	String	URL aset DataService.
workspaceId	String	ID Ruang Kerja.

Event kualitas data

Daftar event

Tipe Peristiwa	Event	Regular event	Extension point event	Jenis EventBridge	Kode event ekstensi
Pemeriksaan kualitas data	Umpan balik atas Hasil Validasi Memicu ketika pengguna memberikan umpan balik atas Hasil Validasi.			`dataworks:DqcCheck:DqcCheckFeedbackEvent`	`dqc-check-feedback-event`
Pemeriksaan kualitas data	Pemeriksaan kualitas data selesai Memicu ketika pemeriksaan aturan kualitas data selesai. Event ini berisi Hasil Validasi, termasuk apakah aturan lolos dan data Sampel.			`dataworks:DqcCheck:DqcCheckFinishedEvent`	`dqc-check-finished-event`
Event untuk mengelola aturan kualitas data	Buat aturan batch			`dataworks:DqcCheck:BatchCreateDataQualityRules`	`batch-create-data-quality-rules`
	Perbarui aturan batch			`dataworks:DqcCheck:BatchUpdateDataQualityRules`	`batch-update-data-quality-rules`
	Hapus aturan batch			`dataworks:DqcCheck:BatchDeleteDataQualityRules`	`batch-delete-data-quality-rules`
	Perbarui aturan			`dataworks:DqcCheck:UpdateDataQualityRule`	`update-data-quality-rule`
Event untuk mengelola tugas pemantauan	Buat tugas pemantauan			`dataworks:DqcCheck:CreateDataQualityEvaluationTask`	`create-data-quality-evaluation-task`
	Perbarui tugas pemantauan			`dataworks:DqcCheck:UpdateDataQualityEvaluationTask`	`update-data-quality-evaluation-task`
	Salin tugas pemantauan			`dataworks:DqcCheck:CloneDataQualityEvaluationTask`	`clone-data-quality-evaluation-task`
	Hapus tugas pemantauan batch			`dataworks:DqcCheck:BatchDeleteDataQualityEvaluationTasks`	`batch-delete-data-quality-evaluation-tasks`
Event untuk mengelola langganan peringatan	Buat langganan peringatan			`dataworks:DqcCheck:CreateDataQualityEvaluationTaskNotification`	create-data-quality-evaluation-task-notification
	Perbarui langganan peringatan			`dataworks:DqcCheck:UpdateDataQualityEvaluationTaskNotification`	`update-data-quality-evaluation-task-notification`
	Hapus langganan peringatan			`dataworks:DqcCheck:DeleteDataQualityEvaluationTaskNotification`	`delete-data-quality-evaluation-task-notification`

Format pesan

Pemeriksaan kualitas data

Isi pesan dari event umpan balik hasil pemeriksaan kualitas data adalah konten field data dalam pesan event. Berikut adalah contoh format isi pesan.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "ruleCheckId": 521771452,
    "feedbackContent": "Skip",
    "ruleId": 28610334,
    "createUser": "110755000425****",
    "taskId": "167644814****9a26ecf4063a88797",
    "beginTime": "1676448145000",
    "envType": "ODPS",
    "projectName": "test_mc_2303_kongjian",
    "projectId": 9***4,
    "tenantId": 28***656
  }
}

Tabel berikut menjelaskan field kunci dalam muatan.

Parameter	Type	Deskripsi
ruleId	Long	ID aturan kualitas data.
ruleCheckId	Long	ID unik yang dihasilkan sistem untuk Pemeriksaan Kualitas Data.
feedbackContent	String	Konten umpan balik.
createUser	String	ID pengguna yang memberikan umpan balik.
taskId	String	ID Node Kualitas Data.
beginTime	String	Timestamp saat umpan balik diberikan, dalam milidetik.
envType	String	Jenis Sumber Data tempat tabel terkait aturan berada. Nilai yang valid meliputi ODPS, E-MapReduce (EMR), dan HOLO.
projectName	String	Nama proyek yang berisi tabel terkait aturan.
projectId	Long	ID ruang kerja DataWorks.
tenantId	Long	ID penyewa DataWorks.

Contoh berikut menunjukkan format isi pesan untuk event penyelesaian pemeriksaan kualitas data, yaitu konten field data dalam pesan event.

{
  "datacontenttype": "application/json;charset=utf-8",
  "data": {
    "projectId": 9***4,
    "tenantId": 28***656,
    "id": 52177****,
    "taskId": "1671***7a6",
    "entityId": 1562***,
    "ruleId": 28610334,
    "property": "-",
    "bizdate": "2023-02-09 00:00:00",
    "dateType": "YMD",
    "actualExpression": "ds\u003d20230210",
    "matchExpression": "ds\u003d$[yyyymmdd]",
    "blockType": 1,
    "checkResult": 0,
    "eventCode": "dqc-check-finished-event",
    "checkResultStatus": 0,
    "methodName": "table_count",
    "beginTime": "2023-02-15 20:14:48",
    "endTime": "2023-02-15 20:14:55",
    "timeConsuming": "7s",
    "externalType": "CWF2",
    "externalId": "triggerByManual",
    "discrete": false,
    "fixedCheck": true,
    "referenceValue": [
      {
        "bizDate": "3000-12-31 00:00:00",
        "discreteProperty": "表行数，1天差值",
        "value": 0.0,
        "singleCheckResult": 0
      }
    ],
    "sampleValue": [
      {
        "bizDate": "2023-02-09 00:00:00",
        "value": 3.0
      }
    ],
    "trend": "\u003e\u003d",
    "expectValue": 0.0,
    "op": "\u003e\u003d",
    "projectName": "test_mc_2303_kongjian",
    "tableName": "sx_dim_1209_001",
    "templateId": 47,
    "checkerType": 0,
    "ruleName": "前一天差值",
    "isPrediction": false,
    "feedbackStatus": 0,
    "whetherToFilterDirtyData": false
  }
}

Tabel berikut menjelaskan field-field tersebut.

Parameter		Type	Deskripsi
id		Long	ID unik untuk eksekusi pemeriksaan, dihasilkan setiap kali pemeriksaan aturan dipicu.
projectId		Long	ID ruang kerja DataWorks.
tenantId		Long	ID penyewa DataWorks.
taskId		String	ID node pemeriksaan.
entityId		Long	ID ekspresi filter partisi.
ruleId		Long	ID aturan.
property		String	Field yang diperiksa oleh aturan. Ini sesuai dengan nama kolom di tabel sumber.
bizdate		Long	Tanggal Bisnis data. Untuk Data Offline, biasanya sehari sebelum pemeriksaan dieksekusi.
dateType		String	Menentukan frekuensi penjadwalan. Nilai umum adalah YMD, yang menunjukkan node berjalan secara tahunan, bulanan, atau harian.
actualExpression		String	Partisi aktual dari tabel Sumber Data yang diperiksa.
matchExpression		String	Ekspresi filter partisi.
blockType		Integer	Menunjukkan kekuatan aturan. Nilai yang valid adalah: 1: Aturan Kuat. 0: Aturan Lemah. Anda dapat mengatur aturan penting sebagai Aturan Kuat. Jika Aturan Kuat memicu Peringatan kritis, Node Terjadwal yang sesuai akan diblokir.
checkResult		Integer	Status hasil pemeriksaan. Nilai yang valid adalah: -2: Dilewati -1: Pemeriksaan gagal dengan pengecualian 0: Lolos 1: Ambang Peringatan terpicu 2: Ambang Kritis terpicu
methodName		String	Metode yang digunakan untuk mengumpulkan data sampel. Contohnya meliputi: `avg`, `count`, `sum`, `min`, `max`, `count_distinct`, `user_defined`, `table_count`, `table_size`, `table_dt_load_count`, `table_dt_refuseload_count`, `null_value`, `null_value/table_count`, `(table_count-count_distinct)/table_count`, dan `table_count-count_distinct`.
beginTime		Long	Waktu mulai eksekusi pemeriksaan.
endTime		Long	Waktu penyelesaian eksekusi pemeriksaan.
timeConsuming		String	Durasi eksekusi node pemeriksaan.
externalType		String	Jenis sistem penjadwalan. `CWF2` adalah satu-satunya nilai yang didukung. Jika field ini kosong, pemeriksaan dipicu oleh pengujian manual.
externalId		String	Jika `externalType` adalah `CWF2`, field ini adalah ID Node Terjadwal. Jika `externalType` kosong, field ini adalah `triggerByManual`, yang menunjukkan pemicu manual.
discrete		Boolean	Menunjukkan apakah pemeriksaan bersifat diskrit. Nilai yang valid: true: Pemeriksaan bersifat diskrit. false: Pemeriksaan tidak bersifat diskrit.
fixedCheck		Boolean	Menunjukkan apakah pemeriksaan menggunakan nilai tetap. Nilai yang valid: true: Pemeriksaan menggunakan nilai tetap. false: Pemeriksaan tidak menggunakan nilai tetap.
referenceValue			Berisi nilai sampel historis.
bizDate	Long	Tanggal Bisnis data. Untuk Data Offline, biasanya sehari sebelum pemeriksaan dieksekusi.
discreteProperty	String	Nilai field sampel setelah dikelompokkan oleh klausa `GROUP BY`. Misalnya, jika Anda mengelompokkan berdasarkan field jenis kelamin, nilai `discreteProperty` mungkin `Male`, `Female`, dan `null`.
value	Decimal	Nilai sampel.
singleCheckResult	Integer	Status hasil untuk sampel spesifik ini.
sampleValue			Nilai sampel untuk pemeriksaan saat ini.
bizDate	Long	Tanggal Bisnis data. Untuk Data Offline, biasanya sehari sebelum pemeriksaan dieksekusi.
value	Decimal	Nilai sampel.
trend		String	Tren hasil pemeriksaan.
expectValue		Double	Nilai yang diharapkan.
op		String	Operator perbandingan.
projectName		String	Nama mesin komputasi atau Sumber Data yang diperiksa.
tableName		String	Nama tabel yang diperiksa.
templateId		Integer	ID templat pemeriksaan yang diterapkan.
checkerType		Integer	Jenis pemeriksa.
ruleName		String	Nama aturan.
isPrediction		Boolean	Menunjukkan apakah hasilnya merupakan prediksi. Nilai yang valid: true: Hasilnya adalah prediksi. false: Hasilnya bukan prediksi.
comment		String	Deskripsi aturan pemeriksaan.
eventCode		String	Kode event titik ekstensi.

Event pra-operasi

Contoh berikut menunjukkan format isi pesan (konten field data dalam pesan event) untuk Pre-event Pembuatan Aturan Kualitas Data Batch.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
      "eventCode": "batch-create-data-quality-rules",
      "projectId": 30***03,
      "tenantId": 28***656,
      "operator": "19***735",
      "operationTime": 1734505954897,
      "dataQualityTaskId": 1001,
      "target": {
        "databaseType": "maxcompute",
        "tableGuid": "odps.project_demo.tb_table_demo"
      },
      "rules": [
        {
          "name": "Table row count is greater than 0",
          "enabled": true,
          "severity": "High",
          "description": "Test for the data quality rule creation operation",
          "templateCode": "system:table:table_count:fixed:0",
          "samplingConfig": {
            "metric": "count"
          },
          "checkingConfig": {
            "type": "fixed",
            "thresholds": {
              "expected": {
                "expression": "$checkValue > 0"
              },
              "critical": {
                "expression": "$checkValue <= 0"
              }
            }
          }
        }
      ]
    }
}

Tabel berikut menjelaskan field kunci dalam muatan.

Parameter	Tipe	Deskripsi
projectId	List	ID Ruang Kerja DataWorks.
operator	String	UID operator.
operationTime	Long	Waktu operasi dilakukan, dinyatakan sebagai timestamp Unix dalam milidetik.
dataQualityTaskId	Long	ID tugas pemantauan Kualitas Data yang terkait dengan aturan. Parameter ini opsional.
target	DataQualityTarget	Objek yang dipantau oleh aturan Kualitas Data.
databaseType	String	Jenis database yang berisi tabel yang dipantau. Nilai yang valid: MaxCompute EMR CDH Hologres AnalyticDB for PostgreSQL
tableGuid	String	Identifikasi unik tabel di Data Map.
rules	List<DataQualityRule>	Daftar objek aturan Kualitas Data yang akan dibuat.
name	String	Nama aturan Kualitas Data.
enabled	Boolean	Menentukan apakah mengaktifkan aturan. Default: `true`.
severity	String	Tingkat keparahan aturan, yang sesuai dengan pengaturan `Strength` di UI. Nilai yang valid: High Normal
description	String	Deskripsi aturan.
templateCode	String	Kode templat aturan yang digunakan untuk membuat aturan.
samplingConfig	SamplingConfig	Pengaturan pengambilan sampel.
metric	String	Metrik yang digunakan untuk pengambilan sampel. Nilai yang valid: `Count`: Jumlah baris tabel. `Min`: Nilai minimum field. `Max`: Nilai maksimum field. `Avg`: Nilai rata-rata field. `DistinctCount`: Jumlah nilai unik di field. `DistinctPercent`: Rasio nilai unik terhadap jumlah total baris. `DuplicatedCount`: Jumlah nilai duplikat di field. `DuplicatedPercent`: Rasio nilai duplikat terhadap jumlah total baris. `TableSize`: Ukuran tabel. `NullValueCount`: Jumlah baris di mana field bernilai null. `NullValuePercent`: Rasio baris null terhadap jumlah total baris. `GroupCount`: Jumlah baris untuk setiap grup unik setelah dikelompokkan berdasarkan field. `CountNotIn`: Jumlah baris yang tidak cocok dengan kumpulan nilai enumerasi yang ditentukan. `CountDistinctNotIn`: Jumlah nilai unik yang tidak cocok dengan kumpulan nilai enumerasi yang ditentukan. `UserDefinedSql`: Menentukan bahwa kueri SQL kustom digunakan untuk pengambilan sampel.
checkingConfig	CheckingConfig	Pengaturan validasi sampel.
type	String	Metode perhitungan ambang batas. Nilai yang valid: Fixed Fluctation FluctationDiscreate Auto Average Variance
thresholds	Thresholds	Pengaturan ambang batas.
expected	Threshold	Pengaturan untuk ambang batas yang diharapkan.
expression	String	Ekspresi ambang batas.
critical	Threshold	Pengaturan ambang batas untuk memicu peringatan kritis.

Contoh berikut menunjukkan muatan untuk pre-event pembaruan aturan Kualitas Data batch. Muatan ini adalah nilai field data dalam pesan event.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
      "eventCode": "update-data-quality-rule",
      "projectId": 30***03,
      "tenantId": 28***656,
      "operator": "19***735",
      "operationTime": 1734505954897,
      "id": 100001,
      "name": "Table row count is greater than 0",
      "enabled": true,
      "severity": "High",
      "description": "Test for the Data Quality Rule update operation",
      "templateCode": "system:table:table_count:fixed:0",
      "samplingConfig": {
        "metric": "count"
      },
      "checkingConfig": {
        "type": "fixed",
        "thresholds": {
          "expected": {
            "expression": "$checkValue > 0"
          },
          "critical": {
            "expression": "$checkValue <= 0"
          }
        }
      }
    }
}

Tabel berikut mencantumkan field kunci dalam muatan.

Parameter	Tipe	Deskripsi
eventCode	String	Kode event.
projectId	Long	ID ruang kerja.
tenantId	Long	ID penyewa.
operator	String	ID pengguna.
operationTime	Long	Waktu operasi.
id	Long	ID aturan.
name	String	Nama aturan.
enabled	Boolean	Menunjukkan apakah aturan diaktifkan. true: Aturan diaktifkan. false: Aturan dinonaktifkan.
severity	String	Tingkat keparahan aturan. Nilai yang valid: High Normal
description	String	Deskripsi aturan.
templateCode	String	Pengidentifikasi templat aturan.
samplingConfig	SamplingConfig	Konfigurasi untuk pengambilan sampel data.
metric	String	Metrik yang digunakan untuk pengambilan sampel. Nilai yang valid: Count: Jumlah baris di tabel. Min: Nilai minimum field. Max: Nilai maksimum field. Avg: Nilai rata-rata field. DistinctCount: Jumlah nilai unik di field. DistinctPercent: Persentase nilai unik di field. DuplicatedCount: Jumlah nilai duplikat di field. DuplicatedPercent: Persentase nilai duplikat di field. TableSize: Ukuran tabel. NullValueCount: Jumlah baris di mana field bernilai null. NullValuePercent: Persentase baris di mana field bernilai null. GroupCount: Jumlah baris untuk setiap nilai unik di field. CountNotIn: Jumlah baris dengan nilai yang tidak cocok dengan enumerasi yang ditentukan. CountDistinctNotIn: Jumlah nilai unik yang tidak cocok dengan enumerasi yang ditentukan. UserDefinedSql: Metrik yang ditentukan oleh kueri SQL kustom.
checkingConfig	CheckingConfig	Konfigurasi validasi untuk data yang diambil sampelnya.
type	String	Metode perhitungan ambang batas. Nilai yang valid: Fixed Fluctuation FluctuationDiscrete Auto Average Variance
thresholds	Thresholds	Konfigurasi ambang batas.
expected	Threshold	Konfigurasi ambang batas yang diharapkan.
expression	String	Ekspresi ambang batas.
critical	Threshold	Konfigurasi ambang batas untuk peringatan kritis.

Berikut adalah contoh format isi pesan untuk Pre-event Penghapusan Aturan Kualitas Data Batch (yaitu konten field data dalam pesan event).

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
        "eventCode": "batch-delete-data-quality-rules",
        "ids": [
            10***01,
            10***02,
            10***03
        ],
        "projectId": 30***03,
        "tenantId": 524***4736,
        "operator": "19***735",
        "operationTime": 1734505954897
    }
}

Tabel berikut menjelaskan field kunci.

Parameter	Tipe	Deskripsi
projectId	Long	ID Ruang Kerja DataWorks.
operator	String	UID pengguna yang melakukan operasi.
operationTime	Long	Waktu operasi terjadi, sebagai timestamp Unix dalam milidetik.
ids	List<Long>	Daftar ID aturan kualitas data yang akan dihapus.
tenantId	String	Identifikasi unik untuk penyewa.
eventCode	String	Kode unik yang mengidentifikasi jenis event.

Contoh berikut menunjukkan isi paket untuk pra-event Pembaruan Aturan Kualitas Data, yaitu isi dari bidang data dalam paket event.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
      "eventCode": "update-data-quality-rule",
      "projectId": 30***03,
      "tenantId": 524***4736,
      "operator": "110***3538",
      "operationTime": 1734505954897,
      "id": 100001,
      "name": "Table row count is greater than 0",
      "enabled": true,
      "severity": "High",
      "description": "A test check for the Data Quality Rule creation operation.",
      "templateCode": "system:table:table_count:fixed:0",
      "samplingConfig": {
        "metric": "count"
      },
      "checkingConfig": {
        "type": "fixed",
        "thresholds": {
          "expected": {
            "expression": "$checkValue > 0"
          },
          "critical": {
            "expression": "$checkValue <= 0"
          }
        }
      }
    }
}

Tabel ini menjelaskan field kunci dalam isi pesan.

Parameter	Tipe	Deskripsi
eventCode	String	Kode unik untuk jenis event.
projectId	Long	ID Ruang Kerja.
tenantId	Long	ID Penyewa.
operator	String	UID pengguna.
operationTime	Long	Waktu saat operasi terjadi, dalam milidetik Unix.
id	Long	ID aturan.
name	String	Nama aturan.
enabled	Boolean	Menunjukkan apakah Aturan Kualitas Data diaktifkan. true: Aturan diaktifkan. false: Aturan dinonaktifkan.
severity	String	Tingkat keparahan aturan. Field ini sesuai dengan pengaturan Kekuatan Aturan di UI. Nilai yang valid: High Normal
description	String	Deskripsi kustom aturan.
templateCode	String	Identifikasi untuk templat aturan.
samplingConfig	SamplingConfig	Konfigurasi untuk pengambilan sampel data.
metric	String	Metrik yang digunakan untuk pengambilan sampel. Nilai yang mungkin: Count: Jumlah baris di tabel. Min: Nilai minimum field. Max: Nilai maksimum field. Avg: Nilai rata-rata field. DistinctCount: Jumlah nilai unik di field. DistinctPercent: Rasio nilai field unik terhadap jumlah total baris. DuplicatedCount: Jumlah nilai duplikat di field. DuplicatedPercent: Rasio nilai field duplikat terhadap jumlah total baris. TableSize: Ukuran tabel. NullValueCount: Jumlah baris di mana field bernilai null. NullValuePercent: Persentase baris di mana field bernilai null. GroupCount: Jumlah baris untuk setiap nilai unik setelah dikelompokkan berdasarkan field. CountNotIn: Jumlah baris dengan nilai yang tidak cocok dengan enumerasi yang ditentukan. CountDistinctNotIn: Jumlah nilai unik yang tidak cocok dengan enumerasi yang ditentukan. UserDefinedSql: Menunjukkan bahwa kueri SQL kustom digunakan untuk pengambilan sampel.
checkingConfig	CheckingConfig	Konfigurasi untuk pemeriksaan kualitas data.
type	String	Metode perhitungan ambang batas. Nilai yang valid: Fixed Fluctation FluctationDiscreate Auto Average Variance
thresholds	Thresholds	Pengaturan ambang batas.
expected	Threshold	Pengaturan ambang batas yang diharapkan.
expression	String	Ekspresi yang mendefinisikan kondisi ambang batas.
critical	Threshold	Pengaturan ambang batas untuk peringatan kritis.

Pre-event untuk tugas pemantauan kualitas data (buat, perbarui, salin, dan hapus batch)

Contoh format isi pesan untuk membuat atau memperbarui pre-event pemantauan kualitas data (yaitu konten field data dalam pesan event) adalah sebagai berikut.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
      "eventCode": "create-data-quality-evaluation-task",
      "name": "Table data accuracy monitor",
      "description": "After a scheduled instance that writes data to the table runs successfully, this monitor is triggered to check whether the output data meets expectations.",
      "target": {
        "databaseType": "emr",
        "tableGuid": "an-emr-table-guid"
      },
      "trigger": {
        "type": "ByScheduledTaskInstance",
        "taskIds": [
          1001,
          1002
        ]
      },
      "dataSourceId": 201,
      "runtimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"HIVE_SQL\" }",
      "rules": [
        {
          "name": "Table row count is greater than 0",
          "enabled": true,
          "severity": "High",
          "description": "Test for the Data Quality Rule create operation",
          "templateCode": "system:table:table_count:fixed:0",
          "samplingConfig": {
            "metric": "count"
          },
          "checkingConfig": {
            "type": "fixed",
            "thresholds": {
              "expected": {
                "expression": "$checkValue > 0"
              },
              "critical": {
                "expression": "$checkValue <= 0"
              }
            }
          }
        }, 
        {
          "id": 100002,
          "name": "Table row count is greater than 100",
          "checkingConfig": {
            "type": "fixed",
            "thresholds": {
              "expected": {
                "expression": "$checkValue > 100"
              },
              "critical": {
                "expression": "$checkValue <= 100"
              }
            }
          }
        }
      ],
      "hooks": [
        {
          "type": "BlockTaskInstance",
          "condition": "(${severity} == \"High\" AND ${status} == \"Critical\") OR (${severity} == \"High\" AND ${status} == \"Error\")"
        }
      ],
      "notifications": {
        "condition": "(${severity} == \"High\" AND ${status} == \"Warned\") OR (${severity} == \"Normal\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Warned\") OR (${severity} == \"Normal\" AND ${status} == \"Error\")",
        "notifications": [
          {
            "channels": [
              "Mail",
              "Sms"
            ],
            "notificaionReceivers": [
              {
                "receiverType": "AliUid",
                "receiverValues": [
                  "1107550004253538", 
                  "51107550004253538"
                ]
              }
            ]
          }, 
          {
            "channels": [
              "Dingding"
            ],
            "notificaionReceivers": [
              {
                "receiverType": "DingdingUrl",
                "receiverValues": [
                  "https://api.dingding.com/message-boxes/b1/messages",
                  "https://api.dingding.com/message-boxes/b2/messages"
                ],
                "extension": "{ \"atAll\": true }"
              }
            ]
          }
        ]
      },
      "projectId": 30***03,
      "tenantId": 524***4736,
      "operator": "110***3538",
      "operationTime": 1734505954897
    }
}

Tabel berikut menjelaskan parameter kunci.

Parameter	Type	Deskripsi
eventCode	String	Kode event.
name	String	Nama Tugas Pemantauan Kualitas Data.
description	String	Deskripsi Tugas Pemantauan Kualitas Data.
target	DataQualityTarget	Objek yang dipantau oleh Tugas Pemantauan Kualitas Data.
databaseType	String	Untuk dataset tabel, ini menentukan jenis database tabel. Nilai yang valid: MaxCompute E-MapReduce (EMR) CDH Hologres AnalyticDB for PostgreSQL
tableGuid	String	ID unik Tabel di Data Map.
trigger	DataQualityEvaluationTaskTrigger	Konfigurasi pemicu untuk Tugas Pemantauan Kualitas Data.
type	String	Menentukan jenis event yang memicu tugas untuk berjalan. Nilai yang valid: `ByScheduledTaskInstance`: Memicu tugas ketika Instance Terjadwal berjalan dengan sukses. Ini hanya didukung di lingkungan Cloud Publik. `ByManual`: Memicu tugas secara manual.
taskIds	Array<Long>	Parameter ini wajib ketika `type` diatur ke `ByScheduledTaskInstance`. Ini menentukan ID node terjadwal yang memicu tugas setelah instance berhasil dijalankan.
dataSourceId	Long	ID Sumber Data yang digunakan oleh Tugas Pemantauan Kualitas Data.
runtimeConf	String	Konfigurasi runtime untuk Sumber Data. Parameter ini saat ini mendukung menentukan antrian YARN untuk E-MapReduce (EMR) dan mengatur mesin SQL ke `SPARK-SQL` untuk mengumpulkan data dari Tabel E-MapReduce (EMR).
rules	List<DataQualityRule>	Daftar Aturan Kualitas Data. Untuk informasi lebih lanjut tentang parameter, lihat Pre-event untuk aturan pemantauan (buat, perbarui, dan hapus beberapa aturan pemantauan sekaligus, dan perbarui aturan pemantauan).
hooks	Array<DataQualityEvaluationTaskHook>	Pengaturan panggilan balik, atau hook, dalam siklus hidup instance Tugas Pemantauan Kualitas Data. Saat ini, hanya hook untuk memblokir Instance Terjadwal yang didukung.
type	String	Jenis tindakan pasca-pemrosesan. Nilai yang valid: `BlockTaskInstance`: Memblokir instance tugas DataWorks agar tidak berjalan.
condition	String	Kondisi Pemicu untuk Hook.
notifications	Array<Notification>	Pengaturan Notifikasi Peringatan.
projectId	Long	ID Ruang Kerja DataWorks.
tenantId	Long	ID penyewa.
operator	String	UID operator.
operationTime	Long	Waktu operasi.

Berikut adalah contoh format isi pesan untuk Pre-event Salin Pemantauan Kualitas Data (yaitu konten field data dalam pesan event).

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
      "eventCode": "clone-data-quality-evaluation-task",
      "id": 10001,
      "targets": [
        {
          "databaseType": "emr",
          "tableGuid": "an-emr-table-guid"
        },
        {
          "databaseType": "emr",
          "tableGuid": "another-emr-table-guid"
        }
      ],
      "projectId": 9***4,
      "tenantId": 28***656,
      "operator": "19***735",
      "operationTime": 1734505954897
    }
}

Tabel berikut menjelaskan parameter kunci.

Parameter	Tipe	Deskripsi
projectId	Long	ID Ruang Kerja DataWorks.
tenantId	Long	ID penyewa.
operator	String	UID operator.
operationTime	Long	Waktu operasi.
targets	List<DataQualityTarget>	Objek target untuk operasi kloning.
databaseType	String	Untuk dataset tabel, ini menentukan jenis database tabel. Nilai yang valid: MaxCompute E-MapReduce (EMR) CDH Hologres AnalyticDB for PostgreSQL
tableGuid	String	ID unik Tabel di Data Map.
id	Long	ID Tugas Pemantauan Kualitas Data sumber untuk dikloning.
eventCode	String	Kode event.

Berikut menunjukkan contoh format isi pesan untuk penghapusan batch pre-event pemantauan kualitas data. Isi pesan adalah konten field data dalam pesan event.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
      "eventCode": "batch-delete-data-quality-evaluation-tasks",
      "ids": [
        10001,
        10002
      ],
      "projectId": 9***4,
      "tenantId": 28***656,
      "operator": "19***735,
      "operationTime": 1734505954897
    }
}

Tabel berikut menjelaskan parameter kunci.

Parameter	Type	Deskripsi
projectId	Long	ID Ruang Kerja DataWorks.
operator	String	UID operator.
operationTime	Long	Waktu operasi.
ids	List<Long>	Daftar ID Tugas Pemantauan Kualitas Data yang akan dihapus.
tenantId	Long	ID penyewa.
eventCode	String	Kode event.

Event peringatan kualitas data

Berikut adalah contoh isi pesan untuk pre-event pembuatan atau penghapusan langganan peringatan pemantauan kualitas data. Isi pesan adalah konten field data dalam pesan event.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
      "eventCode": "create-data-quality-evaluation-task-notification",
      "dataQualityEvaluationTaskId": 10001,
      "channel": "sms",
      "receiverValue": "1107***38",
      "projectId": 30***03,
      "operator": "110***3538",
      "operationTime": 1734505954897
    }
}

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
projectId	Long	ID ruang kerja DataWorks.
operator	String	UID operator.
operationTime	Long	Waktu operasi, ditentukan sebagai timestamp Unix dalam milidetik.
dataQualityEvaluationTaskId	Long	ID tugas pemantauan kualitas data.
channel	String	Jenis saluran notifikasi. Nilai yang valid: `Mail`: Email `Sms`: SMS `Phone`: Telepon `Feishu`: Lark `Weixin`: WeChat `Dingding`: DingTalk `Webhook`: Webhook Kustom
receiverValue	String	Tujuan notifikasi spesifik, seperti alamat email atau URL webhook.
eventCode	String	Kode event unik.

Contoh format isi pesan untuk Pre-event Pembaruan Pemantauan Kualitas Data (konten field data dalam pesan event) adalah sebagai berikut.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
      "eventCode": "update-data-quality-evaluation-task-notification",
      "dataQualityEvaluationTaskId": 10001,
      "currentChannel": "sms",
      "currentReceiverValue": "1107***538",
      "updatedChannel": "sms",
      "updatedReceiverValue": "1107***538",
      "projectId": 30***03,
      "operator": "110***3538",
      "operationTime": 1734505954897
    
}

Tabel berikut menjelaskan field dalam muatan.

Parameter	Tipe	Deskripsi
projectId	Long	ID ruang kerja DataWorks.
operator	String	UID operator.
operationTime	Long	Waktu operasi, ditentukan sebagai timestamp Unix dalam milidetik.
dataQualityEvaluationTaskId	Long	ID tugas pemantauan kualitas data.
currentChannel	String	Jenis saluran asli sebelum pembaruan. Untuk nilai yang valid, lihat deskripsi field `channel`. Email SMS Telepon Lark WeChat DingTalk Webhook Kustom
currentReceiverValue	String	Tujuan notifikasi asli sebelum pembaruan.
updatedChannel	String	Jenis saluran baru setelah pembaruan. Untuk nilai yang valid, lihat deskripsi field `channel`. Email SMS Telepon Lark WeChat DingTalk Webhook Kustom
updatedReceiverValue	String	Tujuan notifikasi baru setelah pembaruan.
eventCode	String	Kode event unik.

Event tingkat penyewa

Modul tingkat penyewa menghasilkan event tingkat penyewa. Misalnya, menghapus Ruang Kerja di Konsol menghasilkan Event. Daftar Event di bawah ini menunjukkan event yang didukung oleh setiap modul, apakah itu event regular atau extension point, serta format pesannya.

Tab Format pesan hanya menampilkan konten parsial. Untuk pesan event lengkap yang dikirim ke EventBridge atau Function Compute, lihat Lampiran: Format pesan.

Event konsol

Daftar event

Jenis Peristiwa	Event dan operasi	Regular event	Extension event	Tipe event EventBridge	Kode event ekstensi
Penghapusan Ruang Kerja	Pre-event untuk Penghapusan Ruang Kerja			`dataworks:ProjectChange:DeleteProject`	`delete-project`
Penghapusan Ruang Kerja	Post-event untuk Penghapusan Ruang Kerja			`dataworks:ProjectChange:ProjectDeleted`	`project-deleted`

Format pesan

Event penghapusan ruang kerja

Berikut adalah contoh format isi pesan (konten field data dalam pesan event) untuk pre-event yang dipicu sebelum penyewa menghapus ruang kerja.

{
 
  "data": {
    "eventCode": "delete-project",
    "projectId": 7***7, // ID Ruang Kerja
    "tenantId": 2807****0784, // ID Penyewa
    "operator": "19***735
}

Tabel berikut menjelaskan field-field tersebut.

Parameter	Tipe	Deskripsi
operator	String	UID pengguna yang menghapus Ruang Kerja DataWorks.
projectId	Long	ID Ruang Kerja DataWorks yang akan dihapus.
tenantId	Long	ID Penyewa tempat Ruang Kerja tersebut berada.
eventCode	String	Kode unik yang mengidentifikasi Event Titik Ekstensi.

Berikut adalah contoh format isi pesan (konten field data dalam pesan event) untuk event yang dipicu setelah penyewa menghapus ruang kerja.

{
    
    "data": {
        "eventCode": "project-deleted",
        "tenantId": 28***656,
        "blockBusiness": false,
        "projectName": "test2",
        "projectId": 9***4,
        "operator": "19***735",
        "timestamp": 1702260556896
   } 
}

Tabel berikut menjelaskan field-field tersebut.

Parameter	Tipe	Deskripsi
operator	String	UID pengguna yang menghapus Ruang Kerja DataWorks.
projectId	Long	ID Ruang Kerja DataWorks yang dihapus.
projectName	String	Nama Ruang Kerja DataWorks yang dihapus.
tenantId	Long	ID Penyewa yang memiliki Ruang Kerja yang dihapus.
timestamp	Long	Timestamp yang menunjukkan kapan Event dihasilkan.
eventCode	String	Kode unik yang mengidentifikasi Event Titik Ekstensi.

Event unggah dan unduh

Daftar event

jenis peristiwa	Event	Regular event	Extension point event	Tipe EventBridge	Kode event ekstensi
Unggah dan Unduh	Pre-unduh: Pembuatan file			dataworks:ResourcesDownload:DownloadResources	download-resources
	Pre-unduh: Pengunduhan file			dataworks:ResourcesDownload:DownloadResourcesExecute	download-resources-execute
	Pre-unggah			dataworks:ResourcesUpload:UploadDataToTable	upload-data-to-table

Format pesan

Unggah dan unduh

Berikut adalah contoh isi pesan untuk event Pre-event Pengunduhan Data - Pembuatan File, yaitu konten field data dalam pesan event.

{ 
    "data": {
        "eventCode": "download-resources",
        "moduleType": "sqlx_query",
        "operatorBaseId": "123936573******",
        "operatorUid": "14931896037*******",
        "fileName": "sample-file-name.csv",
        "fileSize": 10241024,
        "datasourceId": "1111",
        "datasourceName": "odps_first",
        "queryDwProjectId": "9***4",
        "queryDwProjectName": "test_project",
        "dataRowSize": "123456",
        "sqlText": "select sku_code, sku_name from dim_sku",
    }

Parameter	Type	Deskripsi
moduleType	String	Sumber unduhan. Nilai yang valid: entity_transfer: Data yang diunduh dari . `develop_query`: Data diunduh dengan menggunakan pernyataan SQL di DataStudio. sqlx_query: Data diunduh dan diambil menggunakan pernyataan SQL di . dw_excel: Data diunduh dari .
operatorBaseId	String	BaseID pengguna yang memulai pengunduhan.
operatorUid	String	UID pengguna yang memulai pengunduhan.
fileName	String	Nama file yang diunduh.
fileSize	Long	Ukuran file yang diunduh, dalam byte.
datasourceId	String	ID Sumber Data yang berisi data yang diunduh.
datasourceName	String	Nama Sumber Data yang berisi data yang diunduh.
queryDwProjectId	String	ID Ruang Kerja DataWorks yang berisi data yang diunduh.
queryDwProjectName	String	Nama Ruang Kerja DataWorks yang berisi data yang diunduh.
dataRowSize	Long	Jumlah baris data yang diunduh.
sqlText	String	Pernyataan SQL yang digunakan untuk mengkueri dan mengunduh data.
eventCode	String	Kode event ekstensi.

Berikut adalah contoh format isi pesan untuk event Pre-event Pengunduhan Data - Pengunduhan File, yaitu konten field data dalam pesan event.

{
  "datacontenttype": "application/json;charset=utf-8",
  "aliyunaccountid": "1493189603770213",
  "aliyunpublishtime": "2023-12-11T02:10:00.194Z",
  "data": {
    "eventCode": "download-resources-execute",
    "moduleType": "sqlx_query",
    "operatorBaseId": "123936573******",
    "operatorUid": "14931896037*******",
    "fileName": "sample-file-name.csv",
    "fileSize": 10241024,
    "datasourceId": "1111",
    "datasourceName": "odps_first",
    "queryDwProjectId": "9***4",
    "queryDwProjectName": "test_project",
    "dataRowSize": "123456",
    "sqlText": "select sku_code, sku_name from dim_sku",
    "ip": "198.10.X.X"
  },
  "aliyunoriginalaccountid": "149318960******",
  "specversion": "1.0",
  "aliyuneventbusname": "default",
  "id": "2c3e41e5-3486-40ce-87d4-910f989cf2a7",
  "source": "acs.dataworks",
  "time": "2023-12-11T10:10:00.117Z",
  "aliyunregionid": "cn-shanghai",
  "type": "dataworks:ResourcesDownload:DownloadResourcesExecute"
}

Parameter	Type	Deskripsi
moduleType	String	Sumber unduhan. Nilai yang valid: entity_transfer: Data yang diunduh dari . `develop_query`: Data diunduh dengan menggunakan pernyataan SQL di DataStudio. sqlx_query: Data diunduh dan diambil menggunakan pernyataan SQL di . dw_excel: Data diunduh dari .
operatorBaseId	String	BaseID pengguna yang memulai pengunduhan.
operatorUid	String	UID pengguna yang memulai pengunduhan.
fileName	String	Nama file yang diunduh.
fileSize	Long	Ukuran file yang diunduh, dalam byte.
datasourceId	String	ID Sumber Data yang berisi data yang diunduh.
datasourceName	String	Nama Sumber Data yang berisi data yang diunduh.
queryDwProjectId	String	ID Ruang Kerja DataWorks yang berisi data yang diunduh.
queryDwProjectName	String	Nama Ruang Kerja DataWorks yang berisi data yang diunduh.
dataRowSize	Long	Jumlah baris data yang diunduh.
sqlText	String	Pernyataan SQL yang digunakan untuk mengkueri dan mengunduh data.
ip	String	Alamat IP pengguna yang memulai pengunduhan.
eventCode	String	Kode event ekstensi.

Contoh format isi pesan untuk pre-event unggah data (konten field data dalam pesan event) adalah sebagai berikut.

{
  "datacontenttype": "application/json;charset=utf-8",
  "aliyunaccountid": "1493189603770213",
  "aliyunpublishtime": "2023-12-11T02:10:00.194Z",
  "data": {
    "eventCode": "upload-data-to-table",
    "uploadSourceType": "LOCAL",
    "optTableType": "CREATE",
    "targetEngineType": "MAXCOMPUTE",
    "writeType": "OVERWRITE",
    "conflictMode": "IGNORE",
    "operatorBaseId": "12312*****",
    "operatorUid": "1222222*****",
    "datasourceId": "1111",
    "datasourceName": "odps_first",
    "tableGuid": "odps.mc_project.test_table",
    "queryDwProjectId": "9***4",
    "queryDwProjectName": "test_project",
    "fileSize": 123456
  },
  "aliyunoriginalaccountid": "149318960******",
  "specversion": "1.0",
  "aliyuneventbusname": "default",
  "id": "2c3e41e5-3486-40ce-87d4-910f989cf2a7",
  "source": "acs.dataworks",
  "time": "2023-12-11T10:10:00.117Z",
  "aliyunregionid": "cn-shanghai",
  "type": "dataworks:ResourcesUpload:UploadDataToTable"
}

Parameter	Tipe	Deskripsi
uploadSourceType	String	Sumber unggahan. Nilai yang valid: `LOCAL`: Data diunggah dari file lokal. `OSS`: Data diunggah dari file Object Storage Service (OSS). DW_EXCEL: Mengunggah data DataWorks dari . `HTTP`: Data diunggah dari sumber HTTP.
optTableType	String	Menentukan apakah mengunggah data ke tabel baru atau yang sudah ada. Nilai yang valid: `CREATE`: Unggah data ke tabel baru. `IMPORT`: Unggah data ke tabel yang sudah ada.
targetEngineType	String	Jenis Mesin Komputasi tujuan. Nilai yang valid: `MaxCompute` `EMR Hive` `Hologres`
writeType	String	Mode penulisan data untuk tabel tujuan. Nilai yang valid: `OVERWRITE`: Timpa data yang ada di tabel tujuan. `APPEND`: Tambahkan data yang diunggah ke tabel tujuan.
conflictMode	String	Kebijakan untuk menangani Konflik Kunci Utama. Nilai yang valid: `IGNORE`: Jika terjadi konflik kunci utama, sistem mengabaikan data yang diunggah. `REPLACE`: Jika terjadi konflik kunci utama, sistem menghapus baris yang ada dan memasukkan data yang diunggah. Field yang tidak ditentukan dalam unggahan diatur ke `NULL`. `UPDATE`: Data yang diunggah menimpa data yang ada. Hanya field yang ditentukan yang diperbarui, sedangkan field lain tetap tidak berubah.
operatorBaseId	String	BaseID pengguna yang memulai unggahan.
operatorUid	String	UID pengguna yang memulai unggahan.
datasourceId	String	ID Sumber Data tujuan.
datasourceName	String	Nama Sumber Data tujuan.
tableGuid	String	GUID tabel tujuan. Contoh: MaxCompute: `odps.maxcomputeProject.tableName`. EMR_Hive: `emr_hive.emrClusterId.schema.tableName`. Holo: `holo.hologresInstanceId.database`.
queryDwProjectId	String	ID Ruang Kerja DataWorks yang berisi tabel tersebut.
queryDwProjectName	String	Nama Ruang Kerja DataWorks tempat tabel tersebut berada.
fileSize	Long	Ukuran file yang diunggah, dalam byte.
eventCode	String	Kode event ekstensi.

Lampiran: Format pesan

EventBridge

Setelah Anda mengonfigurasi saluran distribusi event di Open Events (OpenEvent), DataWorks mengirim event ke EventBridge ketika event tingkat ruang kerja atau penyewa dipicu. Anda dapat mengonfigurasi aturan di EventBridge untuk memfilter event ini berdasarkan field type-nya. JSON berikut menunjukkan format pesan yang dikirim DataWorks ke EventBridge.

{ 
 "datacontenttype": "application/json;charset=utf-8", // Format field data. Hanya application/json yang didukung.
  "data": {
 // Konten objek data bervariasi tergantung jenis event. Field tenantId dan eventCode selalu disertakan. Untuk detail event spesifik, lihat daftar event di topik ini.
 "tenantId": 28378****10656, // ID penyewa. Di DataWorks, setiap akun Alibaba Cloud berkorespondensi dengan satu penyewa yang memiliki ID penyewa unik. Anda dapat menemukan ID penyewa Anda di bawah Info Pengguna pada profil pengguna di halaman DataStudio.
 "eventCode": "xxxx"
  },
  "id": "539fd8f4-4ea1-4625-aa8b-6c906674****", // Pengidentifikasi unik untuk event.
  "source": "acs.dataworks", // Layanan yang menghasilkan event. `acs.dataworks` menunjukkan event berasal dari DataWorks.
  "specversion": "1.0",
  "subject": "",
  "time": "2020-11-19T21:04:41+08:00", // Waktu saat event dihasilkan.
  "type": "dataworks:InstanceStatusChanges:InstanceStatusChanges", // Jenis event. Digunakan untuk memfilter event di EventBridge.
  "aliyunaccountid": "123456789098****", // ID Akun Alibaba Cloud.
  "aliyunpublishtime": "2020-11-19T21:04:42.179PRC", // Waktu saat EventBridge menerima event.
  "aliyuneventbusname": "default", // Nama bus event EventBridge yang menerima event dari DataWorks.
  "aliyunregionid": "cn-hangzhou", // Wilayah tempat event diterima.
  "aliyunpublishaddr": "172.25.XX.XX"
}

Pesan event berisi muatan dan metadata, seperti ID event, sumber event, dan waktu pembuatan. Tabel berikut menjelaskan field kunci.

Parameter	Tipe	Deskripsi
data	object	Muatan pesan event. Format dan field muatan bervariasi tergantung jenis event. Untuk informasi selengkapnya, lihat: Untuk format pesan event DataStudio, lihat Event DataStudio. Untuk format pesan event Integrasi Data, lihat Event Integrasi Data. Untuk format pesan event Pusat Operasi, lihat Event Pusat Operasi. Untuk format pesan event Pusat Keamanan, lihat Event Pusat Keamanan. Untuk format pesan event Kualitas Data, lihat Event Kualitas Data.
id	String	Pengidentifikasi unik yang digunakan untuk melacak event.
type	String	Jenis event, tercakup dalam `source`. Contoh: `dataworks:FileChange:CommitFile`: Menunjukkan bahwa file telah di-commit. `dataworks:FileChange:DeployFile`: Menunjukkan bahwa file telah diterapkan. Anda dapat menggunakan field ini di konsol EventBridge untuk memfilter event dari DataWorks. Nilai field ini bervariasi tergantung event. Untuk detailnya, lihat daftar event di topik ini.

Function Compute

Ketika Anda mengonfigurasi ekstensi di DataWorks untuk menggunakan Function Compute, DataWorks mengirim pesan JSON ke Function Compute ketika event titik ekstensi yang sesuai dipicu. Function Compute menerima pesan dalam format JSON berikut.

{
	"blockBusiness": true,
	"eventCategoryType": "resources-download", // Kategori event.
	"eventType": "upload-data-to-table", // Jenis event.
	"extensionBizId": "job_6603***070",
	"messageBody": {
             // Konten objek messageBody bervariasi tergantung jenis event. Field tenantId dan eventCode selalu disertakan. Untuk detail event spesifik, lihat daftar event di topik ini.
             "tenantId": 28378****10656, // ID penyewa. Di DataWorks, setiap akun Alibaba Cloud berkorespondensi dengan satu penyewa yang memiliki ID penyewa unik. Anda dapat menemukan ID penyewa Anda di bawah Info Pengguna pada profil pengguna di halaman DataStudio.
             "eventCode": "xxxx"
	},
	"messageId": "52d44ee7-b51f-4d4d-afeb-*******" // Pengidentifikasi unik untuk event.
}

Tabel berikut menjelaskan field kunci.

Parameter		Type	Description
messageId		String	Identifikasi unik yang digunakan untuk melacak event.
messageBody		Object	Muatan pesan, berisi data spesifik event dari DataWorks. Isinya bervariasi tergantung jenis event dan dapat digunakan saat Anda mengembangkan ekstensi Anda.
tenantId	String	ID penyewa. Di DataWorks, setiap Akun Alibaba Cloud merupakan penyewa dengan ID unik. Anda dapat menemukan ID penyewa Anda di bagian User Info pada profil pengguna di halaman DataStudio.
eventCode	String	Kode event. Bidang ini mengidentifikasi kategori tertentu dari pesan event. Untuk mengetahui kode event untuk setiap jenis event, lihat kolom Event code in Extensions pada tabel di topik ini.