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 peringatan kustom. Nama tidak boleh melebihi 128 karakter.	test_error_remind
DndEnd	string	No	Waktu akhir jam tenang. Tentukan waktu dalam format hh:mm. Nilai valid hh: [0,23]. Nilai valid mm: [0,59].	08:00
RemindUnit	string	Yes	Tipe objek tempat aturan peringatan kustom diterapkan. Nilai valid: NODE, BASELINE, PROJECT, dan BIZPROCESS. Nilai NODE menunjukkan node. Nilai BASELINE menunjukkan garis dasar. Nilai PROJECT menunjukkan ruang kerja. Nilai BIZPROCESS menunjukkan alur kerja.	NODE
NodeIds	string	No	ID node tempat aturan peringatan kustom diterapkan. Parameter ini berlaku ketika parameter RemindUnit diatur ke NODE. Anda dapat menentukan beberapa ID. Pisahkan beberapa ID dengan koma (,). Maksimum 50 node dapat ditentukan untuk satu aturan peringatan kustom.	1,2,3
BaselineIds	string	No	ID garis dasar tempat aturan peringatan kustom diterapkan. Parameter ini berlaku ketika parameter RemindUnit diatur ke BASELINE. Anda dapat menentukan beberapa ID. Pisahkan beberapa ID dengan koma (,). Maksimum lima garis dasar dapat ditentukan untuk satu aturan peringatan kustom.	1,2,3
ProjectId	integer	No	ID ruang kerja tempat aturan peringatan kustom diterapkan. Parameter ini berlaku ketika parameter RemindUnit diatur ke PROJECT. Anda hanya dapat menentukan satu ruang kerja untuk satu aturan peringatan kustom.	9527
BizProcessIds	string	No	ID alur kerja tempat aturan peringatan kustom diterapkan. Parameter ini berlaku ketika parameter RemindUnit diatur ke BIZPROCESS. Anda dapat menentukan beberapa ID. Pisahkan beberapa ID dengan koma (,). Maksimum lima alur kerja dapat ditentukan untuk satu aturan peringatan kustom.	1,2,3
RemindType	string	Yes	Kondisi yang memicu peringatan. Nilai valid: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, dan TIMEOUT.	FINISHED
MaxAlertTimes	integer	No	Jumlah maksimum peringatan. Nilai valid: 1 hingga 10. Nilai default: 3.	2
AlertInterval	integer	No	Interval minimum pelaporan peringatan. Unit: detik. Nilai minimum: 1200. Nilai default: 1800.	1800
Detail	string	No	Detail kondisi yang memicu peringatan. Jika parameter RemindType diatur ke FINISHED, kosongkan parameter ini. Jika parameter RemindType diatur ke UNFINISHED, konfigurasikan parameter ini sebagai pasangan kunci-nilai. Contoh: {"hour":23,"minu":59}. Nilai valid hour: [0,47]. Nilai valid minu: [0,59]. Jika parameter RemindType diatur ke ERROR, kosongkan parameter ini. Jika parameter RemindType diatur ke CYCLE_UNFINISHED, konfigurasikan parameter ini sebagai pasangan kunci-nilai. 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 menunjukkan ID siklus. Nilai valid: [1,288]. Nilai menunjukkan periode timeout node yang berjalan dalam siklus. Tentukan nilai dalam format hh:mm. Nilai valid hh: [0,47]. Nilai valid mm: [0,59]. Jika parameter RemindType diatur ke TIMEOUT, atur parameter ini ke periode timeout. Unit: detik. Contoh: 1800. Nilai ini menunjukkan bahwa peringatan dilaporkan jika node telah berjalan lebih dari 30 menit.	{"hour":"23","minu":"59"}
AlertUnit	string	Yes	Penerima peringatan. Nilai valid: OWNER dan OTHER. Nilai OWNER menunjukkan pemilik node. Nilai OTHER menunjukkan pengguna tertentu.	OWNER
AlertMethods	string	Yes	Metode notifikasi. Nilai valid: MAIL: Notifikasi peringatan dikirim melalui email. SMS: Notifikasi peringatan dikirim melalui pesan teks. Notifikasi peringatan hanya dapat dikirim melalui pesan teks di wilayah Singapura, Malaysia (Kuala Lumpur), dan Jerman (Frankfurt). WEBHOOKS (chatbot WeCom atau Lark): Notifikasi peringatan dikirim melalui pesan WeCom atau Lark. Jika Anda ingin menggunakan metode notifikasi ini, Anda harus mengonfigurasi parameter Webhooks. DINGROBOTS: Notifikasi peringatan dikirim melalui chatbot DingTalk. Anda dapat menentukan beberapa metode notifikasi. Pisahkan dengan koma (,).	SMS,MAIL
AlertTargets	string	No	Jika parameter AlertUnit diatur ke OWNER, kosongkan parameter ini. Jika parameter AlertUnit diatur ke OTHER, atur parameter ini ke ID akun Alibaba Cloud yang digunakan oleh pengguna tertentu. Anda dapat menentukan beberapa ID. Pisahkan beberapa ID dengan koma (,). Anda dapat menentukan maksimum 10 ID.	9527952795279527
RobotUrls	string	No	URL webhook chatbot DingTalk. Anda dapat menentukan beberapa URL webhook. Pisahkan beberapa URL webhook dengan koma (,).	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 (,). Anda harus menentukan WEBHOOKS untuk AlertMethods. Hanya DataWorks Edisi Perusahaan yang mendukung parameter ini. Fitur peringatan berbasis URL webhook didukung di wilayah berikut: Tiongkok (Shanghai), Tiongkok (Chengdu), Tiongkok (Zhangjiakou), Tiongkok (Beijing), Tiongkok (Hangzhou), Tiongkok (Shenzhen), Tiongkok (Hong Kong), Jerman (Frankfurt), dan Singapura.	https://open.feishu.cn/open-apis/bot/v2/hook/*******

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
Data	integer	The ID of the custom alert rule.	1234
ErrorMessage	string	The error message.	The specified parameters are invalid.
RequestId	string	The request ID.	0000-ABCD-EFG****
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	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.