すべてのプロダクト
Search

このプロダクト

    DataWorks:ListQualityResultsByEntity

    ドキュメントセンター

    DataWorks:ListQualityResultsByEntity

    最終更新日:Mar 18, 2026

    ListQualityResultsByEntity を使用して、パーティション式に基づいて検証結果を取得します。

    説明

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

    操作説明

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    EntityId

    integer

    必須

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

    15232
    StartDate

    string

    必須

    ビジネス日付範囲の開始。値は yyyy-MM-dd HH:mm:ss フォーマットである必要があります。

    2020-09-20 00:00:00
    EndDate

    string

    必須

    ビジネス日付範囲の終了。値は yyyy-MM-dd HH:mm:ss フォーマットである必要があります。

    2020-09-21 00:00:00
    PageSize

    integer

    必須

    ページあたりに返すエントリ数。デフォルトは 10、最大は 20 です。

    10
    PageNumber

    integer

    必須

    返すページ番号。

    1
    ProjectName

    string

    必須

    エンジンまたはデータソースの名前。この名前はデータソース設定ページで確認できます。

    autotest
    ProjectId

    integer

    必須

    DataWorks ワークスペースの ID。

    12345

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    データ品質チェック結果。

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    ErrorMessage

    string

    エラーメッセージ。

    You have no permission.
    RequestId

    string

    リクエストの ID。

    CBA58543-00D4-41****
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    ErrorCode

    string

    エラーコード。

    401
    Data

    object

    品質チェック結果を含むデータオブジェクト。

    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    ページあたりのエントリ数。デフォルト値：10。最大値：100。

    10
    TotalCount

    integer

    エントリの総数。

    50
    RuleChecks

    array<object>

    モニタリングルールのチェック結果。

    array<object>

    チェック結果。

    BlockType

    integer

    モニタリングルールの強度。有効値：

    • 1：強ルール。強ルールのチェックで重大アラートが生成された場合、関連付けられたスケジューリングタスクはブロックされます。

    • 0：弱ルール。

    0
    WarningThreshold

    number

    警告しきい値。この値は、期待値からの許容偏差を示します。ビジネス要件に基づいてこのしきい値をカスタマイズできます。

    0.1
    Property

    string

    データソーステーブル内のモニタリング対象の列の名前。

    type
    TableName

    string

    モニタリング対象のテーブルの名前。

    dual
    Comment

    string

    モニタリングルールの説明。

    The description of the rule.
    CheckResultStatus

    integer

    チェック結果のステータス。このパラメーターは UI に表示されるステータスに対応します。有効値：

    • 0：正常

    • 1：警告

    • 2：重大

    0
    TemplateName

    string

    ルールテンプレートの名前。

    Expected value verification
    CheckerName

    string

    チェッカーの名前。

    fulx
    RuleId

    integer

    モニタリングルール ID。

    123123232
    FixedCheck

    boolean

    チェックが固定値に基づいているかどうかを指定します。有効値：

    • true：チェックは固定値に基づいています。

    • false：チェックは固定値に基づいていません。

    false
    Op

    string

    比較演算子。

    >
    UpperValue

    number

    予測上限値。この値は、しきい値を設定した後に自動的に生成されます。

    25555
    ActualExpression

    string

    チェックされたデータパーティションを指定する式。

    ds=20200912
    ExternalId

    string

    スケジューリングタスクのノード ID。

    1112323123
    TimeCost

    string

    チェックの実行にかかった時間 (秒)。

    202
    Trend

    string

    チェック結果の傾向。

    abs
    ExternalType

    string

    スケジューリングシステムのタイプ。現在、CWF のみがサポートされています。

    CWF2
    BizDate

    integer

    ビジネス日付。モニタリング対象のデータがオフラインの場合、ビジネス日付は通常、チェックが実行される前日です。

    1600704000000
    CheckResult

    integer

    チェック結果。このパラメーターは通常、CheckResultStatus と同じ値を持ちます。有効値：

    • 0：正常

    • 1：警告

    • 2：重大

    0
    ResultString

    string

    文字列として返されるチェック結果。

    test
    MatchExpression

    string

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

    ds=$[yyyymmdd]
    CheckerType

    integer

    チェッカーのタイプ。有効値：

    • 0：固定値

    • 1：変動

    • 2：動的しきい値

    1
    ProjectName

    string

    モニタリング対象のコンピュートエンジンまたはデータソースの名前。

    autotest
    BeginTime

    integer

    チェックの開始時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。

    1600704000000
    DateType

    string

    スケジューリングサイクル。一般的な値は、年、月、日を表す YMD です。

    YMD
    CriticalThreshold

    number

    重大アラートをトリガーする、期待値からの許容偏差。このしきい値はカスタマイズ可能です。強ルールに対して重大アラートがトリガーされた場合、関連付けられたスケジューリングタスクはブロックされます。

    0.5
    IsPrediction

    boolean

    結果が予測値であるかどうかを指定します。有効値：

    • true：結果は予測値です。

    • false：結果は予測値ではありません。

    true
    RuleName

    string

    モニタリングルールの名前。

    The name of the rule.
    CheckerId

    integer

    チェッカーの ID。

    7
    DiscreteCheck

    boolean

    チェックが離散チェックであるかどうかを指定します。有効値：

    • true：チェックは離散チェックです。

    • false：チェックは離散チェックではありません。

    true
    EndTime

    integer

    チェックの終了時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。

    1600704000000
    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 が含まれます。

    count_distinct
    LowerValue

    number

    予測下限値。この値は、しきい値を設定した後に自動的に生成されます。

    2344
    EntityId

    integer

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

    15432322
    WhereCondition

    string

    モニタリングルールのフィルター条件。

    id>0
    ExpectValue

    number

    期待値。

    200
    TemplateId

    integer

    ルールテンプレートの ID。

    5
    TaskId

    string

    チェックタスクの ID。

    16008552981681a0d6****
    Id

    integer

    チェック結果の一意の ID。

    121212121
    ReferenceValue

    array<object>

    履歴サンプル値。

    object

    履歴チェック結果。

    DiscreteProperty

    string

    group by 句が使用される場合のサンプルフィールドの値。たとえば、gender フィールドでグループ化した場合、DiscreteProperty の値は male、female、または null になります。

    0
    Value

    number

    履歴チェック値。

    19
    BizDate

    string

    ビジネス日付。モニタリング対象のデータがオフラインの場合、ビジネス日付は通常、チェックが実行される前日です。

    2020-12-03
    SingleCheckResult

    integer

    単一チェックの結果。

    0
    Threshold

    number

    この履歴データポイントに適用されたしきい値。

    0.5
    SampleValue

    array<object>

    現在のサンプル値。

    object

    サンプルチェック結果。

    DiscreteProperty

    string

    group by 句が使用される場合のサンプルフィールドの値。たとえば、gender フィールドでグループ化した場合、DiscreteProperty の値は male、female、または null になります。

    0
    BizDate

    string

    ビジネス日付。モニタリング対象のデータがオフラインの場合、ビジネス日付は通常、チェックが実行される前日です。

    2020-12-03
    Value

    number

    現在のサンプル値。

    19

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "ErrorMessage": "You have no permission.",
  "RequestId": "CBA58543-00D4-41****",
  "Success": true,
  "ErrorCode": "401",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 50,
    "RuleChecks": [
      {
        "BlockType": 0,
        "WarningThreshold": 0.1,
        "Property": "type",
        "TableName": "dual",
        "Comment": "The description of the rule.",
        "CheckResultStatus": 0,
        "TemplateName": "Expected value verification",
        "CheckerName": "fulx",
        "RuleId": 123123232,
        "FixedCheck": false,
        "Op": ">",
        "UpperValue": 25555,
        "ActualExpression": "ds=20200912",
        "ExternalId": "1112323123",
        "TimeCost": "202",
        "Trend": "abs",
        "ExternalType": "CWF2",
        "BizDate": 1600704000000,
        "CheckResult": 0,
        "ResultString": "test",
        "MatchExpression": "ds=$[yyyymmdd]",
        "CheckerType": 1,
        "ProjectName": "autotest",
        "BeginTime": 1600704000000,
        "DateType": "YMD",
        "CriticalThreshold": 0.5,
        "IsPrediction": true,
        "RuleName": "The name of the rule.",
        "CheckerId": 7,
        "DiscreteCheck": true,
        "EndTime": 1600704000000,
        "MethodName": "count_distinct",
        "LowerValue": 2344,
        "EntityId": 15432322,
        "WhereCondition": "id>0",
        "ExpectValue": 200,
        "TemplateId": 5,
        "TaskId": "16008552981681a0d6****",
        "Id": 121212121,
        "ReferenceValue": [
          {
            "DiscreteProperty": "0",
            "Value": 19,
            "BizDate": "2020-12-03",
            "SingleCheckResult": 0,
            "Threshold": 0.5
          }
        ],
        "SampleValue": [
          {
            "DiscreteProperty": "0",
            "BizDate": "2020-12-03",
            "Value": 19
          }
        ]
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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