Format pesan untuk EventBridge

Dokumen ini menjelaskan jenis event DataWorks, format pesannya, serta makna masing-masing field. Gunakan dokumen ini untuk menemukan dan mengkueri informasi mengenai daftar event dan format pesan secara cepat.

Pendahuluan

Di DataWorks, event diklasifikasikan sebagai event standar atau event titik ekstensi berdasarkan kemampuannya membuat checkpoint di dalam DataWorks dan mengembalikan hasil pemrosesan setelah disubscribe oleh layanan yang dikelola sendiri.

Event standar: Anda dapat berlangganan pesan event ini, tetapi event ini tidak dapat memblokir operasi di dalam DataWorks. Berlangganan event ini menggunakan OpenEvent. Untuk informasi selengkapnya, lihat OpenEvent.
Event titik ekstensi: Setelah berlangganan pesan event ini, Anda dapat menyesuaikan respons terhadap pesan event menggunakan fitur Extensions di Open Platform DataWorks. Saat Anda menggunakan Extensions untuk mengelola operasi pada titik ekstensi, operasi yang dilakukan pengguna platform DataWorks pada titik tersebut akan dihentikan sementara hingga ekstensi kustom Anda mengembalikan hasil pemrosesan.

Daftar berikut mengkategorikan event yang didukung berdasarkan modul dan menunjukkan apakah masing-masing merupakan event standar atau event titik ekstensi. Daftar ini juga mencantumkan tipe event EventBridge (Type) dan kode event ekstensi (eventCode).

Tipe event EventBridge (Type): Field yang digunakan untuk memfilter pesan event. Untuk detailnya, lihat Aktifkan langganan pesan.
Kode event ekstensi (eventCode): Kode event yang sesuai dengan tipe event tersebut. Selama pengembangan lokal, peroleh kode ini dari konten pesan yang dikirim oleh DataWorks untuk mengidentifikasi tipe event target.

Event tingkat ruang kerja

Event yang dihasilkan oleh modul tingkat ruang kerja disebut event tingkat ruang kerja, seperti event dari eksekusi node di Data Development atau perubahan status instance berulang di Operation Center. Gunakan daftar event berikut untuk mengidentifikasi mana yang merupakan event standar dan mana yang merupakan event titik ekstensi, beserta format pesannya.

Tab format pesan berikut hanya berisi konten sebagian. Untuk pesan lengkap yang dikirim ke EventBridge atau Function Compute, lihat Lampiran: Format Pesan.

Daftar event Data Development

Daftar event

Tipe event	Event (dan operasi pemicu)	Event standar	Event titik ekstensi	Tipe event EventBridge (Type)	Kode event ekstensi (eventCode)
Perubahan node	Buat node Buat node dan publikasikan ke lingkungan produksi			`dataworks:NodeChange:NodeChangeCreated`	`node-change-created`
Perubahan node	Perbarui node Modifikasi node di lingkungan pengembangan Publikasikan modifikasi ke lingkungan produksi			`dataworks:NodeChange:NodeChangeUpdated`	`node-change-updated`
Perubahan file Node Resource Function	Event pra-hapus file Hapus node di lingkungan pengembangan Catatan File yang dihapus dipindahkan ke Keranjang daur ulang.			`dataworks:FileChange:DeleteFile`	`delete-file`
	Event pra-commit file			`dataworks:FileChange:CommitFile`	`commit-file`
	Event pra-deploy file			`dataworks:FileChange:DeployFile`	`deploy-file`
	Event pra-eksekusi			`dataworks:FileChange:RunFile`	`run-file`
Perubahan tabel	Event pra-submit tabel untuk pengembangan			`dataworks:TableChange:CommitTable`	`commit-table`
Perubahan tabel	Event pra-deploy tabel ke lingkungan produksi			`dataworks:TableChange:DeployTable`	`deploy-table`

Format pesan

Event perubahan node (buat, perbarui)

Format payload pesan (konten field data dalam pesan event) untuk event pembuatan, modifikasi, dan penghapusan node ditunjukkan pada contoh berikut.

{
  "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", // Operator dari aksi ini
    "eventCode": "node-change-created",
    "repeatability": true,
    "modifyTime": 17***864,
    "createTime": 17***864,
    "tenantId": 28***656,
    "nodeId": 70***003,
    "projectId": 9***4
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
nodeName	String	Nama node.
programType	String	Tipe kode file. Panggil API ListFileType untuk mengkueri tipe kode file, atau lihat Tipe node yang didukung untuk tipe kode file.
cronExpress	String	Ekspresi cron untuk penjadwalan berulang. Parameter ini sesuai dengan pengaturan untuk tugas Data Development di atau konsol DataWorks. Setelah mengonfigurasi siklus penjadwalan dan waktu terjadwal, DataWorks secara otomatis menghasilkan ekspresi cron yang sesuai. Contoh: Jadwalkan setiap hari pukul 05.30 pagi: `00 30 05 * * ?` Jadwalkan pada menit ke-15 setiap jam: `00 15 * * * ?` Jadwalkan setiap 10 menit: `00 00/10 * * * ?` Jadwalkan setiap 10 menit antara pukul 08.00–17.00 setiap hari: `00 00-59/10 8-17 * * * ?` Jadwalkan secara otomatis pada pukul 00.20 tanggal 1 setiap bulan: `00 20 00 1 * ?` Jadwalkan setiap 3 bulan mulai dari pukul 00.10 tanggal 1 Januari: `00 10 00 1 1-12/3 ?` Jadwalkan secara otomatis pada pukul 00.05 setiap hari Selasa dan Jumat: `00 05 00 * * 2,5` Catatan Batasan ekspresi cron: Interval penjadwalan minimum adalah 5 menit. Waktu penjadwalan harian paling awal adalah pukul 00.05.
schedulerType	String	Tipe penjadwalan instance tugas. Nilai yang valid: 0: NORMAL. Tugas terjadwal normal. Tugas ini dijadwalkan setiap hari. 1: MANUAL. Tugas manual. Tugas ini tidak dijadwalkan setiap hari. 2: PAUSE. Tugas dibekukan. Tugas ini dijadwalkan setiap hari tetapi langsung ditandai gagal saat penjadwalan dimulai. 3: SKIP. Tugas dry-run. Tugas ini dijadwalkan setiap hari tetapi langsung ditandai berhasil saat penjadwalan dimulai. 4: SKIP_UNCHOOSE. Tugas yang tidak dipilih dalam alur kerja sementara. Hanya ada dalam alur kerja sementara dan langsung ditandai berhasil saat penjadwalan dimulai. 5: SKIP_CYCLE. Tugas mingguan atau bulanan yang belum memasuki siklus eksekusinya. Tugas ini dijadwalkan setiap hari tetapi langsung ditandai berhasil saat penjadwalan dimulai. 6: CONDITION_UNCHOOSE. Node downstream tidak dipilih oleh node IF upstream. Langsung diatur sebagai tugas dry-run. 7: REALTIME_DEPRECATED. Instance berulang kedaluwarsa yang dihasilkan secara real time. Langsung ditandai berhasil.
ownerId	String	ID pengguna Alibaba Cloud dari pemilik node. Jika parameter ini kosong, ID pengguna Alibaba Cloud dari pemanggil digunakan secara default.
priority	Integer	Prioritas tugas. Nilai yang valid: 1, 3, 5, 7, 8. Nilai yang lebih tinggi menunjukkan prioritas yang lebih tinggi.
baselineId	Long	ID garis dasar.
repeatability	Boolean	Apakah node dapat dijalankan berulang kali: true: Dapat dijalankan berulang kali. false: Tidak dapat dijalankan berulang kali.
modifyTime	Long	Waktu modifikasi terakhir node.
createTime	Long	Waktu pembuatan node.
nodeId	Long	ID node.
projectId	Long	ID ruang proyek tempat node berada.
tenantId	Long	ID penyewa tempat node tersebut berada.
operator	String	UID pengguna yang membuat, memodifikasi, atau menghapus node.
eventCode	String	Kode event ekstensi.

Event perubahan file (commit, deploy, run, delete)

Format payload pesan (konten field data dalam pesan event) untuk event commit dan deploy file ditunjukkan pada contoh berikut.

{
  "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
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
operator	String	UID pengguna yang melakukan commit atau deploy file.
projectId	Long	ID ruang proyek tempat file tersebut berada.
tenantId	Long	ID penyewa.
nodeId	Long	ID node penjadwalan.
fileType	Long	Tipe kode file. Panggil API ListFileType untuk mengkueri tipe kode file, atau lihat Tipe node yang didukung untuk tipe kode file.
fileName	String	Nama file.
fileOwner	String	Pemilik file.
extensionBizId	String	ID proses checkpoint ekstensi.
changeType	String	Tipe perubahan file: 0: Buat file. 1: Perbarui file. 2: Hapus file.
fileCreateTime	String	Waktu pembuatan file 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 ekstensi.

Format payload pesan (konten field data dalam pesan event) untuk event hapus dan run file ditunjukkan pada contoh berikut.

{
  "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 pembuatan file
    "tenantId": 28***656,
    "fileOwner": "19***735", // Pemilik file
    "nodeId": 70***003,
    "projectId": 9***4,
    "fileType": 10,
    "fileId": 50***830,
    "resourceType": 1
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
operator	String	UID pengguna yang menghapus atau menjalankan file.
projectId	Long	ID ruang proyek tempat file tersebut berada.
tenantId	Long	ID penyewa.
nodeId	Long	ID node penjadwalan.
fileType	Long	Tipe kode file. Panggil API ListFileType untuk mengkueri tipe kode file, atau lihat Tipe node yang didukung untuk tipe kode file.
fileName	String	Nama file.
fileOwner	String	Pemilik file.
extensionBizId	String	ID proses checkpoint ekstensi.
fileCreateTime	String	Waktu pembuatan file dalam format `yyyy-MM-dd HH:mm:ss`.
fileId	Long	ID file.
eventCode	String	Kode event ekstensi.

Event perubahan tabel (commit tabel ke pengembangan, deploy tabel ke produksi)

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

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
operator	String	UID pengguna yang melakukan commit atau deploy tabel.
projectId	Long	ID ruang proyek.
tenantId	Long	ID penyewa.
extensionBizId	String	ID proses checkpoint ekstensi.
tableName	String	Nama tabel.
tableType	String	Tipe tabel. Nilai yang valid: ODPS.
maxComputeProject	String	Nama proyek MaxCompute yang sesuai.

Daftar event Data Integration

Daftar event

Tipe event

Event (dan operasi pemicu)

Event standar

Event titik ekstensi

Tipe event EventBridge

(Type)

Tipe event ekstensi (eventCode)

Event perubahan node

Mulai job

dataworks:NodeChange:StartDiJob

start-diJob

Batch mulai job

dataworks:NodeChange:BatchStartDiJob

batch-start-diJob

Format pesan

Event perubahan node-Mulai job

Format payload pesan (konten field data dalam pesan event) untuk event perubahan node - mulai job ditunjukkan pada contoh berikut.

## message v1 job start with no more than 500 tables
{
    "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"
    }
}

## message v2 job start with no more than 500 tables
{
    "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"
            }
        ]
    }
}

