Otomatisasi pembaruan workflow dengan UpdateWorkflow API - DataWorks - Alibaba Cloud -

Memperbarui alur kerja tertentu dengan menggunakan metode pembaruan penuh. Bidang yang dapat diperbarui secara asinkron ke DataStudio meliputi: pemilik, sumber data, kelompok sumber daya penjadwalan, deskripsi, dan mode jalankan pemicu (Normal, Lewati, atau Jeda).

Deskripsi operasi

Diperlukan DataWorks Edisi Dasar atau edisi 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
Id	integer	Yes	ID alur kerja.	1234
EnvType	string	No	Lingkungan proyek. Nilai valid: Prod: produksi Dev: pengembangan	Prod
Name	string	Yes	Nama.	My Workflow
Owner	string	Yes	ID akun pemilik.	1000
Trigger	object	Yes	Konfigurasi pemicu.
Type	string	Yes	Tipe pemicu. Nilai valid: Scheduler: dipicu oleh siklus penjadwalan Manual: dipicu secara manual	Scheduler
Cron	string	No	Ekspresi cron. Parameter ini hanya berlaku jika type diatur ke Scheduler.	00 00 00 * * ?
StartTime	string	No	Periode efektif pemicu epoch. Parameter ini hanya berlaku jika type diatur ke Scheduler. Format: `yyyy-mm-dd hh:mm:ss`.	1970-01-01 00:00:00
EndTime	string	No	Waktu kedaluwarsa pemicu periode. Parameter ini hanya berlaku jika type diatur ke Scheduler. Format: `yyyy-mm-dd hh:mm:ss`.	9999-01-01 00:00:00
Description	string	No	Deskripsi.	test
Dependencies	array<object>	No	Informasi dependensi.
	object	No
Type	string	Yes	Tipe dependensi. Nilai valid: CrossCycleDependsOnChildren: dependensi lintas siklus pada node anak tingkat pertama CrossCycleDependsOnSelf: dependensi lintas siklus pada node saat ini CrossCycleDependsOnOtherNode: dependensi lintas siklus pada node lain Normal: dependensi dalam siklus yang sama	Normal
UpstreamOutput	string	No	Identifier output dari node hulu. Bidang ini dikembalikan ketika tipe dependensi adalah `dependensi dalam siklus yang sama` dan konten input ditentukan.	pre.odps_sql_demo_0
UpstreamTaskId	integer	No	ID node hulu. Bidang ini dikembalikan ketika tipe dependensi adalah `dependensi lintas siklus pada node lain` atau `dependensi dalam siklus yang sama` tanpa konten input yang ditentukan. Bidang ini tidak dikembalikan dalam kasus lain.	1234
Parameters	string	No	Daftar parameter.	para1=$bizdate para2=$[yyyymmdd]
Tasks	array<object>	No	Daftar node.
	array<object>	No
Id	integer	No	ID node. Jika bidang ini ditentukan, node yang sesuai akan diperbarui sepenuhnya. Jika bidang ini tidak ditentukan, node baru akan dibuat.	1234
Name	string	Yes	Nama node.	SQL node
Description	string	No	Deskripsi.	Test
Type	string	Yes	Tipe node.	ODPS_SQL
Owner	string	Yes	ID akun pemilik.	1000
BaseLineId	integer	No	ID garis dasar.	1234
Timeout	integer	No	Periode waktu tunggu untuk eksekusi node, dalam detik.	3600
RerunMode	string	Yes	Apakah node dapat dijalankan ulang. Nilai valid: AllDenied: tidak dapat dijalankan ulang terlepas dari keberhasilan atau kegagalan FailureAllowed: dapat dijalankan ulang hanya jika gagal AllAllowed: dapat dijalankan ulang terlepas dari keberhasilan atau kegagalan	AllAllowed
RerunTimes	integer	No	Jumlah percobaan ulang. Parameter ini hanya berlaku jika node dikonfigurasi untuk mengizinkan pengulangan.	3
RerunInterval	integer	No	Interval waktu percobaan ulang, dalam detik.	60
Script	object	No	Informasi skrip.
Content	string	No	Konten skrip.	echo "helloWorld"
Parameters	string	No	Daftar parameter skrip.	para1=$bizdate
Trigger	object	Yes	Konfigurasi pemicu node.
Type	string	No	Tipe pemicu. Nilai valid: Scheduler: dipicu oleh siklus penjadwalan Manual: dipicu secara manual	Scheduler
Recurrence	string	Yes	Mode jalankan saat Pemicu aktif. Parameter ini hanya berlaku jika type diatur ke Scheduler. Nilai valid: Pause: dijeda Skip: dry run Normal: eksekusi normal	Normal
RuntimeResource	object	Yes	Konfigurasi lingkungan runtime, seperti informasi kelompok sumber daya.
ResourceGroupId	string	Yes	Identifier kelompok sumber daya penjadwalan yang dikonfigurasi untuk node.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	No	ID image yang dikonfigurasi untuk node.	i-xxxxxx
Cu	string	No	Konsumsi CU yang dikonfigurasi untuk node.	0.25
DataSource	object	No	Informasi sumber data terkait.
Name	string	No	Nama sumber data.	odps_test
Inputs	object	No	Informasi input. Jika bidang ini kosong, semua konfigurasi Inputs akan dihapus secara default.
Variables	array<object>	No	Daftar definisi variabel. Jika bidang ini tidak ditentukan atau merupakan array kosong, semua konfigurasi Inputs.Variables akan dihapus secara default.
	object	No
