同期タスクに設定されたアラートルールを表示します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| JobId |
integer |
任意 |
アラートルールが設定されているタスクの ID です。 |
1000001 |
| PageNumber |
integer |
任意 |
ページ番号です。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりの件数です。デフォルト値は 10、最大値は 100 です。 |
10 |
| DIAlarmRuleId |
integer |
任意 |
アラートルールの ID です。このパラメーターを空欄のままにすると、対象タスクのすべてのアラートルールが照会されます。 |
34988 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターです。 |
||
| RequestId |
string |
リクエスト ID です。この ID を使用してログを照会したり、問題のトラブルシューティングを行ったりできます。 |
74C2FECD-5B3A-554A-BCF5-351A36DE9815 |
| PagingInfo |
object |
ページネーション情報です。 |
|
| TotalCount |
integer |
返された合計件数です。 |
90 |
| PageNumber |
integer |
ページ番号です。1 から始まります。 |
1 |
| PageSize |
integer |
1 ページあたりの件数です。 |
10 |
| DIJobAlarmRules |
array<object> |
アラートルールです。 |
|
|
array<object> |
アラートルールの詳細です。 |
||
| Id |
integer |
アラートルールの ID です。 |
72402 |
| DIJobId |
integer |
同期タスクの ID です。 |
32594 |
| Description |
string |
アラートルールの説明文です。 |
rule descrition |
| MetricType |
string |
アラートルールにおけるメトリクスタイプです。有効な値は以下のとおりです。
|
Heartbeat |
| Name |
string |
アラートルールの名前です。 |
rule_name |
| Enabled |
boolean |
アラートルールが有効かどうかを示します。有効な値は True および False です。 |
True |
| TriggerConditions |
array<object> |
アラートルールをトリガーする条件です。 |
|
|
object |
アラートルールをトリガーする条件です。 |
||
| Severity |
string |
重大度レベルです。有効な値は以下のとおりです。
|
Critical |
| Duration |
integer |
アラート計算の時間間隔です。単位は分です。 |
1 |
| Threshold |
integer |
アラートのしきい値です。
|
5 |
| DdlTypes |
array |
アラートルールが適用される DDL 操作の種類です。このパラメーターは、MetricType パラメーターが DdlReport に設定されている場合のみ返されます。 |
|
|
string |
アラートルールが適用される DDL 操作の種類です。このパラメーターは、MetricType パラメーターが DdlReport に設定されている場合のみ返されます。有効な値は以下のとおりです。
|
ALTERADDCOLUMN |
|
DdlReportTags
deprecated
|
array |
このパラメーターは非推奨であり、DdlTypes パラメーターに置き換えられました。 |
|
deprecated
|
string |
このパラメーターは非推奨であり、DdlTypes パラメーターに置き換えられました。 |
ALTERADDCOLUMN |
| NotificationSettings |
object |
アラート通知方法および受信者設定です。 |
|
| NotificationChannels |
array<object> |
アラート通知方法です。 |
|
|
object |
アラート通知方法です。 |
||
| Severity |
string |
重大度レベルです。有効な値は以下のとおりです。
|
Critical |
| Channels |
array |
アラート通知方法です。 |
|
|
string |
アラート通知方法です。有効な値は以下のとおりです。
|
Ding |
|
| NotificationReceivers |
array<object> |
アラート通知受信者の設定です。 |
|
|
object |
アラート通知受信者の設定です。 |
||
| ReceiverType |
string |
受信者タイプです。有効な値は AliyunUid、DingToken、FeishuToken、WebHookUrl です。 |
DingToken |
| ReceiverValues |
array |
受信者です。
|
|
|
string |
受信者です。
|
token1 |
|
| MuteInterval |
integer |
アラート抑制間隔の持続時間です。単位は分です。 |
5 |
InhibitionInterval
deprecated
|
integer |
このパラメーターは非推奨であり、MuteInterval パラメーターに置き換えられました。 |
5 |
DIAlarmRuleId
deprecated
|
integer |
このパラメーターは非推奨です。Id パラメーターをご使用ください。 |
72402 |
例
成功レスポンス
JSONJSON
{
"RequestId": "74C2FECD-5B3A-554A-BCF5-351A36DE9815",
"PagingInfo": {
"TotalCount": 90,
"PageNumber": 1,
"PageSize": 10,
"DIJobAlarmRules": [
{
"Id": 72402,
"DIJobId": 32594,
"Description": "rule descrition",
"MetricType": "Heartbeat",
"Name": "rule_name",
"Enabled": true,
"TriggerConditions": [
{
"Severity": "Critical",
"Duration": 1,
"Threshold": 5,
"DdlTypes": [
"AlterAddColumn"
],
"DdlReportTags": [
"ALTERADDCOLUMN"
]
}
],
"NotificationSettings": {
"NotificationChannels": [
{
"Severity": "Critical",
"Channels": [
"Ding"
]
}
],
"NotificationReceivers": [
{
"ReceiverType": "DingToken",
"ReceiverValues": [
"token1"
]
}
],
"MuteInterval": 5,
"InhibitionInterval": 5
},
"DIAlarmRuleId": 72402
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。