##message v2 job start with more than 500 tables, "showTableMapping": 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"
        }
    }
}

## Regular expression
{
    "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"
    }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
projectId	Long	ID ruang proyek DataWorks.
operator	String	UID pengguna operator.
extensionBizName	String	Nama solusi.
showTableMapping	Boolean	Apakah mengembalikan informasi pemetaan tabel. true: Kembalikan. false: Jangan kembalikan. Jika melibatkan lebih dari 500 tabel, showTableMapping secara default bernilai `false`.
tableMapping	JSONArray	Hubungan pemetaan tabel.
srcDatasourceName	String	Nama sumber data sumber.
srcDatabaseName	String	Nama database sumber.
srcTable	String	Nama tabel sumber.
dstDatasourceName	String	Nama sumber data tujuan.
dstTable	String	Nama tabel tujuan.
tenantId	Long	ID penyewa.
eventCode	String	Kode event ekstensi.

Event perubahan Node-Memulai Pekerjaan Batch

Format payload pesan (konten field data dalam pesan event) untuk event perubahan node - batch mulai job ditunjukkan pada contoh berikut.

{
    "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
    }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
projectId	Long	ID ruang proyek DataWorks.
operator	String	UID pengguna operator.
extensionBizName	String	Nama solusi.
setting	JSONObject	Item konfigurasi startup.
startDateTime	String	Waktu mulai.
timeZone	String	Atur zona waktu.
tableMapping	JSONArray	Hubungan pemetaan tabel.
srcDatasourceName	String	Nama sumber data sumber.
srcDatabaseName	String	Nama database sumber.
srcTable	String	Nama tabel sumber.
dstDatasourceName	String	Nama sumber data tujuan.
dstTable	String	Nama tabel tujuan.
showTableMapping	Boolean	Apakah mengembalikan informasi pemetaan tabel. true: Kembalikan. false: Jangan kembalikan. Jika melibatkan lebih dari 500 tabel, showTableMapping secara default bernilai `false`.
tenantId	Long	ID penyewa.
eventCode	String	Kode event ekstensi.

Daftar event Operation Center

Daftar event

Penting

Memodifikasi kelompok sumber daya penjadwalan atau pemilik akan memicu node-change-updated.

Tipe event	Event (dan operasi pemicu)	Event standar	Extension point event	Tipe event EventBridge (Type)	Tipe event ekstensi (eventCode)
Perubahan node	Hapus node Publikasikan operasi hapus ke lingkungan produksi untuk membatalkan publikasi node produksi Hapus node dari Keranjang daur ulang			`dataworks:NodeChange:NodeChangeDeleted`	`node-change-deleted`
	Event pra-unpublish node Langsung batalkan publikasi node berulang di lingkungan produksi Catatan Operasi ini secara sinkron menghapus node di Data Development dan memindahkannya ke Keranjang daur ulang.			`dataworks:NodeChange:UndeployNode`	`undeploy-node`
	Event pra-bekukan node Penting Event ini secara sinkron memicu event node-change-updated.			`dataworks:NodeChange:FreezeNode`	`freeze-node`
	Event pra-unfreeze node Penting Event ini secara sinkron memicu event node-change-updated.			`dataworks:NodeChange:UnFreezeNode`	`unfreeze-node`
Backfill data	Event pra-backfill data			`dataworks:BackfillDataOperate:BackfillData`	`backfill-data`
Perubahan status tugas	Perubahan status tugas penjadwalan			`dataworks:InstanceStatusChanges:InstanceStatusChanges`	`instance-status-changes`
Perubahan instance	Bekukan instance			`dataworks:InstanceChange:FreezeInstance`	`freeze-instance`
	Unfreeze instance			`dataworks:InstanceChange:UnfreezeInstance`	`unfreeze-instance`
	Kill instance			`dataworks:InstanceChange:KillInstance`	`kill-instance`
	Rerun instance Rerun Rerun downstream			`dataworks:InstanceChange:RerunInstance`	`rerun-instance`
	Instance berhasil			`dataworks:InstanceChange:SetInstanceSuccess`	`set-instance-success`
	Hapus dependensi upstream yang ditentukan dari instance			`dataworks:InstanceChange:DeleteTaskInstanceDependencies`	`delete-task-instance-dependencies`
	Event pra-bekukan instance			`dataworks:InstanceChange:PreFreezeInstance`	`pre-freeze-instance`
	Event pra-unfreeze instance			`dataworks:InstanceChange:PreUnfreezeInstance`	`pre-unfreeze-instance`
	Event pra-rerun instance			`dataworks:InstanceChange:PreRerunInstance`	`pre-rerun-instance`
	Event pra-set instance success			`dataworks:InstanceChange:PreSetInstanceSuccess`	`pre-set-instance-success`
	Event pra-kill instance			`dataworks:InstanceChange:PreKillInstance`	`pre-kill-instance`
	Hapus instance kedaluwarsa			`dataworks:InstanceChange:ExpiredTaskInstancesDeleted`	`expired-task-instances-deleted`
Perubahan status alur kerja	Perubahan status alur kerja Instance backfill data Alur kerja yang dipicu secara manual			`dataworks:DagStatusChanges:DagStatusChanges`	`dag-status-changes`
Monitoring dan alert	Monitoring dan alert			`dataworks:MonitorAlert:WorkbenchMonitorAlert`	`workbench-monitor-alert`

Format pesan

Event perubahan node (hapus, unpublish, bekukan, unfreeze)

Format payload pesan (konten field data dalam pesan event) untuk event penghapusan node ditunjukkan pada contoh 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"  // Operator dari aksi ini
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe field	Deskripsi
nodeName	String	Nama node.
programType	String	Tipe kode file. Panggil API ListFileType untuk mengkueri tipe kode file, atau lihat Tipe node yang didukung untuk tipe kode file.
cronExpress	String	Ekspresi cron untuk penjadwalan berulang. Parameter ini sesuai dengan pengaturan untuk tugas Data Development di Konsol DataWorks. Setelah mengonfigurasi siklus penjadwalan dan waktu terjadwal, DataWorks secara otomatis menghasilkan ekspresi cron yang sesuai. Contoh: Jadwalkan setiap hari pukul 05.30 pagi: `00 30 05 * * ?` Jadwalkan pada menit ke-15 setiap jam: `00 15 * * * ?` Jadwalkan setiap 10 menit: `00 00/10 * * * ?` Jadwalkan setiap 10 menit antara pukul 08.00–17.00 setiap hari: `00 00-59/10 8-17 * * * ?` Jadwalkan secara otomatis pada pukul 00.20 tanggal 1 setiap bulan: `00 20 00 1 * ?` Jadwalkan setiap 3 bulan mulai dari pukul 00.10 tanggal 1 Januari: `00 10 00 1 1-12/3 ?` Jadwalkan secara otomatis pada pukul 00.05 setiap hari Selasa dan Jumat: `00 05 00 * * 2,5` Catatan Batasan ekspresi cron: Interval penjadwalan minimum adalah 5 menit. Waktu penjadwalan harian paling awal adalah pukul 00.05.
schedulerType	String	Tipe penjadwalan instance tugas. Nilai yang valid: 0: NORMAL. Tugas terjadwal normal. Tugas ini dijadwalkan setiap hari. 1: MANUAL. Tugas manual. Tugas ini tidak dijadwalkan setiap hari. 2: PAUSE. Tugas dibekukan. Tugas ini dijadwalkan setiap hari tetapi langsung ditandai gagal saat penjadwalan dimulai. 3: SKIP. Tugas dry-run. Tugas ini dijadwalkan setiap hari tetapi langsung ditandai berhasil saat penjadwalan dimulai. 4: SKIP_UNCHOOSE. Tugas yang tidak dipilih dalam alur kerja sementara. Hanya ada dalam alur kerja sementara dan langsung ditandai berhasil saat penjadwalan dimulai. 5: SKIP_CYCLE. Tugas mingguan atau bulanan yang belum memasuki siklus eksekusinya. Tugas ini dijadwalkan setiap hari tetapi langsung ditandai berhasil saat penjadwalan dimulai. 6: CONDITION_UNCHOOSE. Node downstream tidak dipilih oleh node IF upstream. Langsung diatur sebagai tugas dry-run. 7: REALTIME_DEPRECATED. Instance berulang kedaluwarsa yang dihasilkan secara real time. Langsung ditandai berhasil.
ownerId	String	ID pengguna Alibaba Cloud dari pemilik node. Jika parameter ini kosong, ID pengguna Alibaba Cloud dari pemanggil digunakan secara default.
priority	Integer	Prioritas tugas. Nilai yang valid: 1, 3, 5, 7, 8. Nilai yang lebih tinggi menunjukkan prioritas yang lebih tinggi.
baselineId	Long	ID garis dasar.
repeatability	Boolean	Apakah node dapat dijalankan berulang kali: true: Dapat dijalankan berulang kali. false: Tidak dapat dijalankan berulang kali.
modifyTime	Long	Waktu modifikasi terakhir node.
createTime	Long	Waktu pembuatan node.
nodeId	Long	ID node.
projectId	Long	ID ruang proyek tempat node berada.
tenantId	Long	ID penyewa tempat node tersebut berada.
operator	String	UID pengguna yang membuat, memodifikasi, atau menghapus node.

