Gunakan CreateWorkflowInstances API untuk backfill data - DataWorks

Membuat instans alur kerja, seperti instans alur kerja pengisian ulang data, berdasarkan konfigurasi.

Deskripsi operasi

Fitur ini memerlukan langganan versi DataWorks Basic atau yang lebih tinggi.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID proyek.	100
EnvType	string	No	Lingkungan proyek. Nilai yang valid: Prod Dev	Prod
WorkflowId	integer	Yes	ID alur kerja tempat instans tersebut berada. Parameter ini diatur ke 1 untuk task yang dipicu otomatis.	1
Name	string	Yes	Nama.	WorkflowInstance1
Periods	object	No	Konfigurasi periode pengisian ulang data.
BizDates	array<object>	Yes	Waktu data. Anda dapat menentukan hingga tujuh waktu data.
	object	No
StartBizDate	string	Yes	Waktu data saat pengisian ulang data dimulai. Konfigurasikan parameter ini dalam format `yyyy-mm-dd`.	2024-11-20
EndBizDate	string	Yes	Waktu data saat pengisian ulang data dihentikan. Konfigurasikan parameter ini dalam format `yyyy-mm-dd`.	2024-11-24
StartTime	string	No	Waktu mulai pengisian ulang data. Konfigurasikan parameter ini dalam format `hh:mm:ss`. Waktu harus dalam format 24 jam. Nilai default: 00:00:00. Jika Anda mengonfigurasi parameter ini, Anda juga harus mengonfigurasi parameter EndTime.	00:00:00
EndTime	string	No	Waktu akhir pengisian ulang data. Konfigurasikan parameter ini dalam format `hh:mm:ss`. Waktu harus dalam format 24 jam. Nilai default: 23:59:59. Jika Anda mengonfigurasi parameter ini, Anda juga harus mengonfigurasi parameter StartTime.	23:59:59
Type	string	Yes	Tipe instans alur kerja. Nilai yang valid: SupplementData: Pengisian ulang data. Penggunaan RootTaskIds dan IncludeTaskIds bervariasi tergantung pada mode pengisian ulang. Lihat deskripsi parameter DefaultRunProperties.Mode. ManualWorkflow: Alur kerja yang dipicu secara manual. WorkflowId wajib ditentukan untuk alur kerja manual. RootTaskIds bersifat opsional. Jika tidak ditentukan, sistem akan menggunakan daftar root task default dari alur kerja manual tersebut. Manual: Task manual. Anda hanya perlu menentukan RootTaskIds. Ini adalah daftar task manual yang akan dijalankan. SmokeTest: Uji coba awal (smoke test). Anda hanya perlu menentukan RootTaskIds. Ini adalah daftar task uji yang akan dijalankan. TriggerWorkflow: Alur kerja yang dipicu. Anda harus menentukan WorkflowId dari alur kerja yang dipicu tersebut. IncludeTaskIds bersifat opsional. Jika tidak ditentukan, seluruh alur kerja akan dijalankan.	SupplementData
WorkflowParameters	string	No	Parameter alur kerja. Parameter ini berlaku ketika alur kerja tertentu ditentukan (`WorkflowId != 1`). Untuk alur kerja terjadwal dan alur kerja yang dipicu, formatnya adalah key=value, dan parameter ini memiliki prioritas lebih rendah dibandingkan parameter task. Untuk alur kerja manual, formatnya adalah JSON, dan parameter ini memiliki prioritas lebih tinggi dibandingkan parameter task.	"key=value" format: key1=value1 key2=value2 JSON format: {"key1":"value1", "key2": "value2"}
TaskParameters	string	No	Parameter khusus task. Nilainya dalam format JSON. Kunci menentukan ID task. Anda dapat memanggil operasi GetTask untuk mendapatkan format nilai dengan mengkueri parameter skrip.	{ "1001": "key1=val2 key2=val2", "1002": "key1=val2 key2=val2" }
AutoStartEnabled	boolean	No	Nilai default adalah true.	true
DefaultRunProperties	object	No	Konfigurasi waktu proses.
RootTaskIds	array	No	Daftar ID root task. Saat Type diatur ke SupplementData, RootTaskIds wajib ditentukan kecuali Mode diatur ke Chain. Saat Type diatur ke ManualWorkflow, RootTaskIds bersifat opsional. Jika tidak ditentukan, node root default dari alur kerja manual akan digunakan. Saat Type diatur ke Manual, RootTaskIds wajib ditentukan dan menentukan daftar task manual yang akan dijalankan. Saat Type diatur ke SmokeTest, RootTaskIds wajib ditentukan dan menentukan daftar task uji yang akan dijalankan.
	integer	No	ID task.	1234
IncludeTaskIds	array	No	ID task yang akan dijalankan.
	integer	No	ID task.	1234
ExcludeTaskIds	array	No	ID task yang tidak akan dijalankan.
	integer	No	ID task.	4321
IncludeProjectIds	array	No	ID proyek yang akan dijalankan.
	integer	No	ID proyek.	100
