Modifikasi aturan alert kustom dengan UpdateRemind - DataWorks - Alibaba Cloud - DataWorks

Mengubah aturan peringatan kustom.

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
RemindId	integer	Yes	ID aturan peringatan kustom.	1234
RemindName	string	No	Nama aturan peringatan kustom. Nama tidak boleh melebihi 128 karakter.	update_remindname
DndEnd	string	No	Akhir periode saat Pemberitahuan peringatan tidak dikirim. Tentukan pengatur waktu dalam format hh:mm. Nilai valid untuk hh: [0,23]. Nilai valid untuk mm: [0,59].	08:00
RemindUnit	string	No	Tipe objek tempat aturan peringatan kustom diterapkan. Nilai valid: NODE BASELINE PROJECT BIZPROCESS.	NODE
NodeIds	string	No	ID node tempat aturan peringatan kustom diterapkan. Maksimal 50 node dapat ditentukan untuk satu aturan peringatan kustom. Anda dapat menentukan beberapa ID. Pisahkan beberapa ID dengan koma (,). Parameter ini berlaku saat Anda mengatur parameter RemindUnit ke NODE.	1,2,3
BaselineIds	string	No	ID garis dasar tempat aturan peringatan kustom diterapkan. Maksimal 5 garis dasar dapat ditentukan untuk satu aturan peringatan kustom. Anda dapat menentukan beberapa ID. Pisahkan beberapa ID dengan koma (,). Parameter ini berlaku saat Anda mengatur parameter RemindUnit ke BASELINE.	1,2,3
ProjectId	integer	No	ID ruang kerja tempat aturan peringatan kustom diterapkan. Anda hanya dapat menentukan satu ruang kerja untuk satu aturan peringatan kustom. Parameter ini berlaku saat Anda mengatur parameter RemindUnit ke PROJECT.	1234
BizProcessIds	string	No	ID alur kerja tempat aturan peringatan kustom diterapkan. Maksimal 5 alur kerja dapat ditentukan untuk satu aturan peringatan kustom. Anda dapat menentukan beberapa ID. Pisahkan beberapa ID dengan koma (,). Parameter ini berlaku saat Anda mengatur parameter RemindUnit ke BIZPROCESS.	1,2,3
RemindType	string	No	Kondisi Pemicu aturan peringatan. Nilai valid: FINISHED: Sistem memantau instans saat mulai berjalan dan mengirimkan Pemberitahuan peringatan setelah instans selesai berjalan. UNFINISHED: Sistem memantau instans saat mulai berjalan dan mengirimkan Pemberitahuan peringatan jika instans masih berjalan pada pengatur waktu yang ditentukan. ERROR: Sistem memantau instans saat mulai berjalan dan mengirimkan Pemberitahuan peringatan jika terjadi error. CYCLE_UNFINISHED: Sistem mengirimkan Pemberitahuan peringatan jika instans yang dipantau masih berjalan pada akhir siklus yang ditentukan. Dalam kebanyakan kasus, Anda dapat mengonfigurasi kondisi Pemicu ini untuk instans node yang dijadwalkan berjalan per jam. TIMEOUT: Sistem memantau instans saat mulai berjalan dan mengirimkan Pemberitahuan peringatan jika instans masih berjalan setelah periode yang ditentukan berakhir. Dalam kebanyakan kasus, Anda dapat mengonfigurasi kondisi Pemicu ini untuk memantau durasi berjalan instans node. Untuk informasi selengkapnya, lihat Kelola aturan peringatan kustom.	FINISHED
MaxAlertTimes	integer	No	Jumlah maksimum peringatan. Nilai valid: 1 hingga 10. Nilai default: 3.	3
AlertInterval	integer	No	Interval pengiriman Pemberitahuan peringatan. Unit: detik. Nilai minimum: 1200. Nilai default: 1800.	1800
Detail	string	No	Detail kondisi Pemicu peringatan. Jika parameter RemindType diatur ke FINISHED, biarkan parameter ini kosong. Jika parameter RemindType diatur ke UNFINISHED, atur parameter ini ke pasangan kunci-nilai. Contoh: {"hour":23,"minu":59}. Nilai valid untuk hour: [0,47]. Nilai valid untuk minu: [0,59]. Jika parameter RemindType diatur ke ERROR, biarkan parameter ini kosong. Jika parameter RemindType diatur ke CYCLE_UNFINISHED, atur parameter ini ke pasangan kunci-nilai dalam format JSON. Contoh: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. Kunci dalam string JSON menunjukkan nomor urut siklus. Nilai valid untuk kunci: 1 hingga 288. Nilai dalam string JSON menunjukkan pengatur waktu saat instans yang dipantau mencapai batas waktu (timeout) pada siklus terkait. Nilai harus dalam format hh:mm. Nilai valid untuk hh: [0,47]. Nilai valid untuk mm: [0,59]. Jika parameter RemindType diatur ke TIMEOUT, atur parameter ini ke periode timeout. Unit: detik. Contoh: 1800. Ini menunjukkan bahwa Pemberitahuan peringatan dikirim jika durasi berjalan instans yang dipantau melebihi 30 menit.	{"hour":23,"minu":59}
AlertUnit	string	No	Penerima Pemberitahuan peringatan. Nilai valid: OWNER dan OTHER. Nilai OWNER menunjukkan bahwa Pemberitahuan peringatan dikirim ke pemilik objek. Nilai OTHER menunjukkan bahwa Pemberitahuan peringatan dikirim ke pengguna yang ditentukan.	OWNER
AlertMethods	string	No	Metode notifikasi. Nilai valid: MAIL: Pemberitahuan peringatan dikirim melalui email. SMS: Pemberitahuan peringatan dikirim melalui pesan teks. PHONE: Pemberitahuan peringatan dikirim melalui panggilan telepon. Anda hanya dapat menggunakan metode notifikasi ini di DataWorks Edisi Profesional atau edisi yang lebih tinggi. DINGROBOTS: Pemberitahuan peringatan dikirim melalui Paket DingTalk. Anda hanya dapat menggunakan metode notifikasi ini jika parameter RobotUrls telah dikonfigurasi. WEBHOOKS (chatbot WeCom atau Lark): Pemberitahuan peringatan dikirim melalui Paket WeCom atau Lark. Anda hanya dapat menggunakan metode notifikasi ini jika parameter Webhooks telah dikonfigurasi. Pisahkan beberapa metode notifikasi dengan koma (,).	SMS,MAIL
AlertTargets	string	No	Format nilai yang diperlukan oleh parameter ini bervariasi berdasarkan nilai yang Anda tentukan untuk parameter AlertUnit. Perhatikan hal-hal berikut: Jika parameter AlertUnit diatur ke OWNER, biarkan parameter ini kosong. Jika parameter AlertUnit diatur ke OTHER, atur parameter ini ke ID unik (UID) pengguna yang ditentukan. Anda dapat menentukan beberapa UID. Pisahkan dengan koma (,). Maksimal 10 UID dapat ditentukan untuk menerima Pemberitahuan peringatan.	9527952795279527
UseFlag	boolean	No	Apakah akan mengaktifkan aturan peringatan. Nilai valid: true false.	true
RobotUrls	string	No	URL webhook chatbot DingTalk. Anda dapat menentukan beberapa URL webhook. Pisahkan beberapa URL webhook dengan koma (,). Jika parameter ini diatur ke undefined, URL webhook yang ditentukan akan dihapus.	https://oapi.dingtalk.com/robot/send?access_token=******************************
Webhooks	string	No	URL webhook chatbot WeCom atau Lark. Anda dapat menentukan beberapa URL webhook. Pisahkan beberapa URL webhook dengan koma (,). Nilai AlertMethods harus menyertakan WEBHOOKS. Jika parameter ini diatur ke undefined, URL webhook yang ditentukan akan dihapus. Hanya DataWorks Edisi Perusahaan yang mendukung parameter ini. Fitur peringatan berbasis URL webhook didukung di wilayah berikut: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), dan Singapore.	https://open.feishu.cn/open-apis/bot/v2/hook/*******

Elemen respons

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Data	boolean	Indicates whether the modification to the custom alert rule succeeds.	true
ErrorMessage	string	The error message.	The specified parameters are invalid.
RequestId	string	The request ID. You can use the ID to troubleshoot issues.	0000-ABCD-EFG****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	1031203110005

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0000-ABCD-EFG****",
  "Success": true,
  "ErrorCode": "1031203110005"
}

Kode kesalahan

HTTP status code	Error code	Error message
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
500	Forbidden.Wkbench.BaselineNoPermission	You are not authorized to access the baseline.
500	Forbidden.Wkbench.ProjectNoPermission	You are not authorized to access the workspace.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	Forbidden.Wkbench.RemindNoPermission	You are not authorized to modify the reminder.
500	Invalid.Wkbench.RemindNotExist	The reminder does not exist.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.Resource	You have reached the limit for the resource. Please contact us by submitting a ticket.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.