Format payload pesan (konten field data dalam pesan event) untuk event membekukan, mengembalikan, dan membatalkan publikasi node ditunjukkan pada contoh berikut.

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

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
operator	String	UID pengguna yang membekukan, mengembalikan, atau membatalkan publikasi node.
projectId	Long	ID ruang proyek tempat node berada.
tenantId	Long	ID penyewa.
nodeIds	Array	Daftar ID node yang dioperasikan.
extensionBizId	String	ID proses checkpoint ekstensi.

Backfill data

Format payload pesan (konten field data dalam pesan event) untuk operasi backfill data ditunjukkan pada contoh berikut.

{
  "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"
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe field	Deskripsi
name	String	Nama alur kerja backfill data.
rootNodeId	Long	ID node root alur kerja backfill data.
rootNodeProjectId	Long	ID ruang proyek tempat node root alur kerja backfill data berada.
includeNodeIds	Array	Daftar ID node untuk backfill data.
excludeNodeIds	Array	Daftar ID node yang dikecualikan dari backfill data. Node dalam daftar ini menghasilkan instance dry-run yang langsung ditandai berhasil saat penjadwalan tanpa mengeksekusi konten skrip.
bizBeginTime	String	Waktu mulai tugas. Hanya diperlukan untuk tugas terjadwal per jam. Format: `HH:mm:ss`. Rentang valid: 00:00:00~23:59:59.
bizEndTime	String	Waktu akhir tugas. Hanya diperlukan untuk tugas terjadwal per jam. Format: `HH:mm:ss`. Rentang valid: 00:00:00~23:59:59.
isParallel	Boolean	Apakah operasi backfill data dapat dijalankan secara paralel: true: Dapat dijalankan secara paralel. false: Tidak dapat dijalankan secara paralel.
parallelGroup	Integer	Jumlah grup paralel. 1 berarti tidak dikelompokkan.
startFutureInstanceImmediately	Boolean	Apakah melewati waktu terjadwal dan langsung menjalankan instance mendatang: true: Lewati waktu terjadwal dan eksekusi instance mendatang segera. false: Jangan lewati waktu terjadwal. Instance mendatang tidak dieksekusi segera.
order	String	Urutan eksekusi backfill data berdasarkan tanggal bisnis: acs: Jalankan dalam urutan tanggal bisnis menaik. desc: Jalankan dalam urutan tanggal bisnis menurun.
multipleTimePeriods	String	Pilih tanggal bisnis dalam segmen. Contoh: `[{\"bizBeginTime\":\"2022-04-17\",\"bizEndTime\":\"2022-04-17\"}]`.
tenantId	Long	ID penyewa.
projectId	Long	ID proyek tempat operasi backfill data dilakukan.
operator	String	ID pengguna yang melakukan operasi backfill data.
extensionBizId	String	ID proses checkpoint ekstensi.
eventCode	String	Kode event ekstensi.

Event perubahan status tugas

Format payload pesan (konten field data dalam pesan event) untuk event perubahan status tugas penjadwalan ditunjukkan pada contoh berikut.

{
  "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
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
finishTime	Long	Waktu pasti saat instance tugas penjadwalan selesai berjalan.
beginWaitTimeTime	Long	Waktu pasti saat instance tugas penjadwalan mulai menunggu untuk dijalankan.
beginRunningTime	Long	Waktu pasti saat instance tugas penjadwalan mulai berjalan.
dagId	Long	Detail Dag dapat diambil menggunakan `DagId`.
dagType	Integer	Tipe Dag. Nilai yang valid: 0: Tugas terjadwal berulang 1: Tugas manual 2: Smoke testing 3: Backfill data 4: Alur kerja sementara 5: Alur kerja yang dipicu secara manual
taskType	Integer	Tipe penjadwalan instance tugas. Nilai yang valid: 0: NORMAL. Tugas terjadwal normal. Tugas ini dijadwalkan setiap hari. 1: MANUAL. Tugas manual. Tugas ini tidak dijadwalkan setiap hari. 2: PAUSE. Tugas dibekukan. Tugas ini dijadwalkan setiap hari tetapi langsung ditandai gagal saat penjadwalan dimulai. 3: SKIP. Tugas dry-run. Tugas ini dijadwalkan setiap hari tetapi langsung ditandai berhasil saat penjadwalan dimulai. 4: SKIP_UNCHOOSE. Tugas yang tidak dipilih dalam alur kerja sementara. Hanya ada dalam alur kerja sementara dan langsung ditandai berhasil saat penjadwalan dimulai. 5: SKIP_CYCLE. Tugas mingguan atau bulanan yang belum memasuki siklus eksekusinya. Tugas ini dijadwalkan setiap hari tetapi langsung ditandai berhasil saat penjadwalan dimulai. 6: CONDITION_UNCHOOSE. Node downstream tidak dipilih oleh node IF upstream. Langsung diatur sebagai tugas dry-run. 7: REALTIME_DEPRECATED. Instance berulang kedaluwarsa yang dihasilkan secara real time. Langsung ditandai berhasil.
modifyTime	Long	Waktu modifikasi terakhir instance tugas.
createTime	Long	Waktu pembuatan instance tugas.
appId	Long	ID ruang kerja. Panggil ListProjects untuk melihat informasi ID ruang kerja.
tenantId	Long	ID penyewa ruang kerja tempat instance tugas penjadwalan berada.
opCode	Integer	Kode operasi instance tugas penjadwalan. Field ini dapat diabaikan.
flowId	Long	ID alur kerja. Instance tugas terjadwal berulang: ID alur kerja secara default adalah 1. Instance tugas penjadwalan untuk alur kerja yang dipicu secara manual dan alur kerja internal: ID alur kerja aktual.
nodeId	Long	ID node yang sesuai dengan instance tugas penjadwalan.
beginWaitResTime	Long	Waktu pasti saat instance tugas penjadwalan mulai menunggu sumber daya.
taskId	Long	ID instance tugas penjadwalan.
status	Integer	Status tugas. Nilai yang valid: 1: Tidak berjalan. 2: Menunggu waktu terjadwal dueTime atau cycleTime tiba. 3: Menunggu sumber daya. 4: Berjalan. 7: Dikirim ke Kualitas Data untuk validasi data. 8: Melakukan validasi kondisi cabang. 5: Eksekusi gagal. 6: Eksekusi berhasil.
eventCode	String	Kode event ekstensi.

Event perubahan instans (membekukan, melepas pembekuan, menghentikan, menjalankan ulang, atur keberhasilan)

Format payload pesan (konten field data dalam pesan event) untuk event perubahan instance ditunjukkan pada contoh berikut.

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

Deskripsi field adalah sebagai berikut:

Nama field	Tipe Bidang	Deskripsi
operator	String	UID pengguna yang melakukan operasi (bekukan, unfreeze, kill, rerun, set success, dll.) pada instance.
projectType	String	Lingkungan runtime. PROD: Lingkungan produksi. DEV: Lingkungan pengembangan.
taskIds	List<Long>	Sekumpulan ID instance.
projectId	Long	ID ruang proyek DataWorks.
tenantId	Long	ID penyewa ruang kerja tempat instance berada.
eventCode	String	Kode event.

Event pra-perubahan instance (bekukan, unfreeze, rerun, set success, kill instance)

Format payload pesan (konten field data dalam pesan event) untuk event pra-perubahan instance ditunjukkan pada contoh berikut.

{
  "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"
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
extensionBizId	String	ID proses checkpoint ekstensi.
extensionBizName	String	Nama objek operasi. Beberapa objek dijelaskan sebagai "nama objek...".
projectId	Long	ID ruang proyek DataWorks.
taskIds	List<Long>	Sekumpulan ID instance.
tenantId	String	ID penyewa ruang kerja tempat instance berada.
operator	Long	UID pengguna yang mengoperasikan instance.
eventCode	String	Kode event titik ekstensi.

Event perubahan instans-Hapus instans yang kedaluwarsa

Format payload pesan (konten field data dalam pesan event) untuk event hapus instance kedaluwarsa ditunjukkan pada contoh berikut.

{
    "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
    }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
deletedTaskInstanceIds	List	Daftar ID instance yang dihapus.
owner	String	ID pengguna pemilik instance.
operationTime	Long	Waktu operasi.
blockBusiness	Boolean	Jika ekstensi ada, apakah proses dihentikan. true: Hentikan. false: Jangan hentikan.
appId	Long	ID ruang proyek DataWorks.
tenantId	String	ID penyewa ruang kerja tempat instance berada.
operator	Long	UID pengguna yang mengoperasikan instance.
eventCode	String	Kode event titik ekstensi.

Event menghapus hubungan dependensi upstream yang ditentukan

Format payload pesan (konten field data dalam pesan event) untuk menghapus hubungan dependensi upstream yang ditentukan ditunjukkan pada contoh berikut:

{
    "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
    }
}

Deskripsi field adalah sebagai berikut:

Nama bidang	Tipe bidang	Deskripsi
taskInstanceId	Long	ID instance downstream.
upstreamTaskInstanceIds	List	Daftar ID instance upstream yang hubungan dependensinya dihapus.
operator	String	UID pengguna operator.
operationTime	Long	Waktu operasi.

Event perubahan status alur kerja

Format payload pesan (konten field data dalam pesan event) untuk event perubahan status alur kerja ditunjukkan pada contoh berikut.

{
  "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
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe field	Deskripsi
bizDate	String	Tanggal bisnis alur kerja. Format: `yyyy-mm-dd hh24:mi:ss`.
createTime	String	Waktu pembuatan alur kerja. Format: `yyyy-mm-dd hh24:mi:ss`.
dagId	Long	DagId. Detail Dag dapat diambil menggunakan DagId.
dagName	String	Nama alur kerja.
dagType	Integer	Tipe Dag. Nilai yang valid: 0: Tugas terjadwal berulang. 1: Tugas manual. 2: Pengujian asap. 3: Backfill data. 4: Alur kerja sementara. 5: Alur kerja yang dipicu secara manual.
flowId	Integer	ID alur kerja yang sesuai dengan alur bisnis.
flowName	String	Nama alur bisnis yang sesuai dengan alur kerja.
operator	String	UID pengguna yang membuat alur kerja.
projectEnv	String	Lingkungan tempat alur kerja berada. Nilai yang valid: DEV: Lingkungan pengembangan. PROD: Lingkungan produksi.
tenantId	Long	ID penyewa ruang kerja tempat instance tugas penjadwalan berada.
projectId	Long	ID ruang kerja.
status	Integer	Status tugas dalam alur kerja. Nilai yang valid: 1: Tidak berjalan. 4: Berjalan. 5: Eksekusi gagal. 6: Eksekusi berhasil.
eventCode	String	Kode event ekstensi.

Monitoring dan alert

Format payload pesan (konten field data dalam pesan) untuk alert garis dasar ditunjukkan pada contoh berikut.

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

Deskripsi field ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
alarmType	String	Tipe alert. 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: Tidak normal. 1: Aman. 2: Peringatan. 3: Ganti baris.
bizDate	Long	Timestamp tanggal bisnis.
inGroupId	Integer	Nomor periode instance garis dasar. Garis dasar harian menggunakan `1`. Garis dasar per jam berkisar dari `[1,24]`.
nodeId	Long	ID node yang menyebabkan anomali garis dasar.
projectId	Long	ID ruang proyek tempat garis dasar berada.
taskId	Long	ID instance yang menyebabkan anomali garis dasar.
tenantId	Long	ID penyewa.
eventCode	String	Kode event ekstensi.

Format payload pesan (konten field data dalam pesan) untuk alert event ditunjukkan pada contoh 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
  }
}

Deskripsi field ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
alarmType	String	Tipe alert. Nilai yang valid: SLA_ALERT REMIND_ALERT TOPIC_ALERT
topicId	Long	ID event.
taskStatus	String	Status instans node yang memicu event.
nodeId	Integer	ID node yang memicu event.
projectId	Long	ID ruang proyek tempat node yang memicu event berada.
taskId	Long	ID instance node yang memicu event.
tenantId	Long	ID penyewa.

Format payload pesan (konten field data dalam pesan) untuk alert aturan tugas ditunjukkan pada contoh berikut.

Catatan

Umumnya, objek aturan mencakup node tugas, garis dasar, ruang kerja, dan alur bisnis.

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

Deskripsi field ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
alarmType	String	Tipe alert. Nilai yang valid: SLA_ALERT REMIND_ALERT TOPIC_ALERT
nodeIds	String	Daftar node yang memicu alert aturan.
remindId	Long	ID aturan.
remindType	Stirng	Kondisi pemicu aturan. Nilai yang valid: FINISHED: Selesai. UNFINISHED: Belum selesai. ERROR: Error eksekusi. CYCLE_UNFINISHED: Siklus belum selesai. TIMEOUT: Timeout eksekusi.
projectId	Long	ID ruang proyek tempat node yang memicu aturan berada.
remindUnit	String	Tipe objek yang memicu aturan. Nilai yang valid: NODE: Node tugas. GATEWAY_RES: Kelompok sumber daya penjadwalan eksklusif. DI_RES: Kelompok sumber daya Data Integration.
tenantId	Long	ID penyewa.
taskId	String	Daftar instance yang memicu peringatan aturan.
remindName	String	Nama aturan.

Format payload pesan (konten field data dalam pesan) untuk alert aturan kelompok sumber daya ditunjukkan pada contoh berikut.

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

Deskripsi field ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
alarmType	String	Tipe alert. Nilai yang valid: SLA_ALERT REMIND_ALERT TOPIC_ALERT
remindId	Long	ID aturan.
remindType	Stirng	Kondisi pemicu aturan. Nilai yang valid: FINISHED: Selesai. UNFINISHED: Belum selesai. ERROR: Error eksekusi. CYCLE_UNFINISHED: Siklus belum selesai. TIMEOUT: Timeout eksekusi. RES_GROUP_THRESHOL: Utilisasi kelompok sumber daya. RES_GROUP_WAIT_AMOUNT: Jumlah instance yang menunggu sumber daya dalam kelompok sumber daya.
projectId	Long	ID ruang proyek tempat node yang memicu aturan berada.
remindUnit	String	Tipe objek yang memicu aturan. Nilai yang valid: NODE: Node tugas. GATEWAY_RES: Kelompok sumber daya penjadwalan eksklusif. DI_RES: Kelompok sumber daya Data Integration.
tenantId	Long	ID penyewa.
remindName	String	Nama aturan.
resourceGroupIdentifier	String	Identifier unik kelompok sumber daya.
resourceGroupName	String	Nama kelompok sumber daya.
resourceGroupType	String	Tipe kelompok sumber daya. Nilai yang valid: GATEWAY: Kelompok sumber daya penjadwalan. DI: Kelompok sumber daya Data Integration.

Daftar event Security Center

Daftar event

Jenis Peristiwa	Event (dan operasi pemicu)	Event standar	Event titik ekstensi	Tipe event EventBridge (Type)	Tipe pesan ekstensi (eventCode)
Approval Center	Event pra-buat formulir permohonan izin			`dataworks:ApprovalChange:ApprovalChangeCreated`	`approval-change-created`
Approval Center	Lengkapi formulir aplikasi			`dataworks:ApprovalChange:ApprovalChangeFinished`	`approval-change-finished`
Security Center (permohonan izin tabel)	Event pra-permohonan izin tabel			`dataworks:ApprovalChange:ApprovalChangeBeforeCreate`	`approval-change-before-create`

Format pesan

Approval Center (buat, lengkapi formulir aplikasi)

Format payload pesan (konten field data dalam pesan event) untuk event pra-buat formulir permohonan izin ditunjukkan pada contoh 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
    }

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
appId	Long	ID ruang kerja.
assignee	String	BaseId dari approver untuk permintaan persetujuan.
assigneeName	String	Nama approver.
comments	String	Informasi komentar.
createTime	Long	Timestamp pembuatan formulir aplikasi.
processId	String	ID formulir persetujuan.
status	String	Status formulir persetujuan.
taskId	String	ID tugas persetujuan.
tenantId	String	ID penyewa.
updateTime	String	Timestamp pembaruan formulir persetujuan.
eventType	String	Tipe event.
process	Object	Objek tugas persetujuan.
applicant	String	Request BaseID.
applicantName	String	Nama pemohon.
assignmentCategory	String	Tipe konten aplikasi.
createTime	String	Timestamp pembuatan formulir persetujuan.
processDefinitionId	String	ID definisi alur kerja.
processId	String	ID alur kerja.
status	String	Status alur kerja.
title	String	Judul alur kerja.
updateTime	Long	Timestamp pembaruan formulir persetujuan.
approvalContent	Object	Objek konten persetujuan.
applyPeriod	String	Durasi aplikasi formulir persetujuan.
applyReason	String	Alasan aplikasi formulir persetujuan.
contentType	String	Tipe konten persetujuan.
odpsProjectName	String	Nama proyek persetujuan.
resourceSummary	String	Deskripsi resource.
tenantId	Long	ID penyewa.
workspaceId	Long	ID ruang kerja.
projectEnv	String	Lingkungan tempat proyek persetujuan berada.
granteeAccounts	Array	Daftar otorisasi.
.granteeId	String	ID subjek otorisasi.
granteeType	String	Tipe otorisasi.
granteeTypeSub	String	Subtipe subjek otorisasi.
granteeName	String	Nama subjek otorisasi.
arrayData	Array	Daftar konten otorisasi. Untuk detailnya, lihat Referensi Pengembangan: Daftar Event dan Format Pesan.
eventType	String	Tipe event.