ExcludeProjectIds	array	No	ID proyek yang tidak akan dijalankan.
	integer	No	ID proyek.	200
Mode	string	No	Mode pengisian ulang data. Nilai default: ManualSelection. Wajib ditentukan saat Type diatur ke SupplementData. General: Anda hanya dapat menentukan satu nilai untuk `RootTaskIds`. Parameter `IncludeTaskIds` bersifat opsional. Jika tidak ditentukan, secara default mencakup `RootTaskIds`. ManualSelection: Anda dapat menentukan beberapa nilai untuk `RootTaskIds`. Parameter `IncludeTaskIds` bersifat opsional. Jika tidak ditentukan, secara default mencakup `RootTaskIds`. Chain: Jika Anda mengatur parameter Mode ke Chain, biarkan parameter `RootTaskIds` kosong dan atur parameter `IncludeTaskIds` ke ID task awal dan ID task akhir. AllDownstream: Hanya satu `RootTaskId` yang dapat ditentukan.	ManualSelection
Analysis	object	No	Konfigurasi analisis. Wajib ditentukan saat Type = SupplementData.
Enabled	boolean	No	Menentukan apakah fitur analisis diaktifkan. Wajib ditentukan saat Type = SupplementData.	true
Blocked	boolean	No	Menentukan apakah eksekusi diblokir jika analisis gagal. Wajib ditentukan saat Type = SupplementData.	true
RunPolicy	object	No	Kebijakan eksekusi. Jika parameter ini dibiarkan kosong, konfigurasi task yang digunakan.
StartTime	string	No	Waktu mulai eksekusi. Konfigurasikan parameter ini dalam format `hh:mm:ss` (format 24 jam). Parameter ini wajib ditentukan jika Anda mengonfigurasi parameter RunPolicy.	00:00:00
EndTime	string	No	Waktu akhir eksekusi. Konfigurasikan parameter ini dalam format `hh:mm:ss` (format 24 jam). Parameter ini wajib ditentukan jika Anda mengonfigurasi parameter RunPolicy. Nilai yang valid:	23:59:59
Type	string	No	Tipe periode waktu. Parameter ini wajib ditentukan jika Anda mengonfigurasi parameter RunPolicy. Nilai yang valid: Daily Weekend	Daily
Immediately	boolean	No	Menentukan apakah task yang dijadwalkan untuk dijalankan di masa depan dapat dijalankan segera. Nilai default: false.	false
Alert	object	No	Pengaturan peringatan.
Type	string	No	Kebijakan peringatan. Nilai yang valid: Success: Memberikan peringatan saat berhasil. Failure: Memberikan peringatan saat gagal. SuccessFailure: Memberikan peringatan baik saat berhasil maupun gagal.	Succes
NoticeType	string	No	Metode notifikasi peringatan. Nilai yang valid: Sms: Hanya SMS. Mail: Hanya email. SmsMail: SMS dan email.	Sms
Parallelism	integer	No	Konkurensi task. Nilai dari 2 hingga 10 menunjukkan konkurensi. Nilai 1 menunjukkan eksekusi sekuensial. Wajib ditentukan saat Type = SupplementData.	2
Order	string	No	Urutan eksekusi. Nilai default: Asc. Asc: urut naik berdasarkan tanggal bisnis. Desc: urut turun berdasarkan tanggal bisnis.	Asc
RuntimeResource	string	No	ID kelompok sumber daya penjadwalan kustom. Jika dibiarkan kosong, konfigurasi task yang digunakan.	S_res_group_524258031846018_1684XXXXXXXXX
Priority	integer	No	Prioritas eksekusi, rentang: 1–11. Nilai yang lebih tinggi menunjukkan prioritas yang lebih tinggi.	1
PriorityWeightStrategy	string	No	Kebijakan pembobotan prioritas. `Disable` (default): Tidak diaktifkan. `Upstream`: Prioritas didasarkan pada total bobot node hulu. Semakin dalam hierarkinya, semakin tinggi bobotnya.	Upstream
Comment	string	No	Alasan pembuatan.	create for test
Tags	array<object>	No	Daftar tag task.
	object	No
Value	string	No	Nilai tag.	tagValue
Key	string	No	Kunci tag.	tagKey
TagCreationPolicy	string	No	Kebijakan pembuatan tag. Nilai yang valid: Append: Tag baru ditambahkan di atas tag yang sudah ada pada alur kerja manual. Overwrite: Tag yang sudah ada pada alur kerja manual tidak diwariskan. Tag baru dibuat langsung.	Append

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan. Digunakan untuk melacak log dan memecahkan masalah.	22C97E95-F023-56B5-8852-B1A77A17XXXX
OperationId	string	ID operasi. Anda dapat menggunakan bidang ini untuk mengkueri hasil operasi pembuatan melalui antarmuka GetCreateWorkflowInstancesResult.	e15ad21c-b0e9-4792-8f55-b037xxxxxxxx

Contoh

Respons sukses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "OperationId": "e15ad21c-b0e9-4792-8f55-b037xxxxxxxx"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.