Name	string	No	The name of the variable.	key1
Type	string	Yes	The type. Valid values: Constant: constant value. PassThrough: node output. System: variable. NodeOutput: script output.	Constant
Value	string	No	The value of the variable.	value1
Outputs	object	No	Informasi output. Jika bidang ini kosong, semua konfigurasi Outputs akan dihapus secara default.
TaskOutputs	array<object>	No	Daftar definisi output node. Jika bidang ini tidak ditentukan atau merupakan array kosong, semua konfigurasi TaskOutputs akan dihapus secara default.
	object	No
Output	string	No	The identifier of the output.	pre.odps_sql_demo_0
Variables	array<object>	No	Daftar definisi variabel. Jika bidang ini tidak ditentukan atau merupakan array kosong, semua konfigurasi Outputs.Variables akan dihapus secara default.
	object	No
Name	string	No	The name of the variable.	key1
Type	string	Yes	The type. Valid values: Constant: constant value. PassThrough: node output. System: variable. NodeOutput: script output.	Constant
Value	string	No	The value of the variable.	value1
Dependencies	array<object>	No	Informasi dependensi. Jika bidang ini tidak ditentukan atau merupakan array kosong, semua konfigurasi Dependencies akan dihapus secara default.
	object	No
Type	string	Yes	Tipe dependensi. Nilai valid: CrossCycleDependsOnChildren: dependensi lintas siklus pada node anak tingkat pertama CrossCycleDependsOnSelf: dependensi lintas siklus pada node saat ini CrossCycleDependsOnOtherNode: dependensi lintas siklus pada node lain Normal: dependensi dalam siklus yang sama	Normal
UpstreamOutput	string	No	Identifier output dari node hulu. Bidang ini dikembalikan ketika tipe dependensi adalah `dependensi dalam siklus yang sama` dan konten input ditentukan.	pre.odps_sql_demo_0
UpstreamTaskId	integer	No	ID node hulu. Bidang ini dikembalikan ketika tipe dependensi adalah `dependensi lintas siklus pada node lain` atau `dependensi dalam siklus yang sama` tanpa konten input yang ditentukan. Bidang ini tidak dikembalikan dalam kasus lain.	1234
Tags	array<object>	No	Daftar tag node. Jika bidang ini tidak ditentukan atau merupakan array kosong, semua konfigurasi Tags akan dihapus secara default.
	object	No
Key	string	Yes	Kunci tag.	key1
Value	string	No	Nilai tag.	value1
ClientUniqueCode	string	No	Kode unik klien dari node, digunakan untuk operasi asinkron dan idempotensi. Jika tidak ditentukan selama pembuatan, sistem akan membuatnya secara otomatis, dan kode tersebut terikat secara unik ke ID Sumber daya. Jika parameter ini ditentukan selama pembaruan atau penghapusan, parameter tersebut harus konsisten dengan kode unik klien yang digunakan selama pembuatan.	Task_0bc5213917368545132902xxxxxxxx
EnvType	string	No	Lingkungan proyek. Nilai valid: Prod: produksi Dev: pengembangan	Prod
Outputs	object	No	Informasi output.
TaskOutputs	array<object>	No	Daftar definisi output node alur kerja.
	object	No
Output	string	No	Identifier output.	pre.odps_sql_demo_0
Tags	array<object>	No	Daftar tag alur kerja.
	object	No
Key	string	Yes	Kunci tag.	key1
Value	string	No	Nilai tag.	value1
ClientUniqueCode	string	No	Kode unik klien dari alur kerja, digunakan untuk operasi asinkron dan idempotensi. Jika tidak ditentukan selama pembuatan, sistem akan membuatnya secara otomatis, dan kode tersebut terikat secara unik ke ID Sumber daya. Jika parameter ini ditentukan selama pembaruan atau penghapusan, parameter tersebut harus konsisten dengan kode unik klien yang digunakan selama pembuatan.	Workflow_0bc5213917368545132902xxxxxxxx
InstanceMode	string	No	Mode pembuatan instans. Nilai valid: T+1: Instans dibuat pada hari berikutnya. Immediately: Instans dibuat segera. Instans periodik hanya dibuat jika waktu terjadwal alur kerja setidaknya 10 menit setelah alur kerja diterbitkan. Selama periode pembuatan instans penuh (22:00 hingga 24:00), pembuatan instans real-time tidak tersedia. Anda dapat mengirimkan dan menerbitkan alur kerja selama periode ini, tetapi instans tidak dibuat ulang setelah pengiriman.	T+1

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan, yang digunakan untuk melacak log dan memecahkan masalah.	22C97E95-F023-56B5-8852-B1A77A17XXXX
Success	boolean	Apakah operasi berhasil.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.