Format payload pesan (konten field data dalam pesan event) untuk event lengkapi formulir persetujuan ditunjukkan pada contoh berikut.

{
  "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
    }
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe field	Deskripsi
appId	Long	ID ruang kerja.
assignee	String	BaseId dari approver formulir persetujuan.
assigneeName	String	Nama approver.
comments	String	Informasi komentar.
createTime	Long	Timestamp pembuatan formulir persetujuan.
processId	String	ID formulir persetujuan.
status	String	Status formulir persetujuan.
taskId。	String	ID tugas persetujuan.
tenantId	String	ID penyewa.
updateTime	String	Timestamp pembaruan terbaru formulir persetujuan.
eventType	String	Tipe event.
process	Object	Objek tugas persetujuan.
applicant	String	Request a BaseID.
applicantName	String	Nama pemohon.
assignmentCategory	String	Tipe konten aplikasi.
createTime	String	Timestamp pembuatan formulir persetujuan.
processDefinitionId	String	ID definisi alur kerja.
processId	String	ID alur kerja.
status	String	Status alur kerja.
title	String	Judul alur kerja.
updateTime	Long	Timestamp pembaruan formulir persetujuan.
approvalContent	Object	Objek konten persetujuan.
applyPeriod	String	Durasi aplikasi.
applyReason	String	Alasan aplikasi.
contentType	String	Tipe konten.
odpsProjectName	String	Nama proyek.
resourceSummary	String	Deskripsi resource.
tenantId	Long	ID penyewa.
workspaceId	Long	ID ruang kerja.
projectEnv	String	Lingkungan kepemilikan.
granteeAccounts	Array	Daftar otorisasi.
granteeId	String	ID subjek otorisasi.
granteeType	String	Tipe otorisasi.
granteeTypeSub	String	Subtipe subjek otorisasi. Yaitu, tipe akun otorisasi, sebagai berikut: Akun cloud produksi (akun yang digunakan untuk penjadwalan produksi): ACCOUNT_PRD(101) Akun cloud aplikasi: ACCOUNT_APP(102) Akun cloud pribadi: ACCOUNT_USER(103) Akun cloud departemen: ACCOUNT_DEPT(104) Akun MOCK: ACCOUNT_MOCK(106) Akun cloud pengguna lain: ACCOUNT_OTHER_USER(105)
granteeName	String	Nama subjek otorisasi.
arrayData	Array	Daftar konten otorisasi. Untuk detailnya, lihat Referensi Pengembangan: Daftar Event dan Format Pesan.
eventType	String	Tipe event.

