GetDIAlarmRule によるアラートルール詳細の取得 - DataWorks

新バージョンの同期タスクに設定されたアラートルールの詳細を照会します。サポートされるタスクの種類は、MySQL データベースから Hologres へのリアルタイムデータ同期のみです。

操作説明

タスクの同期タイプにリアルタイム同期が含まれる場合、アラートルールの設定が可能です。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DIAlarmRuleId	integer	必須	アラートルールの ID。	34994

レスポンスフィールド

フィールド	型	説明	例
	object	応答結果。
RequestId	string	リクエスト ID。	4A807D85-AC9F-55F7-A58F-998D5249CAD9
DIAlarmRule	object	アラートルールの詳細。
DIAlarmRuleId	integer	アラートルールの ID。	34988
DIJobId	integer	このアラートルールが関連付けられたタスクの ID。	11170
Description	string	アラートルールの説明。	mysql synchronizes to hologres heartbeat alert
MetricType	string	アラートルールにおけるメトリクスタイプ。有効な値： Heartbeat FailoverCount Delay	Heartbeat
Enabled	boolean	アラートルールが有効かどうかを示します。	true
TriggerConditions	array<object>	アラートルールをトリガーする条件。
	object	アラートルールをトリガーする条件。
Severity	string	重大度レベル。有効な値： Warning Critical	Warning
Duration	integer	アラート計算の時間間隔。単位：分。	15
Threshold	integer	アラートのしきい値。タスクステータスに対するアラートルールの場合、しきい値は使用されません。フェールオーバーに対するアラートルールの場合、フェールオーバー回数を指定します。遅延に対するアラートルールの場合、しきい値は遅延時間（秒）です。	5
NotificationSettings	object	アラート通知の設定項目。
NotificationChannels	array<object>	アラート通知方法。
	object	アラート通知方法。
Severity	string	重大度レベル。有効な値： Warning Critical	Warning
Channels	array	アラート通知方法。
	string	アラート通知方法。有効な値： Mail：メール Phone：電話通話 Sms：ショートメッセージ Ding：DingTalk チャットボットトークン	Ding
NotificationReceivers	array<object>	アラート通知の受信者。
	object	アラート通知の受信者。
ReceiverType	string	受信者タイプ。有効な値：AliyunUid および DingToken。アラート通知方法が Mail、Phone、または Sms の場合、このパラメーターの値は AliyunUid（Alibaba Cloud アカウント ID）となります。アラート通知方法が Ding の場合、このパラメーターの値は DingToken（DingTalk チャットボットトークン）となります。	DingToken
ReceiverValues	array	受信者。
	string	受信者。受信者タイプが Alibaba Cloud アカウント ID の場合、このパラメーターにはユーザーの Alibaba Cloud アカウント ID を設定します。受信者タイプが DingTalk チャットボットトークンの場合、このパラメーターには DingTalk チャットボットのトークンを設定します。	token1
InhibitionInterval	integer	アラート抑制間隔の持続時間。単位：分。	5
CreatedUid	string	アラートルールを作成したユーザーの ID。	10000001
CreatedTime	integer	アラートルールが作成されたタイムスタンプ。単位：秒。	1663573162
UpdatedUid	string	アラートルールを最後に更新したユーザーの ID。	10000001
UpdatedTime	integer	アラートルールが最後に更新されたタイムスタンプ。単位：秒。	1663573163

例

成功レスポンス

JSONJSON

{
  "RequestId": "4A807D85-AC9F-55F7-A58F-998D5249CAD9",
  "DIAlarmRule": {
    "DIAlarmRuleId": 34988,
    "DIJobId": 11170,
    "Description": "mysql synchronizes to hologres heartbeat alert",
    "MetricType": "Heartbeat",
    "Enabled": true,
    "TriggerConditions": [
      {
        "Severity": "Warning",
        "Duration": 15,
        "Threshold": 5
      }
    ],
    "NotificationSettings": {
      "NotificationChannels": [
        {
          "Severity": "Warning",
          "Channels": [
            "Ding"
          ]
        }
      ],
      "NotificationReceivers": [
        {
          "ReceiverType": "DingToken",
          "ReceiverValues": [
            "token1"
          ]
        }
      ],
      "InhibitionInterval": 5
    },
    "CreatedUid": "10000001",
    "CreatedTime": 1663573162,
    "UpdatedUid": "10000001",
    "UpdatedTime": 1663573163
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。