すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateDIAlarmRule

    ドキュメントセンター

    DataWorks:CreateDIAlarmRule

    最終更新日:Mar 21, 2026

    同期タスク向けのアラートルールを作成します。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Description

    string

    任意

    アラートルールの説明文です。

    The description of the alert rule.

    MetricType

    string

    必須

    アラートルールにおけるメトリクスタイプです。有効な値は以下のとおりです。

    • Heartbeat

    • FailoverCount

    • Delay

    • DdlReport

    • ResourceUtilization

    Heartbeat
    Enabled

    boolean

    任意

    アラートルールを有効化するかどうかを指定します。デフォルトでは、アラートルールは無効化されています。

    true
    DIJobId

    integer

    必須

    このアラートルールが関連付けられる同期タスクの ID です。

    1
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークンです。

    ABFUOEUOTRTRJKE
    Name

    string

    必須

    アラートルールの名前です。

    alartRule
    TriggerConditions

    array<object>

    必須

    アラートルールをトリガーする条件です。

    object

    任意

    アラートルールをトリガーする条件です。

    Severity

    string

    任意

    重大度レベルです。有効な値は以下のとおりです。

    • Warning

    • Critical

    Warning
    Duration

    integer

    任意

    アラート計算の時間間隔です。単位：分。

    10
    Threshold

    integer

    任意

    アラートのしきい値です。

    • タスクのステータスに関するアラートルールの場合、しきい値を指定する必要はありません。

    • フェールオーバーに関するアラートルールの場合、フェールオーバー回数を指定する必要があります。

    • レイテンシに関するアラートルールの場合、レイテンシの持続時間を秒単位で指定する必要があります。

    10
    DdlTypes

    array

    任意

    アラートルールが適用される DDL 操作の種類です。

    string

    任意

    アラートルールが適用される DDL 操作の種類です。MetricType パラメーターが DdlReport に設定されている場合にのみ、このパラメーターを指定する必要があります。有効な値は以下のとおりです。

    • AlterAddColumn

    • AlterDropColumn

    • AlterRenameColumn

    • AlterRenameTable

    • AlterTableModify

    • DropTable

    • TruncateTable

    AlterAddColumn
    DdlReportTags deprecated

    array

    任意

    このパラメーターは非推奨であり、DdlTypes パラメーターに置き換えられました。

    deprecated

    string

    任意

    このパラメーターは非推奨であり、DdlTypes パラメーターに置き換えられました。

    ALTERADDCOLUMN
    NotificationSettings

    object

    必須

    アラート通知の設定項目です。

    NotificationChannels

    array<object>

    任意

    アラート通知方法です。

    object

    任意

    アラート通知方法です。

    Severity

    string

    任意

    重大度レベルです。有効な値は以下のとおりです。

    • Warning

    • Critical

    Warning
    Channels

    array

    任意

    アラート通知方法です。有効な値は以下のとおりです。

    • Mail

    • Phone

    • Sms

    • Ding

    string

    任意

    アラート通知方法です。有効な値は以下のとおりです。

    • Mail

    • Phone

    • Sms

    • Ding

    Ding
    NotificationReceivers

    array<object>

    任意

    アラート通知受信者の設定です。

    object

    任意

    アラート通知受信者の設定です。

    ReceiverType

    string

    任意

    受信者タイプです。有効な値は AliyunUid、DingToken、FeishuToken、WebHookUrl です。

    DingToken
    ReceiverValues

    array

    任意

    受信者です。

    • ReceiverType パラメーターが AliyunUid の場合、このパラメーターにはユーザーの Alibaba Cloud アカウント ID を指定します。

    • ReceiverType パラメーターが DingToken の場合、このパラメーターには DingTalk チャットボットのトークンを指定します。

    string

    任意

    受信者です。

    • ReceiverType パラメーターが AliyunUid の場合、このパラメーターにはユーザーの Alibaba Cloud アカウント ID を指定します。

    • ReceiverType パラメーターが DingToken の場合、このパラメーターには DingTalk チャットボットのトークンを指定します。

    token1
    MuteInterval

    integer

    任意

    アラート抑制間隔の持続時間です。デフォルト値：5。単位：分。

    5
    InhibitionInterval deprecated

    integer

    任意

    このパラメーターは非推奨であり、MuteInterval パラメーターに置き換えられました。

    5

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ

    Id

    integer

    アラートルールの ID です。

    1
    RequestId

    string

    リクエスト ID です。この ID を使用してログを特定し、問題のトラブルシューティングを行えます。

    C636A747-7E4E-594D-94CD-2B4F8A9A9A63
    DIAlarmRuleId deprecated

    string

    このパラメーターは非推奨であり、Id パラメーターに置き換えられました。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "Id": 1,
  "RequestId": "C636A747-7E4E-594D-94CD-2B****",
  "DIAlarmRuleId": "1"
}

    エラーコード

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

    変更履歴

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