Mengambil daftar aturan peringatan kustom.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| PageNumber |
integer |
Yes |
Nomor halaman yang akan dikembalikan. Nilai yang valid: 1 hingga 30. Nilai default: 1. |
1 |
| PageSize |
integer |
Yes |
Jumlah entri yang akan dikembalikan per halaman. Nilai default: 10. Nilai maksimum: 100. |
10 |
| Founder |
string |
No |
ID akun Alibaba Cloud yang digunakan untuk membuat aturan peringatan kustom. |
9527952795**** |
| NodeId |
integer |
No |
ID node tempat aturan peringatan kustom diterapkan. Anda dapat menggunakan ID ini untuk mencari aturan peringatan kustom yang diterapkan pada node tersebut. |
1234 |
| RemindTypes |
string |
No |
Kondisi yang memicu peringatan untuk node. Nilai yang valid: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, dan TIMEOUT. Nilai FINISHED menunjukkan bahwa node selesai berjalan. Nilai UNFINISHED menunjukkan bahwa node masih berjalan pada titik waktu yang ditentukan. Nilai ERROR menunjukkan bahwa terjadi kesalahan saat node berjalan. Nilai CYCLE_UNFINISHED menunjukkan bahwa node tidak selesai berjalan dalam siklus penjadwalan yang ditentukan. Nilai TIMEOUT menunjukkan bahwa node mengalami timeout. Anda dapat menentukan beberapa kondisi untuk aturan peringatan kustom. Jika Anda menentukan beberapa kondisi, pisahkan dengan koma (,). |
FINISHED,ERROR |
| AlertTarget |
string |
No |
ID akun Alibaba Cloud yang digunakan untuk menerima notifikasi peringatan. |
9527952795**** |
| SearchText |
string |
No |
Kata kunci dalam nama aturan yang digunakan untuk mencari aturan. Pencarian fuzzy didukung. |
模糊搜索规则名称 |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
Kode status HTTP yang dikembalikan. |
200 |
| RequestId |
string |
ID permintaan. Anda dapat menggunakan ID ini untuk memecahkan masalah. |
0000-ABCD-EFG**** |
| ErrorMessage |
string |
Pesan kesalahan yang dikembalikan. |
The specified parameters are invalid. |
| ErrorCode |
string |
Kode kesalahan yang dikembalikan. |
1031203110005 |
| Success |
boolean |
Menunjukkan apakah permintaan berhasil. |
true |
| Data |
object |
Data yang dikembalikan. |
|
| PageNumber |
integer |
Nomor halaman dari halaman yang dikembalikan. |
1 |
| PageSize |
integer |
Jumlah entri yang dikembalikan per halaman. |
10 |
| TotalCount |
integer |
Jumlah total aturan peringatan kustom yang dikembalikan. |
100 |
| Reminds |
array<object> |
Daftar aturan peringatan kustom. |
|
|
object |
|||
| Founder |
string |
The ID of the Alibaba Cloud account used by the rule creator. |
952795**** |
| RemindId |
integer |
The custom alert rule ID. |
1234 |
| AlertUnit |
string |
The alert recipient. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user. |
OWNER |
| RemindType |
string |
The condition that triggers an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. |
FINISHED |
| DndEnd |
string |
The end time of the quiet hours. The time is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59]. |
08:00 |
| DndStart |
string |
The start time of the quiet hours. The time is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59]. |
00:00 |
| RemindUnit |
string |
The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow. |
NODE |
| Useflag |
boolean |
Indicates whether the custom alert rule is enabled. Valid values: true and false. |
true |
| RemindName |
string |
The name of the custom alert rule. |
规则名称 |
| AlertTargets |
array |
The IDs of the Alibaba Cloud accounts used by alert recipients. |
|
|
string |
The ID of the Alibaba Cloud account used by the alert recipient. |
952795**** |
|
| NodeIds |
array |
The IDs of the nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE. |
|
|
integer |
The ID of the node to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE. |
1234 |
|
| BizProcessIds |
array |
The IDs of the workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS. |
|
|
integer |
The ID of the workflow to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS. |
9527 |
|
| ProjectIds |
array |
The IDs of the workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT. |
|
|
integer |
The ID of the workspace to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT. |
1234 |
|
| BaselineIds |
array |
The IDs of the baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE. |
|
|
integer |
The ID of the baseline to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE. |
9527 |
|
| AlertMethods |
array |
The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method. |
|
|
string |
The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method. |
SMS |
Contoh
Respons sukses
JSONformat
{
"HttpStatusCode": 200,
"RequestId": "0000-ABCD-EFG****",
"ErrorMessage": "The specified parameters are invalid.",
"ErrorCode": "1031203110005",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Reminds": [
{
"Founder": "952795****",
"RemindId": 1234,
"AlertUnit": "OWNER",
"RemindType": "FINISHED",
"DndEnd": "08:00",
"DndStart": "00:00",
"RemindUnit": "NODE",
"Useflag": true,
"RemindName": "规则名称",
"AlertTargets": [
"952795****"
],
"NodeIds": [
1234
],
"BizProcessIds": [
9527
],
"ProjectIds": [
1234
],
"BaselineIds": [
9527
],
"AlertMethods": [
"SMS"
]
}
]
}
}Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | |
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 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.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.