Security Center (Event pra-permohonan izin tabel)

Format payload pesan (konten field data dalam pesan event) untuk event pra-permohonan izin tabel ditunjukkan pada contoh berikut.

{
  "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
  }
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
operator	String	UID pengguna yang melakukan operasi pra-permohonan izin tabel.
projectId	Long	ID ruang kerja tempat operasi pra-permohonan izin tabel dilakukan.
tenantId	Long	ID penyewa tempat operasi pra-permohonan izin tabel dilakukan.
order	Object	Informasi formulir aplikasi.
applyReason	String	Alasan aplikasi.
deadlineDate	String	Periode validitas formulir aplikasi.
deadlineType	String	Unit waktu untuk periode validitas formulir aplikasi. Misalnya, Day, Month.
granteeObjectList	Object	Daftar objek otorisasi.
granteeId	String	ID objek otorisasi, yaitu ID Pengguna RAM.
projectMeta	Object	Informasi ruang kerja.
envCode	Integer	Identifier lingkungan ruang kerja. 0 menunjukkan lingkungan pengembangan, 1 menunjukkan lingkungan produksi.
labelSecurity	Boolean	Apakah kontrol tingkat label diaktifkan: true: Diaktifkan. false: Dinonaktifkan.
objectMetaList	Array	Daftar objek otorisasi.
action	Array	Aksi otorisasi. Misalnya, memberikan izin Select atau Describe pada tabel.
name	String	Nama tabel yang diminta izinnya.
projectGuid	String	Guid ruang kerja tempat tabel berada.
projectName	String	Nama ruang kerja tempat tabel berada.
eventType	String	Tipe event.

Lampiran: Daftar konten otorisasi (MaxCompute)

Ketika DataWorks memicu persetujuan dan permohonan izin tabel di Security Center, pesan event yang dikirim ke EventBridge mencakup arrayData. Ketika tipe assignmentCategory adalah MaxCompute, konten arrayData adalah 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"
  }

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
ownerBaseId	String	BaseID pemilik tabel.
ownerAccountName	String	Nama pemilik tabel.
objectType	String	Tipe objek.
odpsTable	String	Nama tabel.
envType	String	Lingkungan tempat tabel berada.
projectGuid	String	Guid proyek.
objectGuid	String	Guid objek.
objectName	String	Nama objek.
odpsProject	String	Nama proyek ODPS.
projectName	String	Kode proyek.
projectId	Long	ID proyek.
workspaceId	String	ID ruang kerja.
actions	Array	Daftar tipe aksi.

Lampiran: Daftar konten otorisasi (DataService)

Ketika DataWorks memicu persetujuan dan permohonan izin tabel di Security Center, pesan event yang dikirim ke EventBridge mencakup arrayData. Ketika tipe assignmentCategory adalah DataService, konten 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":"******"
  }

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
resourceId	String	ID resource.
ownerName	String	Nama pemilik resource.
resourceVersion	Long	Versi resource.
name	String	Nama resource.
dsDeployId	String	ID deployment layanan data.
workspaceName	String	Nama ruang kerja.
id	String	ID resource unik.
type	String	Tipe resource. Nilai yang valid: 1: API. 2: Function. 3: Orkestrasi layanan.
ownerId	String	BaseID pemilik resource.
url	String	URL layanan data.
workspaceId	String	ID ruang kerja.

Daftar event Kualitas Data

Daftar event

Tipe event	Event (dan operasi pemicu)	Event standar	Event titik ekstensi	Tipe event EventBridge (Type)	Tipe event ekstensi (eventCode)
Validasi kualitas data	Umpan balik hasil validasi Umpan balik pengguna terhadap hasil validasi			`dataworks:DqcCheck:DqcCheckFeedbackEvent`	`dqc-check-feedback-event`
Validasi kualitas data	Validasi selesai Validasi aturan selesai. Mengirimkan hasil validasi aturan (apakah lolos, sampel, dll.)			`dataworks:DqcCheck:DqcCheckFinishedEvent`	`dqc-check-finished-event`
Pra-pemeriksaan Aturan Kualitas Data	Event pra-buat batch aturan kualitas data			`dataworks:DqcCheck:BatchCreateDataQualityRules`	`batch-create-data-quality-rules`
	Event pra-perbarui batch aturan kualitas data			`dataworks:DqcCheck:BatchUpdateDataQualityRules`	`batch-update-data-quality-rules`
	Event pra-hapus batch aturan kualitas data			`dataworks:DqcCheck:BatchDeleteDataQualityRules`	`batch-delete-data-quality-rules`
	Event pra-perbarui aturan kualitas data			`dataworks:DqcCheck:UpdateDataQualityRule`	`update-data-quality-rule`
Pra-operasi monitoring kualitas data	Event pra-buat monitoring kualitas data			`dataworks:DqcCheck:CreateDataQualityEvaluationTask`	`create-data-quality-evaluation-task`
	Event pra-perbarui monitoring kualitas data			`dataworks:DqcCheck:UpdateDataQualityEvaluationTask`	`update-data-quality-evaluation-task`
	Event pra-kloning monitoring kualitas data			`dataworks:DqcCheck:CloneDataQualityEvaluationTask`	`clone-data-quality-evaluation-task`
	Event pra-hapus batch monitoring kualitas data			`dataworks:DqcCheck:BatchDeleteDataQualityEvaluationTasks`	`batch-delete-data-quality-evaluation-tasks`
Pra-operasi langganan alert monitoring kualitas data	Event pra-buat langganan alert monitoring kualitas data			`dataworks:DqcCheck:CreateDataQualityEvaluationTaskNotification`	create-data-quality-evaluation-task-notification
	Event pra-perbarui langganan alert monitoring kualitas data			`dataworks:DqcCheck:UpdateDataQualityEvaluationTaskNotification`	`update-data-quality-evaluation-task-notification`
	Event pra-hapus langganan alert monitoring kualitas data			`dataworks:DqcCheck:DeleteDataQualityEvaluationTaskNotification`	`delete-data-quality-evaluation-task-notification`

Format pesan

Validasi kualitas data

Format payload pesan (konten field data dalam pesan event) untuk event umpan balik hasil validasi kualitas data ditunjukkan pada contoh berikut.

{
  "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
  }
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
ruleId	Long	ID aturan kualitas data.
ruleCheckId	Long	ID auto-increment hasil validasi.
feedbackContent	String	Konten umpan balik.
createUser	String	ID pengguna yang memberikan umpan balik.
taskid	String	ID tugas kualitas data.
beginTime	String	Waktu umpan balik.
envType	String	Tipe sumber data tabel yang terkait dengan aturan, termasuk: ODPS, EMR, HOLO.
projectName	String	Identifier unik sumber data yang terkait dengan aturan.
projectId	Long	ID ruang proyek DataWorks.
tenantId	Long	ID penyewa DataWorks.

Format payload pesan (konten field data dalam pesan event) untuk event validasi kualitas data selesai ditunjukkan pada contoh berikut.

{
  "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": "Table row count, 1-day difference",
        "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": "Previous day difference",
    "isPrediction": false,
    "feedbackStatus": 0,
    "whetherToFilterDirtyData": false
  }
}

Deskripsi field adalah sebagai berikut:

Nama field		Tipe bidang	Deskripsi
id		Long	ID utama proses validasi ini. Setiap kali validasi aturan dipicu, catatan ID utama baru ditambahkan.
projectId		Long	ID ruang proyek DataWorks
tenantId		Long	ID penyewa DataWorks
taskId		String	ID tugas validasi.
entityId		Long	ID ekspresi partisi.
ruleId		Long	ID aturan.
property		String	Field atribut aturan, yaitu nama kolom tabel sumber data yang divalidasi.
bizdate		Long	Tanggal bisnis. Jika entitas bisnis yang divalidasi adalah data offline, tanggal bisnis biasanya sehari sebelum operasi validasi dilakukan.
dateType		String	Tipe siklus penjadwalan. Biasanya YMD, artinya tugas tahunan, bulanan, atau harian.
actualExpression		String	Partisi aktual tabel sumber data yang divalidasi.
matchExpression		String	Ekspresi partisi.
blockType		Integer	Kekuatan aturan validasi. Kekuatan menunjukkan pentingnya aturan. Nilai yang valid: 1, menunjukkan aturan kuat. 0, menunjukkan aturan lemah. Anda dapat mengatur aturan penting sebagai aturan kuat berdasarkan kebutuhan aktual Anda. Jika aturan kuat digunakan dan alert merah dipicu, tugas penjadwalan akan diblokir.
checkResult		Integer	Status hasil validasi. Nilai yang valid: -2: Validasi dilewati -1: Pengecualian validasi 0: Validasi lolos 1: Ambang oranye dipicu 2: Ambang merah dipicu
methodName		String	Metode untuk mengumpulkan data sampel 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, table_count-count_distinct, dll.
beginTime		Long	Waktu mulai operasi validasi.
endTime		Long	Waktu cutoff untuk mengkueri hasil validasi.
timeConsuming		String	Waktu yang dihabiskan untuk mengeksekusi tugas validasi.
externalType		String	Tipe sistem penjadwalan. Saat ini hanya mendukung CWF2. Jika externalType kosong, itu menunjukkan tugas uji coba manual.
externalId		String	Ketika externalType adalah CWF2, ini mewakili ID node tugas penjadwalan. Ketika externalType kosong, nilainya triggerByManual, menunjukkan tugas yang dipicu secara manual.
discrete		Boolean	Apakah validasi diskrit. Nilai yang valid: true: Adalah validasi diskrit. false: Bukan validasi diskrit.
fixedCheck		Boolean	Apakah validasi nilai tetap. Nilai yang valid: true: Adalah validasi nilai tetap. false: Bukan validasi nilai tetap.
referenceValue			Nilai sampel historis.
	bizDate	Long	Tanggal bisnis. Jika entitas bisnis yang divalidasi adalah data offline, tanggal bisnis biasanya sehari sebelum operasi validasi dilakukan.
	discreteProperty	String	Nilai field sampel setelah pengelompokan group by. Misalnya, jika dikelompokkan berdasarkan field gender, DiscreteProperty akan menjadi laki-laki, perempuan, dan null.
	value	Decimal	Nilai sampel.
	singleCheckResult	Integer	Rangkaian hasil validasi.
