Gunakan API CreateRemind untuk membuat aturan alert kustom - DataWorks - Alibaba Cloud - DataWorks

Membuat 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
RemindName	string	Yes	Nama aturan kustom. Panjang nama dapat mencapai 128 karakter.	test_error_remind
DndEnd	string	No	Pengatur waktu akhir periode jangan ganggu, dalam format hh:mm. Nilai valid untuk hh: [0,23]. Nilai valid untuk mm: [0,59].	08:00
RemindUnit	string	Yes	Tipe objek. Nilai valid: NODE (node), BASELINE (garis dasar), PROJECT (ruang kerja), dan BIZPROCESS (proses bisnis). Valid values: BASELINE : garis dasar. PROJECT : ruang kerja. NODE : node. BIZPROCESS : proses bisnis.	NODE
NodeIds	string	No	ID node yang akan dipantau ketika RemindUnit (tipe objek) diatur ke NODE (node). Pisahkan beberapa ID dengan koma (,). Satu aturan dapat memantau maksimal 50 node.	1,2,3
BaselineIds	string	No	ID garis dasar yang akan dipantau ketika RemindUnit (tipe objek) diatur ke BASELINE (garis dasar). Pisahkan beberapa ID dengan koma (,). Satu aturan dapat memantau maksimal 5 garis dasar.	1,2,3
ProjectId	integer	No	ID ruang kerja yang akan dipantau ketika RemindUnit (tipe objek) diatur ke PROJECT (ruang kerja). Satu aturan hanya dapat memantau satu ruang kerja.	9527
BizProcessIds	string	No	ID proses bisnis yang akan dipantau ketika RemindUnit (tipe objek) diatur ke BIZPROCESS (proses bisnis). Pisahkan beberapa ID proses bisnis dengan koma (,). Satu aturan dapat memantau maksimal 5 proses bisnis.	1,2,3
RemindType	string	Yes	Kondisi pemicu. Nilai valid: FINISHED (selesai), UNFINISHED (belum selesai), ERROR (kesalahan), CYCLE_UNFINISHED (siklus belum selesai), dan TIMEOUT (waktu eksekusi Berjalan habis).	FINISHED
MaxAlertTimes	integer	No	Jumlah maksimum peringatan. Nilai minimum: 1. Nilai maksimum: 10. Nilai default: 3.	2
AlertInterval	integer	No	Interval peringatan minimum, dalam detik. Nilai minimum: 1200. Nilai default: 1800.	1800
Detail	string	No	Deskripsi untuk berbagai kondisi pemicu adalah sebagai berikut: Ketika RemindType (kondisi pemicu) diatur ke FINISHED (selesai), berikan nilai kosong. Ketika RemindType (kondisi pemicu) diatur ke UNFINISHED (belum selesai), pass parameter dalam format {"hour":23,"minu":59}. Nilai valid untuk hour: [0,47]. Nilai valid untuk minu: [0,59]. Ketika RemindType (kondisi pemicu) diatur ke ERROR (kesalahan), berikan nilai kosong. Ketika RemindType (kondisi pemicu) diatur ke CYCLE_UNFINISHED (siklus belum selesai), pass parameter dalam format {"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 adalah nomor siklus. Nilai valid: [1,288]. Nilainya adalah pengatur waktu belum selesai untuk siklus yang sesuai, dalam format hh:mm. Nilai valid untuk hh: [0,47]. Nilai valid untuk mm: [0,59]. Ketika RemindType (kondisi pemicu) diatur ke TIMEOUT (waktu eksekusi Berjalan habis), pass parameter sebagai nilai seperti 1800, dalam detik. Ini berarti peringatan dipicu jika waktu eksekusi Berjalan melebihi 30 menit dari awal eksekusi.	{"hour":"23","minu":"59"}
AlertUnit	string	Yes	Granularitas penerima peringatan. Nilai valid: OWNER (pemilik node) dan OTHER (pengguna tertentu). Valid values: OTHER : pengguna tertentu. OWNER : pemilik node.	OWNER
AlertMethods	string	Yes	Metode peringatan. Nilai valid: MAIL: email. SMS: pesan teks. Wilayah yang mendukung peringatan SMS adalah Singapura, Malaysia (Kuala Lumpur), dan Jerman (Frankfurt). Webhook (chatbot WeCom atau Lark). Metode peringatan ini hanya berlaku setelah parameter Webhooks dikonfigurasi. DINGROBOTS: chatbot DingTalk. Pisahkan beberapa metode peringatan dengan koma (,).	SMS,MAIL
AlertTargets	string	No	Ketika AlertUnit (penerima peringatan) diatur ke OWNER (pemilik node), berikan nilai kosong. Ketika AlertUnit (penerima peringatan) diatur ke OTHER (pengguna tertentu), berikan UID Alibaba Cloud dari pengguna yang ditentukan. Pisahkan beberapa UID Alibaba Cloud dengan koma (,). Maksimal 10 UID didukung.	9527952795279527
RobotUrls	string	No	URL webhook dari chatbot DingTalk. Pisahkan beberapa URL webhook dengan koma (,).	https://oapi.dingtalk.com/robot/send?access_token=******************************
Webhooks	string	No	URL webhook dari chatbot WeCom atau Lark. Pisahkan beberapa URL webhook dengan koma (,). Parameter alertMethods harus menyertakan metode peringatan WEBHOOKS. Hanya didukung oleh DataWorks Edisi Perusahaan. Wilayah yang tersedia: Tiongkok (Shanghai), Tiongkok (Chengdu), Tiongkok (Zhangjiakou), Tiongkok (Beijing), Tiongkok (Hangzhou), Tiongkok (Shenzhen), Hong Kong (Tiongkok), Jerman (Frankfurt), dan Singapura.	https://open.feishu.cn/open-apis/bot/v2/hook/*******

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
HttpStatusCode	integer	Kode status HTTP.	200
Data	integer	ID aturan kustom yang dikembalikan setelah aturan Pemantauan kustom dibuat.	1234
ErrorMessage	string	Pesan kesalahan.	The specified parameters are invalid
RequestId	string	ID unik permintaan. Anda dapat menggunakan ID ini untuk memecahkan masalah.	0000-ABCD-EFG****
Success	boolean	Apakah permintaan berhasil.	true
ErrorCode	string	Kode kesalahan.	1031203110005

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": 1234,
  "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.NoProject	You have not joined any project.
500	Invalid.Wkbench.NodeNotExist	The node does not exist.
500	Invalid.Wkbench.BaselineNotExist	The baseline does not exist.
500	Forbidden.Wkbench.RemindOverlimit	The maximum number of reminders is exceeded.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
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.