すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateQualityRule

    ドキュメントセンター

    DataWorks:CreateQualityRule

    最終更新日:Mar 18, 2026

    CreateQualityRule を呼び出して、品質ルールを作成します。

    説明

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

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BlockType

    integer

    必須

    ルールの強度。有効な値は次のとおりです。

    • 0: 弱いルール

    • 1: 強制ルール

    0
    EntityId

    integer

    必須

    パーティションフィルター式の ID。

    15224
    Comment

    string

    任意

    ルールのコメント。

    Verification
    Checker

    integer

    任意

    チェッカーの ID。有効な値は次のとおりです。

    • 2: 7日間平均変動

    • 3: 30日間平均変動

    • 4: 前日比比較

    • 5: 前週比比較

    • 6: 前月比比較

    • 7: 7日間分散変動

    • 8: 30日間分散変動

    • 9: 固定値との比較

    • 10: 1日、7日、30日間の変動検出

    • 11: 前サイクルとの比較

    9
    ExpectValue

    string

    任意

    期待値。

    0
    Trend

    string

    任意

    チェック結果の傾向。有効な値は次のとおりです。

    • up: 上昇傾向

    • down: 下降傾向

    • abs: 絶対値

    abs
    MethodName

    string

    任意

    チェック方法。カスタム SQL ステートメントを使用する場合は、このパラメーターを user_defined に設定します。

    count/table_count
    Operator

    string

    任意

    比較演算子。例: >、>=、=、<>、<、<=。

    説明

    Checker パラメーターを 9 に設定する場合は、Operator パラメーターを指定する必要があります。

    >
    ProjectName

    string

    必須

    コンピュートエンジンまたはデータソースの名前。

    autotest
    Property

    string

    任意

    ルールによって監視されるフィールド。テーブルレベルのチェックを実行するには、このパラメーターを行数の場合は table_count に、テーブルサイズの場合は table_size に設定します。

    table_id
    PropertyType

    string

    任意

    フィールドのデータの型。テーブルレベルのチェックの場合は、このパラメーターを table に設定します。フィールドレベルのチェックの場合は、bigint などの特定のデータの型に設定します。

    bigint
    RuleType

    integer

    必須

    ルールのタイプ。有効な値は次のとおりです。

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

    • 1: カスタム SQL

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

    0
    WhereCondition

    string

    任意

    フィルター条件またはカスタム SQL ステートメント。

    table_id>1
    CriticalThreshold

    string

    任意

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

    20
    WarningThreshold

    string

    任意

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

    10
    TemplateId

    integer

    任意

    テンプレートの ID。

    7
    RuleName

    string

    必須

    ルールの名前。

    1234
    PredictType

    integer

    必須

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

    0
    ProjectId

    integer

    必須

    DataWorks ワークスペース ID。DataWorks コンソールにログインし、ワークスペース管理ページに移動してワークスペース ID を取得できます。

    10000
    TaskSetting

    string

    任意

    カスタムルールを挿入する前の変数設定。形式: x=a,y=b。

    x=a,y=b

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Data

    string

    新しいルールの ID。

    12345
    ErrorMessage

    string

    エラーメッセージ。

    You have no permission.
    RequestId

    string

    リクエスト ID。

    ecb967ec-c137-48****
    ErrorCode

    string

    エラーコード。

    401
    Success

    boolean

    リクエストが成功したかどうか。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "Data": "12345",
  "ErrorMessage": "You have no permission.",
  "RequestId": "ecb967ec-c137-48****",
  "ErrorCode": "401",
  "Success": true
}

    エラーコード

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

    変更履歴

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