sampleValue			Sampel yang digunakan saat ini.
	bizDate	Long	Tanggal bisnis. Jika entitas bisnis yang divalidasi adalah data offline, tanggal bisnis biasanya sehari sebelum operasi validasi dilakukan.
	value	Decimal	Nilai sampel.
trend		String	Tren hasil validasi.
expectValue		Double	Nilai yang diharapkan.
op		String	Operator perbandingan.
projectName		String	Nama engine atau sumber data untuk validasi kualitas data.
tableName		String	Nama tabel yang divalidasi.
templateId		Integer	ID template validasi yang digunakan.
checkerType		Integer	Tipe validator.
ruleName		String	Nama aturan.
isPrediction		Boolean	Apakah hasil prediksi. Nilai yang valid: true: Adalah hasil prediksi. false: Bukan hasil prediksi.
comment		String	Deskripsi aturan validasi.
eventCode		String	Kode event ekstensi.

Event pra-operasi aturan kualitas data (buat batch, perbarui, hapus)

Format payload pesan (konten field data dalam pesan event) untuk event pra-buat batch aturan kualitas data ditunjukkan pada contoh berikut.

{
    "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": "Jumlah baris tabel lebih besar dari 0",
          "enabled": true,
          "severity": "High",
          "description": "Pemeriksaan operasi pembuatan aturan kualitas data",
          "templateCode": "system:table:table_count:fixed:0",
          "samplingConfig": {
            "metric": "count"
          },
          "checkingConfig": {
            "type": "fixed",
            "thresholds": {
              "expected": {
                "expression": "$checkValue > 0"
              },
              "critical": {
                "expression": "$checkValue <= 0"
              }
            }
          }
        }
      ]
    }
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
projectId	List	ID ruang proyek DataWorks.
operator	String	UID pengguna operator.
operationTime	Long	Waktu operasi.
dataQualityTaskId	Long	ID monitoring kualitas data yang terkait dengan aturan, bisa kosong.
target	DataQualityTarget	Objek yang dipantau oleh aturan kualitas data.
databaseType	String	Tipe database dataset bertipe tabel. MaxCompute EMR CDH Hologres AnalyticDB for PostgreSQL
tableGuid	String	ID unik tabel di Data Map.
rules	List<DataQualityRule>	Daftar aturan kualitas data.
name	String	Nama aturan.
enabled	Boolean	Apakah aturan diaktifkan.
severity	String	Tingkat aturan untuk bisnis (sesuai dengan aturan kuat/lemah di halaman). High Normal
description	String	Informasi deskripsi aturan.
templateCode	String	Template aturan yang dirujuk saat membuat aturan
samplingConfig	SamplingConfig	Pengaturan yang diperlukan untuk pengumpulan sampel.
metric	String	Nama metrik pengambilan sampel. Count: Jumlah baris tabel Min: Nilai minimum field Max: Nilai maksimum field Avg: Nilai rata-rata field DistinctCount: Jumlah nilai unik field DistinctPercent: Rasio nilai unik terhadap total baris DuplicatedCount: Jumlah nilai duplikat field DuplicatedPercent: Rasio nilai duplikat terhadap total baris TableSize: Ukuran tabel NullValueCount: Jumlah baris dengan nilai null field NullValuePercent: Proporsi nilai null field GroupCount: Jumlah baris untuk setiap nilai setelah pengelompokan berdasarkan nilai field CountNotIn: Jumlah baris dengan nilai enum yang tidak cocok CountDistinctNotIn: Jumlah nilai unik yang tidak cocok dengan nilai enum UserDefinedSql: Pengumpulan sampel menggunakan SQL kustom
checkingConfig	CheckingConfig	Pengaturan validasi sampel.
type	String	Metode perhitungan ambang batas Fixed Fluctation FluctationDiscreate Auto Average Variance
thresholds	Thresholds	Pengaturan ambang batas.
expected	Threshold	Pengaturan ambang batas yang diharapkan.
expression	String	Ekspresi ambang batas.
critical	Threshold	Pengaturan ambang batas untuk peringatan kritis.

Format payload pesan (konten field data dalam pesan event) untuk event pra-perbarui batch aturan kualitas data ditunjukkan pada contoh berikut.

{
    "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": "Jumlah baris tabel lebih besar dari 0",
      "enabled": true,
      "severity": "High",
      "description": "Pemeriksaan operasi pembuatan aturan kualitas data",
      "templateCode": "system:table:table_count:fixed:0",
      "samplingConfig": {
        "metric": "count"
      },
      "checkingConfig": {
        "type": "fixed",
        "thresholds": {
          "expected": {
            "expression": "$checkValue > 0"
          },
          "critical": {
            "expression": "$checkValue <= 0"
          }
        }
      }
    }
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Jenis bidang	Deskripsi
eventCode	String	Kode event.
projectId	Long	ID ruang proyek.
tenantId	Long	ID penyewa.
operator	String	UID pengguna.
operationTime	Long	Waktu operasi.
id	Long	ID aturan.
name	String	Nama aturan.
enabled	Boolean	Apakah aturan diaktifkan. true: Diaktifkan. false: Dinonaktifkan.
severity	String	Tingkat aturan untuk bisnis (sesuai dengan aturan kuat/lemah di halaman). High Normal
description	String	Informasi deskripsi aturan.
templateCode	String	Pengaturan partisi untuk tabel terpartisi.
samplingConfig	SamplingConfig	Pengaturan yang diperlukan untuk pengumpulan sampel.
metric	String	Nama metrik pengambilan sampel. Count: Jumlah baris tabel Min: Nilai minimum field Max: Nilai maksimum field Avg: Nilai rata-rata field DistinctCount: Jumlah nilai unik field DistinctPercent: Rasio nilai unik terhadap total baris DuplicatedCount: Jumlah nilai duplikat field DuplicatedPercent: Rasio nilai duplikat terhadap total baris TableSize: Ukuran tabel NullValueCount: Jumlah baris dengan nilai null field NullValuePercent: Proporsi nilai null field GroupCount: Jumlah baris untuk setiap nilai setelah pengelompokan berdasarkan nilai field CountNotIn: Jumlah baris dengan nilai enum yang tidak cocok CountDistinctNotIn: Jumlah nilai unik yang tidak cocok dengan nilai enum UserDefinedSql: Pengumpulan sampel menggunakan SQL kustom
checkingConfig	CheckingConfig	Pengaturan validasi sampel.
type	String	Metode perhitungan ambang batas Fixed Fluctation FluctationDiscreate Auto Average Variance
thresholds	Thresholds	Pengaturan ambang batas.
expected	Threshold	Pengaturan ambang batas yang diharapkan.
expression	String	Ekspresi ambang batas.
critical	Threshold	Pengaturan ambang batas untuk peringatan kritis.

Format payload pesan (konten field data dalam pesan event) untuk event pra-hapus batch aturan kualitas data ditunjukkan pada contoh berikut.

{
    "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
    }
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
projectId	List	ID ruang proyek DataWorks.
operator	String	UID pengguna operator.
operationTime	Long	Waktu operasi.
ids	List<Long>	Daftar ID aturan kualitas data yang akan dihapus.
tenantId	String	ID penyewa.
eventCode	String	Kode peristiwa.

Format payload pesan (konten field data dalam pesan event) untuk event pra-perbarui aturan kualitas data ditunjukkan pada contoh berikut.

{
    "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": "Jumlah baris tabel lebih besar dari 0",
      "enabled": true,
      "severity": "High",
      "description": "Pemeriksaan operasi pembuatan aturan kualitas data",
      "templateCode": "system:table:table_count:fixed:0",
      "samplingConfig": {
        "metric": "count"
      },
      "checkingConfig": {
        "type": "fixed",
        "thresholds": {
          "expected": {
            "expression": "$checkValue > 0"
          },
          "critical": {
            "expression": "$checkValue <= 0"
          }
        }
      }
    }
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
eventCode	String	Kode event.
projectId	Long	ID ruang proyek.
tenantId	Long	ID penyewa.
operator	String	UID pengguna.
operationTime	Long	Waktu operasi.
id	Long	ID aturan.
name	String	Nama aturan.
enabled	Boolean	Apakah aturan diaktifkan. true: Diaktifkan. false: Dinonaktifkan.
severity	String	Tingkat aturan untuk bisnis (sesuai dengan aturan kuat/lemah di halaman). High Normal
description	String	Informasi deskripsi aturan.
templateCode	String	Pengaturan partisi untuk tabel terpartisi.
samplingConfig	SamplingConfig	Pengaturan yang diperlukan untuk pengumpulan sampel.
metric	String	Nama metrik pengambilan sampel. Count: Jumlah baris tabel Min: Nilai minimum field Max: Nilai maksimum field Avg: Nilai rata-rata bidang DistinctCount: Jumlah nilai unik field DistinctPercent: Rasio nilai unik terhadap total baris DuplicatedCount: Jumlah nilai duplikat field DuplicatedPercent: Rasio nilai duplikat terhadap total baris TableSize: Ukuran tabel NullValueCount: Jumlah baris dengan nilai null field NullValuePercent: Proporsi nilai null field GroupCount: Jumlah baris untuk setiap nilai setelah pengelompokan berdasarkan nilai field CountNotIn: Jumlah baris dengan nilai enum yang tidak cocok CountDistinctNotIn: Jumlah nilai unik yang tidak cocok dengan nilai enum UserDefinedSql: Pengumpulan sampel menggunakan SQL kustom
checkingConfig	CheckingConfig	Pengaturan validasi sampel.
type	String	Metode perhitungan ambang batas Fixed Fluctation FluctationDiscreate Auto Average Variance
thresholds	Thresholds	Pengaturan ambang batas.
expected	Threshold	Pengaturan ambang batas yang diharapkan.
expression	String	Ekspresi ambang batas.
critical	Threshold	Pengaturan ambang batas untuk peringatan kritis.

