All Products
Search
Document Center

DataWorks:CreateWorkflowInstances

Last Updated:Jun 11, 2026

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

Deskripsi operasi

DataWorks Edisi Basic atau lebih tinggi diperlukan.

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 instance ini berada. Parameter ini disetel ke 1 untuk tugas yang dipicu otomatis.

1

Name

string

Yes

Nama.

WorkflowInstance1

Periods

object

No

Konfigurasi periode pengisian ulang data.

BizDates

array<object>

Yes

Stempel waktu data. Anda dapat menentukan hingga tujuh stempel waktu data.

object

No

StartBizDate

string

Yes

Stempel waktu data saat pengisian ulang data dimulai. Konfigurasikan parameter ini dalam format yyyy-mm-dd.

2024-11-20

EndBizDate

string

Yes

Stempel waktu data saat data tidak lagi diisi ulang. 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

Jenis instance alur kerja. Nilai yang valid:

  • SupplementData: Pengisian ulang data. Penggunaan RootTaskIds dan IncludeTaskIds bervariasi berdasarkan mode pengisian ulang. Lihat deskripsi parameter DefaultRunProperties.Mode.

  • ManualWorkflow: Alur kerja yang dipicu secara manual. WorkflowId diperlukan untuk alur kerja manual. RootTaskIds bersifat opsional. Jika tidak ditentukan, sistem menggunakan daftar tugas root default dari alur kerja manual.

  • Manual: Tugas manual. Anda hanya perlu menentukan RootTaskIds. Ini adalah daftar tugas manual yang akan dijalankan.

  • SmokeTest: Uji asap. Anda hanya perlu menentukan RootTaskIds. Ini adalah daftar tugas uji yang akan dijalankan.

  • TriggerWorkflow: Alur Kerja yang Dipicu. Anda harus menentukan WorkflowId dari alur kerja yang dipicu. IncludeTaskIds bersifat opsional. Jika Anda tidak menentukan IncludeTaskIds, seluruh alur kerja akan dijalankan.

SupplementData

WorkflowParameters

string

No

Parameter alur kerja. Parameter ini berlaku saat 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 daripada parameter tugas. Untuk alur kerja manual, formatnya adalah JSON, dan parameter ini memiliki prioritas lebih tinggi daripada parameter tugas.

"key=value" format: key1=value1 key2=value2 JSON format: {"key1":"value1", "key2": "value2"}

TaskParameters

string

No

Parameter khusus tugas. Nilainya dalam format JSON. Kuncinya menentukan ID tugas. 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 runtime.

RootTaskIds

array

No

Daftar ID tugas root.

  • Saat Type disetel ke SupplementData, RootTaskIds diperlukan kecuali Mode disetel ke Chain.

  • Saat Type disetel ke ManualWorkflow, RootTaskIds bersifat opsional. Jika tidak ditentukan, node root default dari alur kerja manual digunakan.

  • Saat Type disetel ke Manual, RootTaskIds diperlukan dan menentukan daftar tugas manual yang akan dijalankan.

  • Saat Type disetel ke SmokeTest, RootTaskIds diperlukan dan menentukan daftar tugas uji yang akan dijalankan.

integer

No

ID tugas.

1234

IncludeTaskIds

array

No

ID tugas yang akan dijalankan.

integer

No

ID tugas.

1234

ExcludeTaskIds

array

No

ID tugas yang tidak akan dijalankan.

integer

No

ID tugas.

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. Diperlukan saat Type disetel 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 menyetel parameter Mode ke Chain, biarkan parameter RootTaskIds kosong dan setel parameter IncludeTaskIds ke ID tugas mulai dan ID tugas akhir.

  • AllDownstream: Hanya satu RootTaskId yang dapat ditentukan.

ManualSelection

Analysis

object

No

Konfigurasi analisis. Diperlukan saat Type = SupplementData.

Enabled

boolean

No

Menentukan apakah akan mengaktifkan fitur analisis. Diperlukan saat Type = SupplementData.

true

Blocked

boolean

No

Menentukan apakah akan memblokir eksekusi jika analisis gagal. Diperlukan saat Type = SupplementData.

true

RunPolicy

object

No

Kebijakan eksekusi. Jika parameter dibiarkan kosong, konfigurasi tugas digunakan.

StartTime

string

No

Waktu mulai eksekusi. Konfigurasikan parameter ini dalam format hh:mm:ss (format 24 jam). Parameter ini diperlukan 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 diperlukan jika Anda mengonfigurasi parameter RunPolicy. Nilai yang valid:

23:59:59

Type

string

No

Jenis periode waktu. Parameter ini diperlukan jika Anda mengonfigurasi parameter RunPolicy. Nilai yang valid:

  • Daily

  • Weekend

Daily

Immediately

boolean

No

Menentukan apakah tugas yang waktu eksekusi terjadwalnya di masa depan dapat dijalankan segera. Nilai default: false.

false

Alert

object

No

Pengaturan peringatan.

Type

string

No

Kebijakan peringatan. Nilai yang valid:

  • Success: Peringatan saat berhasil.

  • Failure: Peringatan saat gagal.

  • SuccessFailure: Peringatan saat berhasil dan 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 tugas. Nilai dari 2 hingga 10 menunjukkan konkurensi. Nilai 1 menunjukkan eksekusi sekuensial. Diperlukan saat Type = SupplementData.

2

Order

string

No

Urutan eksekusi. Nilai default: Asc.

  • Asc: menaik berdasarkan tanggal bisnis.

  • Desc: menurun berdasarkan tanggal bisnis.

Asc

RuntimeResource

string

No

ID grup sumber daya penjadwalan kustom. Jika dibiarkan kosong, konfigurasi tugas 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 mengaktifkan.

  • Upstream: Prioritas didasarkan pada total bobot node upstream. Semakin dalam hierarki, semakin tinggi bobotnya.

Upstream

Comment

string

No

Alasan pembuatan.

create for test

Tags

array<object>

No

Daftar tag tugas.

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 dari alur kerja manual.

  • Overwrite: Tag yang sudah ada dari alur kerja manual tidak diwariskan. Tag baru dibuat secara langsung.

Append

Elemen respons

Element

Type

Description

Example

object

RequestId

string

ID permintaan. Digunakan untuk menemukan log dan memecahkan masalah.

22C97E95-F023-56B5-8852-B1A77A17XXXX

OperationId

string

ID operasi. Anda dapat menggunakan field 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.