すべてのプロダクト
Search

このプロダクト

    DataWorks:UpdateQualityRule

    ドキュメントセンター

    DataWorks:UpdateQualityRule

    最終更新日:Mar 18, 2026

    指定された品質ルールを更新します。

    説明

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

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BlockType

    integer

    任意

    品質ルールの強度です。ルールの重要度に基づいて、ルールを強制ルールまたは弱いルールとして指定できます。有効な値:

    • 1: 強制ルール

    • 0: 弱いルール ルールを強制ルールとして指定し、そのルールに対して重大なアラートがトリガーされた場合、関連するタスクのスケジューリングはブロックされます。

    0
    EntityId

    integer

    任意

    パーティションフィルター式の ID です。ListQualityRules 操作を呼び出して、パーティションフィルター式の ID をクエリできます。

    123
    Comment

    string

    任意

    品質ルールの説明です。

    Verify the number of table rows
    Checker

    integer

    任意

    チェッカー ID です。ListQualityRules 操作を呼び出して、チェッカー ID をクエリできます。

    9
    ExpectValue

    string

    任意

    期待値です。

    300
    Id

    integer

    必須

    ルール 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 に設定した場合、このパラメーターは必須です。

    >
    ProjectName

    string

    必須

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

    autotest
    Property

    string

    必須

    フィールドの名前です。

    id
    PropertyType

    string

    任意

    フィールドのデータの型です。

    bigint
    RuleType

    integer

    任意

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

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

    • 1: カスタム SQL

    • 2: カスタムテンプレート

    0
    WhereCondition

    string

    任意

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

    dt=$[yyyymmdd]
    CriticalThreshold

    string

    任意

    重大なアラートのしきい値です。このしきい値は、チェック結果の期待値からの偏差を指定します。ビジネス要件に基づいてしきい値をカスタマイズできます。強制ルールを使用し、重大なアラートがトリガーされた場合、関連するタスクのスケジューリングはブロックされます。

    10
    WarningThreshold

    string

    任意

    警告アラートのしきい値です。このしきい値は、チェック結果の期待値からの偏差を指定します。ビジネス要件に基づいてしきい値をカスタマイズできます。

    5
    TemplateId

    integer

    任意

    チェックに使用されるテンプレートの ID です。ListQualityRules 操作を呼び出して、テンプレート ID をクエリできます。

    7
    RuleName

    string

    任意

    品質ルールの名前です。

    123
    PredictType

    integer

    任意

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

    • 0: いいえ

    • 2: はい

    0
    OpenSwitch

    boolean

    任意

    品質ルールを有効または無効にするかどうかを指定します。このパラメーターは、本番環境で品質ルールを実行するかどうかを指定します。

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

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

    true
    ProjectId

    integer

    必須

    DataWorks ワークスペース ID です。

    26
    TaskSetting

    string

    任意

    カスタムルールが挿入される前の変数設定です。設定は x=a,y=b の形式です。

    x=a,y=b

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データです。

    HttpStatusCode

    integer

    HTTP ステータスコードです。

    200
    Data

    boolean

    検証ルールが正常に更新されたかどうかを示します。

    true
    ErrorMessage

    string

    リクエストが失敗したときに返されるエラーメッセージです。

    You have no permission.
    RequestId

    string

    リクエストの ID です。トラブルシューティングに使用されます。

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

    string

    リクエストが失敗したときに返されるエラーコードです。

    0
    Success

    boolean

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

    true

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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