Event pra-operasi monitoring kualitas data (buat, perbarui, kloning, hapus batch)

Format payload pesan (konten field data dalam pesan event) untuk event pra-buat dan pra-perbarui monitoring kualitas data ditunjukkan pada contoh berikut.

{
    "datacontenttype": "application/json;charset=utf-8",
    "data": {
      "eventCode": "create-data-quality-evaluation-task",
      "name": "Monitoring akurasi data tabel",
      "description": "Setelah instance penjadwalan yang menulis data ke tabel berjalan berhasil, picu monitoring untuk memeriksa apakah data keluaran memenuhi ekspektasi",
      "target": {
        "databaseType": "emr",
        "tableGuid": "an-emr-table-guid"
      },
      "trigger": {
        "type": "ByScheduledTaskInstance",
        "taskIds": [
          1001,
          1002
        ]
      },
      "dataSourceId": 201,
      "runtimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"HIVE_SQL\" }",
      "rules": [
        {
          "name": "Jumlah baris tabel lebih besar dari 0",
          "enabled": true,
          "severity": "High",
          "description": "Pemeriksaan operasi pembuatan aturan kualitas data",
          "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": "Jumlah baris tabel lebih besar dari 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
    }
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe field	Deskripsi
eventCode	String	Kode event.
name	String	Nama tugas monitoring kualitas.
description	String	Deskripsi tugas validasi kualitas data.
target	DataQualityTarget	Objek yang dipantau oleh tugas validasi kualitas data.
databaseType	String	Tipe database dataset bertipe tabel. MaxCompute EMR CDH Hologres AnalyticDB for PostgreSQL
tableGuid	String	ID unik tabel di Data Map.
trigger	DataQualityEvaluationTaskTrigger	Konfigurasi pemicu untuk tugas validasi kualitas data.
type	String	Event apa yang dapat memicu eksekusi tugas validasi kualitas. ByScheduledTaskInstance: Instance terjadwal berjalan berhasil, hanya didukung dalam skenario cloud publik. ByManual: Dipicu secara manual.
taskIds	Array<Long>	Berlaku ketika type=ByScheduledTaskInstance, secara spesifik menunjukkan instance node penjadwalan mana yang memicu saat eksekusi berhasil.
dataSourceId	Long	Sumber data yang akan digunakan saat mengeksekusi tugas validasi kualitas data.
runtimeConf	String	Pengaturan saat menggunakan sumber data, saat ini hanya mendukung menentukan antrian yarn EMR dan mengatur mesin SQL ke SPARK-SQL saat mengumpulkan tabel EMR.
rules	List<DataQualityRule>	Daftar aturan kualitas data. Untuk detail parameter lebih lanjut, lihat Parameter event pra-operasi aturan kualitas data.
hooks	Array<DataQualityEvaluationTaskHook>	Pengaturan callback selama siklus hidup instance tugas validasi kualitas data, saat ini hanya mendukung satu hook untuk memblokir tugas penjadwalan.
type	String	Tipe aksi pemrosesan selanjutnya. BlockTaskInstance: Blokir eksekusi instance tugas DataWorks.
condition	String	Kondisi pemicu hook.
notifications	Array<Notification>	Pengaturan notifikasi pesan spesifik.
projectId	Long	ID ruang proyek.
tenantId	Long	ID penyewa.
operator	String	UID pengguna operator.
operationTime	Long	Waktu operasi.

Format payload pesan (konten field data dalam pesan event) untuk event pra-kloning monitoring kualitas data ditunjukkan pada contoh berikut.

{
    "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
    }
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
projectId	Long	ID ruang proyek DataWorks.
tenantId	String	ID penyewa.
operator	String	UID pengguna operator.
operationTime	Long	Waktu operasi.
targets	List<DataQualityTarget>	Objek monitoring kualitas data target untuk dikloning.
databaseType	String	Tipe database dataset bertipe tabel. MaxCompute EMR CDH Hologres AnalyticDB for PostgreSQL
tableGuid	String	ID unik tabel di Data Map.
id	Long	ID monitoring kualitas data sumber yang digunakan untuk kloning.
eventCode	String	Kode event.

Format payload pesan (konten field data dalam pesan event) untuk event pra-hapus batch monitoring kualitas data ditunjukkan pada contoh berikut.

{
    "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
    }
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama bidang	Tipe bidang	Deskripsi
projectId	Long	ID ruang proyek DataWorks.
operator	String	UID pengguna operator.
operationTime	Long	Waktu operasi.
ids	List<Long>	Daftar ID monitoring kualitas data yang akan dihapus.
tenantId	String	ID penyewa.
eventCode	String	Kode event.

Event pra-operasi langganan alert monitoring kualitas data (buat, perbarui, hapus)

Format payload pesan (konten field data dalam pesan event) untuk event pra-buat dan pra-hapus langganan alert monitoring kualitas data ditunjukkan pada contoh berikut.

{
    "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
    }
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
projectId	Long	ID ruang proyek DataWorks.
operator	String	UID pengguna operator.
operationTime	Long	Waktu operasi.
dataQualityEvaluationTaskId	Long	ID monitoring kualitas data.
channel	String	Tipe saluran pengiriman pesan langganan. Mail - Email Sms - Pesan teks Phone - Panggilan telepon Feishu - Lark Weixin - WeChat Dingding - DingTalk Webhook - Webhook kustom
receiverValue	String	Target spesifik untuk pengiriman pesan langganan.
eventCode	String	Kode event.

Format payload pesan (konten field data dalam pesan event) untuk event pra-perbarui monitoring kualitas data ditunjukkan pada contoh 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
    
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
projectId	Long	ID ruang proyek DataWorks.
operator	String	UID pengguna operator.
operationTime	Long	Waktu operasi.
dataQualityEvaluationTaskId	Long	ID monitoring kualitas data.
currentChannel	String	Tipe saluran pengiriman pesan langganan yang sedang diperbarui. Mail - Email Sms - Pesan teks Phone - Panggilan telepon Feishu - Lark Weixin - WeChat Dingding - DingTalk Webhook - Webhook kustom
currentReceiverValue	String	Target spesifik untuk pengiriman pesan langganan yang sedang diperbarui.
updatedChannel	String	Tipe saluran pengiriman pesan langganan yang diperbarui. Mail - Email Sms - Pesan teks Phone - Panggilan telepon Feishu - Lark Weixin - WeChat Dingding - DingTalk Webhook - Webhook kustom
updatedReceiverValue	String	Target spesifik yang diperbarui untuk pengiriman pesan langganan.
eventCode	String	Kode event.

Event tingkat penyewa

Modul tingkat penyewa menghasilkan event tingkat penyewa, seperti event yang dihasilkan saat menghapus ruang kerja di konsol manajemen. Gunakan daftar event berikut untuk mengidentifikasi mana yang merupakan event standar dan mana yang merupakan event titik ekstensi, beserta format pesannya.

Tab format pesan berikut hanya berisi konten sebagian. Untuk pesan lengkap yang dikirim ke EventBridge atau Function Compute, lihat Lampiran: Format Pesan.

Daftar event konsol manajemen

Daftar event

Tipe event	Event (dan operasi pemicu)	Event standar	Event titik ekstensi	Tipe event EventBridge (Type)	Tipe event ekstensi (eventCode)
Hapus ruang proyek	Event pra-hapus ruang proyek			`dataworks:ProjectChange:DeleteProject`	`delete-project`
Hapus ruang proyek	Hapus spasi tambahan.			`dataworks:ProjectChange:ProjectDeleted`	`project-deleted`

Format pesan

Format payload pesan: Event hapus ruang proyek

Format payload pesan (konten field data dalam pesan event) untuk event pra-hapus ruang proyek tingkat penyewa ditunjukkan pada contoh berikut.

{
 
  "data": {
    "eventCode": "delete-project",
    "projectId": 7***7, // ID ruang kerja
    "tenantId": 2807****0784, // ID penyewa
    "operator": "19***735
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
operator	String	Hapus UID pengguna dari ruang kerja DataWorks.
projectId	Long	ID ruang kerja DataWorks yang akan dihapus.
tenantId	Long	ID penyewa tempat ruang kerja yang akan dihapus berada.
eventCode	String	Kode event ekstensi.

Format payload pesan (konten field data dalam pesan event) untuk event pasca-hapus ruang proyek tingkat penyewa ditunjukkan pada contoh berikut.

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

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
operator	String	Hapus UID pengguna dari ruang kerja DataWorks.
projectId	Long	ID ruang kerja DataWorks yang akan dihapus.
projectName	String	Nama ruang kerja DataWorks yang akan dihapus.
tenantId	Long	ID penyewa tempat ruang kerja yang akan dihapus berada.
timestamp	Long	Timestamp saat pesan dikirim.
eventCode	String	Kode event ekstensi.

Daftar event unggah dan unduh

Daftar event

Jenis peristiwa	Event (dan operasi pemicu)	Event standar	Event titik ekstensi	Tipe event EventBridge (Type)	Tipe event ekstensi (eventCode)
Unggah dan unduh data	Event pra-unduh data - pembuatan file			dataworks:ResourcesDownload:DownloadResources	download-resources
	Event pra-unduh data - unduh file			dataworks:ResourcesDownload:DownloadResourcesExecute	download-resources-execute
	Event pra-unggah data			dataworks:ResourcesUpload:UploadDataToTable	upload-data-to-table

Format pesan

Unggah dan unduh data

Format payload pesan (konten field data dalam pesan event) untuk event pra-unduh data - pembuatan file ditunjukkan pada contoh berikut.

{ 
    "data": {
        "eventCode": "download-resources",
        "moduleType": "sqlx_query",
        "operatorBaseId": "123936573******",
        "operatorUid": "14931896037*******",
        "fileName": "Nama file.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",
    }

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
moduleType	String	Sumber data yang diunduh: entity_transfer: Data yang diunduh dari . develop_query: Data yang dikueri dan diunduh menggunakan pernyataan SQL di Data Development (DataStudio). sqlx_query: Data yang dikueri dan diunduh menggunakan pernyataan SQL di . dw_excel: Data yang diunduh dari .
operatorBaseId	String	BaseID pengguna yang melakukan operasi unduh.
operatorUid	String	UID pengguna yang melakukan operasi unduh.
fileName	String	Nama file yang diunduh.
fileSize	Long	Ukuran file yang diunduh.
datasourceId	String	ID sumber data tempat data yang diunduh berasal.
datasourceName	String	Nama sumber data tempat data yang diunduh berasal.
queryDwProjectId	String	ID ruang kerja DataWorks tempat data yang diunduh berasal.
queryDwProjectName	String	Identifier ruang kerja DataWorks tempat data yang diunduh berasal.
dataRowSize	Long	Jumlah baris data yang diunduh.
sqlText	String	Kode SQL yang digunakan saat mengkueri dan mengunduh data dengan pernyataan SQL.
eventCode	String	Tipe event ekstensi.

Format payload pesan (konten field data dalam pesan event) untuk event pra-unduh data - unduh file ditunjukkan pada contoh berikut.

{
  "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": "Nama file.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"
}

Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
moduleType	String	Sumber data yang diunduh: entity_transfer: Data yang diunduh dari . develop_query: Data yang dikueri dan diunduh menggunakan pernyataan SQL di Data Development (DataStudio). sqlx_query: Data yang dikueri dan diunduh menggunakan pernyataan SQL di . dw_excel: Data yang diunduh dari .
operatorBaseId	String	BaseID pengguna yang melakukan operasi unduh.
operatorUid	String	UID pengguna yang melakukan operasi unduh.
fileName	String	Nama file yang diunduh.
fileSize	Long	Ukuran file yang diunduh.
datasourceId	String	ID sumber data tempat data yang diunduh berasal.
datasourceName	String	Nama sumber data tempat data yang diunduh berasal.
queryDwProjectId	String	ID ruang kerja DataWorks tempat data yang diunduh berasal.
queryDwProjectName	String	Identifier ruang kerja DataWorks tempat data yang diunduh berasal.
dataRowSize	Long	Jumlah baris data yang diunduh.
sqlText	String	Kode SQL yang digunakan saat mengkueri dan mengunduh data dengan pernyataan SQL.
ip	String	Alamat IP pengguna yang melakukan operasi unduh.
eventCode	String	Tipe event ekstensi.

Format payload pesan (konten field data dalam pesan event) untuk event pra-unggah data ditunjukkan pada contoh 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"
}

Deskripsi field adalah sebagai berikut:

Nama field	Tipe bidang	Deskripsi
uploadSourceType	String	Sumber data yang diunggah: LOCAL: Unggah data file lokal. OSS: Unggah data file OSS. DW_EXCEL: Unggah data DataWorks melalui . HTTP: Unggah data file HTTP.
optTableType	String	Pilih untuk mengunggah data ke tabel yang sudah ada atau membuat tabel baru di sumber data engine yang ditentukan. Nilai yang valid: CREATE: Unggah data ke tabel baru. IMPORT: Unggah data ke tabel yang sudah ada.
targetEngineType	String	Pilih jenis engine mana yang akan diunggah datanya. Nilai yang valid: MaxCompute EMR Hive Hologres
writeType	String	Metode penulisan data ke tabel tujuan. Nilai yang valid: OVERWRITE: Timpa data tabel yang ada. APPEND: Tambahkan data yang diunggah ke tabel tujuan.
conflictMode	String	Strategi penanganan konflik kunci primer saat mengunggah data ke tabel tujuan: IGNORE: Abaikan data yang diunggah saat terjadi konflik kunci primer. REPLACE: Hapus baris dengan data yang bertentangan terlebih dahulu, lalu masukkan data yang diunggah ke baris tersebut. Field yang tidak ditentukan dalam data yang diunggah ditulis sebagai NULL. UPDATE: Timpa data tabel asli dengan data yang diunggah, hanya menutupi field yang ditentukan. Field yang tidak ditentukan tetap tidak berubah.
operatorBaseId	String	BaseID pengguna yang melakukan operasi unggah.
operatorUid	String	UID pengguna yang melakukan operasi unggah.
datasourceId	String	Ke sumber data mana data akan diunggah, isi ID sumber data di sini.
datasourceName	String	Ke sumber data mana data akan diunggah, isi nama sumber data di sini.
tableGuid	String	Table Guid. Contoh: MaxCompute: `odps.maxcomputeProject.tableName`. EMR_Hive: `emr_hive.emr cluster id.schema.tableName`. Holo: `holo.hologres-instance-id.database`.
queryDwProjectId	String	ID ruang kerja DataWorks tempat tabel berada.
queryDwProjectName	String	Nama ruang kerja DataWorks tempat tabel berada.
fileSize	Long	Ukuran file yang diunggah, dalam byte.
eventCode	String	Kode event ekstensi.

Lampiran: Format pesan

Setelah mengonfigurasi OpenEvent dan menambahkan saluran distribusi event, ketika event tingkat ruang kerja atau tingkat penyewa dipicu di DataWorks, pesan difilter berdasarkan tipe event (Type) yang dikonfigurasi di EventBridge. Berikut ini menunjukkan format pesan yang dikirim DataWorks ke EventBridge melalui saluran distribusi event.

{ 
 "datacontenttype": "application/json;charset=utf-8",// Format konten parameter data. datacontenttype hanya mendukung format application/json.
  "data": {
 // Konten pesan bervariasi berdasarkan tipe pesan. Berikut ini adalah dua field tetap dalam semua pesan event. Untuk detail setiap pesan event, lihat di atas.
 "tenantId": 28378****10656,// ID penyewa. Setiap akun Alibaba Cloud di DataWorks sesuai dengan satu penyewa, dan setiap penyewa memiliki ID penyewa sendiri. Anda dapat melihat nilai ini di informasi pengguna di pojok kanan atas DataWorks Data Development.
 "eventCode": "xxxx"//
  },
  "id": "539fd8f4-4ea1-4625-aa8b-6c906674****",// ID event. Identifier unik untuk event.
  "source": "acs.dataworks",// Sumber event, layanan yang menyediakan event, menunjukkan bahwa pesan ini didorong oleh DataWorks.
  "specversion": "1.0",
  "subject": "",
  "time": "2020-11-19T21:04:41+08:00",// Waktu saat event terjadi.
  "type": "dataworks:InstanceStatusChanges:InstanceStatusChanges",// Tipe event. Tipe event ini dapat digunakan untuk memfilter semua pesan yang didorong oleh DataWorks di konsol EventBridge. Setiap event memiliki nilai Type yang berbeda. Lihat di atas untuk tipe pesan event yang berbeda.
  "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 pesan event DataWorks.
  "aliyunregionid": "cn-hangzhou",// Wilayah yang menerima event.
  "aliyunpublishaddr": "172.25.XX.XX"
}

Pesan event lengkap mencakup format payload pesan dan informasi dasar seperti ID pesan, sumber, dan waktu kejadian. Deskripsi field penting ditunjukkan pada tabel berikut.

Nama field	Tipe bidang	Deskripsi
data	object	Format payload pesan. Format pesan dan makna field bervariasi berdasarkan tipe event. Untuk detailnya, lihat: Format pesan event Data Development: Daftar event Data Development. Format pesan event Data Integration: Daftar event Data Integration. Format pesan event Operation Center: Daftar event Operation Center. Format pesan event Security Center: Daftar event Security Center. Format pesan event Kualitas Data: Daftar event Kualitas Data.
id	String	ID unik pesan event. Digunakan untuk menemukan pesan event.
type	String	Tipe event. Menjelaskan tipe event yang terkait dengan sumber event. Contoh nilai: `dataworks:FileChange:CommitFile`: Menunjukkan commit file. `dataworks:FileChange:DeployFile`: Menunjukkan deploy file. Tipe event ini dapat digunakan untuk memfilter semua pesan yang didorong oleh DataWorks di konsol EventBridge. Setiap event memiliki nilai Type yang berbeda. Lihat di atas untuk tipe pesan event yang berbeda.

Format pesan untuk Function Compute

Saat Anda mengonfigurasi Extensions di DataWorks menggunakan Function Compute, DataWorks mengirim pesan untuk event titik ekstensi yang sesuai ke Function Compute dalam format JSON. Berikut ini menunjukkan format pesan yang dikirim ke Function Compute.

{
	"blockBusiness": true,
	"eventCategoryType": "resources-download",// Kategori event
	"eventType": "upload-data-to-table",// Tipe event
	"extensionBizId": "job_6603***070",
	"messageBody": {
             // Konten pesan bervariasi berdasarkan tipe pesan. Berikut ini adalah dua field tetap dalam semua pesan event. Untuk detail setiap pesan event, lihat di atas.
             "tenantId": 28378****10656,// ID penyewa. Setiap akun Alibaba Cloud di DataWorks sesuai dengan satu penyewa, dan setiap penyewa memiliki ID penyewa sendiri. Anda dapat melihat nilai ini di informasi pengguna di pojok kanan atas DataWorks Data Development.
             "eventCode": "xxxx"//
	},
	"messageId": "52d44ee7-b51f-4d4d-afeb-*******"// ID event. Identifier unik untuk event.
}

Deskripsi field penting adalah sebagai berikut:

Nama field		Tipe bidang	Deskripsi
messageId		String	ID event, identifier unik untuk event.
messageBody			Pesan event spesifik yang didorong oleh DataWorks, yang dapat Anda gunakan dalam pengembangan ekstensi. Konten pesan bervariasi berdasarkan tipe pesan.
	tenantId		ID penyewa. Setiap akun Alibaba Cloud di DataWorks sesuai dengan satu penyewa, dan setiap penyewa memiliki ID penyewa sendiri. Anda dapat melihat nilai ini di informasi pengguna di pojok kanan atas DataWorks Data Development
	eventCode		Kode event. Digunakan untuk mengidentifikasi tipe pesan event spesifik. Untuk nilai eventCode yang sesuai dengan setiap tipe event, lihat kolom Tipe event ekstensi (eventCode) dalam tabel Referensi Pengembangan: Daftar Event dan Format Pesan.