すべてのプロダクト
Search

このプロダクト

    DataWorks:UpdateQualityRule

    ドキュメントセンター

    DataWorks:UpdateQualityRule

    最終更新日:Jul 31, 2026

    Data Quality ルールの情報を更新します。

    説明

    この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに dataworks-public(2024-05-18) - UpdateDataQualityScan への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BlockType

    integer

    任意

    Data Quality ルールの強度。強度はルールの重要度を示します。有効な値:

    • 1: 強制ルール。

    • 0: 通常ルール。 業務要件に基づき、重要なルールを強制ルールとして設定できます。強制ルールが使用され、レッドアラートがトリガーされた場合、スケジューリングタスクはブロックされます。

    列挙値:

    • 0 :

      通常ルール。

    • 1 :

      強制ルール。

    0
    EntityId

    integer

    任意

    パーティション式の ID。 ListQualityRules 操作を呼び出して、パーティション式 ID を取得できます。

    123
    Comment

    string

    任意

    Data Quality ルールの説明。

    テーブルの行数を確認する
    Checker

    integer

    任意

    チェッカー ID。 2: 7 日間の平均変動。 3: 30 日間の平均変動。 4: 1 日の周期比較。 5: 7 日間の周期比較。 6: 30 日間の周期比較。 7: 7 日間の分散変動。 8: 30 日間の分散変動。 9: 固定値との比較。 10: 1 日、7 日、30 日の変動検出。 11: 前の周期との比較。 ListQualityRules 操作を呼び出して、チェッカー ID を取得できます。

    9
    ExpectValue

    string

    任意

    チェック結果の期待値。

    300
    Id

    integer

    必須

    Data Quality ルールの ID。 ListQualityRules 操作を呼び出して、ルール ID を取得できます。

    1234
    Trend

    string

    任意

    チェック結果の傾向。有効な値:

    • up: 上昇傾向。

    • down: ダウン傾向。

    • abs: 絶対値。

    up
    MethodName

    string

    必須

    サンプルデータの収集に使用するメソッドの名前。有効な値: avg、count、sum、min、max、count_distinct、user_defined、table_count、table_size、table_dt_load_count、table_dt_refuseload_count、null_value、null_value/table_count、(table_count-count_distinct)/table_count、table_count-count_distinct。

    table_count
    Operator

    string

    任意

    比較演算子。有効な値: >、>=、=、≠、<、<=。

    説明

    Checker が 9 に設定されている場合、Operator は必須パラメーターです。

    >
    ProjectName

    string

    必須

    エンジンまたはデータソースの名前。DataWorks コンソール にログインし、ワークスペース管理ページに移動して名前を取得できます。

    autotest
    Property

    string

    必須

    フィールドの名前。

    id
    PropertyType

    string

    任意

    フィールドのタイプ。

    bigint
    RuleType

    integer

    任意

    ルールのタイプ。有効な値:

    • 0: システムテンプレートルール。

    • 1: カスタム SQL ルール。

    • 4: カスタムテンプレートルール。

    0
    WhereCondition

    string

    任意

    チェックタスクで使用されるフィルター条件またはカスタム SQL ステートメント。

    dt=$[yyyymmdd]
    CriticalThreshold

    string

    任意

    レッドアラートのしきい値。この値は、サンプルの期待値からの逸脱次数を示します。業務要件に基づいてこのしきい値をカスタマイズできます。強制ルールが使用され、レッドアラートのしきい値がトリガーされた場合、スケジューリングタスクはブロックされます。

    10
    WarningThreshold

    string

    任意

    オレンジアラートのしきい値。この値は、サンプルの期待値からの逸脱次数を示します。業務要件に基づいてこのしきい値をカスタマイズできます。

    5
    TemplateId

    integer

    任意

    チェックテンプレートの ID。 ListQualityRules 操作を呼び出して、チェックテンプレート ID を取得できます。

    7
    RuleName

    string

    任意

    Data Quality ルールの名前。

    123
    PredictType

    integer

    任意

    しきい値が動的かどうかを指定します。有効な値:

    • 0: 非動的なしきい値。

    • 2: 動的なしきい値。

    0
    OpenSwitch

    boolean

    任意

    ルールの有効/無効ステータス。本番環境で Data Quality ルールを実行するかどうかを制御します。

    • true: Data Quality ルールの出力テーブルデータに関連付けられたスケジューリングタスクが実行されると、Data Quality ルールのチェックがトリガーされます。

    • false: Data Quality ルールの出力テーブルデータに関連付けられたスケジューリングタスクが実行されても、Data Quality ルールのチェックはトリガーされません。

    true
    ProjectId

    integer

    必須

    DataWorks ワークスペースの ID。

    26
    TaskSetting

    string

    任意

    カスタムルールの前に挿入される変数設定。x=a,y=b のフォーマットでセットします。

    x=a,y=b

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンス構造体。

    HttpStatusCode

    integer

    HTTP 状態コード。

    200
    Data

    boolean

    Data Quality ルールが更新されたかどうかを示します。

    true
    ErrorMessage

    string

    エラーメッセージ。

    権限がありません
    RequestId

    string

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

    576b9457-2cf5-4****
    ErrorCode

    string

    エラーコード。

    0
    Success

    boolean

    呼び出しが成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "You have no permission.",
  "RequestId": "576b9457-2cf5-4****",
  "ErrorCode": "0",
  "Success": true
}

    エラーコード

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

    変更履歴

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