すべてのプロダクト
Search

このプロダクト

    DataWorks:ListDataQualityRules

    ドキュメントセンター

    DataWorks:ListDataQualityRules

    最終更新日:Sep 03, 2026

    品質モニタリングルールをページ単位で照会します。

    説明

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

    操作説明

    この特徴を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。

    今すぐお試しください

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

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:*

    list

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ProjectId

    integer

    必須

    DataWorks ワークスペースの ID。

    10002
    DataQualityEvaluationTaskId

    integer

    任意

    関連付けられた品質チェックタスクの ID。

    10000
    TableGuid

    string

    任意

    DataWorks データマップにおいてルールが適用されるテーブルの一意な識別子。

    odps.unit_test.tb_unit_test
    Name

    string

    任意

    あいまい一致に使用するルール名。

    unit_test
    PageSize

    integer

    任意

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

    10
    PageNumber

    integer

    必須

    ページング用のページ番号。デフォルト値: 1。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    RequestId

    string

    リクエスト ID。

    691CA452-D37A-4ED0-9441
    PagingInfo

    object

    ルールリストのページネーションクエリ結果。

    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    ページサイズ。

    10
    TotalCount

    integer

    エントリの総数。

    294
    DataQualityRules

    array<object>

    ルールのリスト。

    array<object>

    Id

    integer

    ルールの ID。

    22130
    Name

    string

    ルール名。

    The table cannot be empty
    ProjectId

    integer

    DataWorks ワークスペースの ID。

    100001
    Enabled

    boolean

    品質ルールが有効かどうかを示します。

    true
    Severity

    string

    ビジネスに対するルールの重大度レベル (ページの強/弱ルールに対応)。有効な値:

    • 法線

    • High

    High
    Description

    string

    ルールの説明。最大長: 500 文字。

    これは odps _sql タスクです
    Target

    object

    ルールによって監視されるオブジェクト。

    Type

    string

    監視対象のオブジェクトタイプ。

    • Table

    Table
    DatabaseType

    string

    テーブルタイプデータセットの場合のテーブルのデータベースタイプ。有効な値:

    • maxcompute

    • emr

    • cdh

    • hologres

    • analyticdb_for_postgresql

    • analyticdb_for_mysql

    • starrocks

    maxcompute
    TableGuid

    string

    DataWorks データマップにおいてルールが適用されるテーブルの一意な ID。

    odps.unit_test.tb_unit_test
    TemplateCode

    string

    ルールによってリファレンスされるルールテンプレートの一意な識別子。

    SYSTEM:user_defined_sql
    SamplingConfig

    object

    サンプルコレクションに必須の設定項目。

    Metric

    string

    サンプリング用のメトリック名。有効な値:

    • Count: テーブルの行数。

    • Min: フィールドの最小値。

    • Max: フィールドの最大値。

    • Avg: フィールドの平均値。

    • DistinctCount: フィールド内の一意な値の数。

    • DistinctPercent: 一意な値の総行数に対する比率。

    • DuplicatedCount: フィールド内の重複値の数。

    • DuplicatedPercent: 重複値の総行数に対する比率。

    • TableSize: テーブルサイズ。

    • NullValueCount: フィールドが null である行数。

    • NullValuePercent: フィールド内の null 値の比率。

    • GroupCount: フィールド値による集約後の各値の行数。

    • CountNotIn: 列挙値と一致しない行数。

    • CountDistinctNotIn: 列挙値と一致しない一意な値の数。

    • UserDefinedSql: カスタム SQL を通じたサンプルコレクション。

    Max
    MetricParameters

    string

    サンプルコレクションに必須のパラメーター。

    { "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}
    SettingConfig

    string

    サンプリング文の前に実行する実行時パラメーター設定文。最大長: 1000 文字。現在、MaxCompute のみがサポートされています。

    SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;
    SamplingFilter

    string

    サンプリング中に無関係なデータを二次フィルタリングするためのフィルター条件。最大長: 16,777,215 文字。

    id IS NULL
    CheckingConfig

    object

    サンプルチェックの設定項目。

    Type

    string

    しきい値の計算メソッド。有効な値:

    • Fixed

    • Fluctation

    • FluctationDiscreate

    • Auto

    • Average

    • Variance

    Fixed
    ReferencedSamplesFilter

    string

    リファレンスサンプルのクエリ方法を指定する式。一部のしきい値タイプでは、リファレンスサンプルをクエリし、その値を集約して比較しきい値を導出する必要があります。

    { "bizdate": [ "-1", "-7", "-1m" ] }
    Thresholds

    object

    しきい値の設定項目。

    Expected

    object

    期待されるしきい値の設定項目。

    Operator

    string

    比較演算子。有効な値:

    • >

    • >=

    • <

    • <=

    • !=

    • =

    >
    Value

    string

    しきい値。

    100.0
    Expression

    string

    しきい値の式。

    変動型ルールの場合、変動しきい値を表すために式を使用する必要があります。例:

    • 変動増加レートが 0.01 を超える場合: $checkValue > 0.01

    • 変動減少レートが 0.01 を超える場合: $checkValue < -0.01

    • 変動レートの絶対値: abs($checkValue) > 0.01

    固定値型ルールの場合も、式を使用してしきい値を設定できます。両方が設定されている場合、式が Operator および Value よりも優先されます。

    $checkValue > 0.01
    Warned

    object

    通常警告のしきい値設定項目。

    Operator

    string

    比較演算子。有効な値:

    • >

    • >=

    • <

    • <=

    • !=

    • =

    >
    Value

    string

    しきい値。

    100.0
    Expression

    string

    しきい値の式。

    変動型ルールの場合、変動しきい値を表すために式を使用する必要があります。例:

    • 変動増加レートが 0.01 を超える場合: $checkValue > 0.01

    • 変動減少レートが 0.01 を超える場合: $checkValue < -0.01

    • 変動レートの絶対値: abs($checkValue) > 0.01

    固定値型ルールの場合も、式を使用してしきい値を設定できます。両方が設定されている場合、式が Operator および Value よりも優先されます。

    $checkValue > 0.01
    Critical

    object

    重大警告のしきい値設定項目。

    Operator

    string

    比較演算子。有効な値:

    • >

    • >=

    • <

    • <=

    • !=

    • =

    >
    Value

    string

    しきい値。

    100.0
    Expression

    string

    しきい値の式。

    変動型ルールの場合、変動しきい値を表すために式を使用する必要があります。例:

    • 変動増加レートが 0.01 を超える場合: $checkValue > 0.01

    • 変動減少レートが 0.01 を超える場合: $checkValue < -0.01

    • 変動レートの絶対値: abs($checkValue) > 0.01

    固定値型ルールの場合も、式を使用してしきい値を設定できます。両方が設定されている場合、式が Operator および Value よりも優先されます。

    $checkValue > 0.01
    ErrorHandlers

    array<object>

    品質ルールチェックエラーハンドラのリスト。

    object

    品質ルールチェックエラーハンドラ。

    Type

    string

    ハンドラのタイプ。有効な値:

    • SaveErrorData

    SaveErrorData
    ErrorDataFilter

    string

    カスタム SQL ルールの場合、ユーザーが指定したエラーデータをフィルターするための SQL ステートメント。

    SELECT * FROM tb_api_log WHERE id IS NULL

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "691CA452-D37A-4ED0-9441",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 294,
    "DataQualityRules": [
      {
        "Id": 22130,
        "Name": "The table cannot be empty.",
        "ProjectId": 100001,
        "Enabled": true,
        "Severity": "High",
        "Description": "this is a odps _sql task",
        "Target": {
          "Type": "Table",
          "DatabaseType": "maxcompute",
          "TableGuid": "odps.unit_test.tb_unit_test"
        },
        "TemplateCode": "SYSTEM:user_defined_sql",
        "SamplingConfig": {
          "Metric": "Max",
          "MetricParameters": "{ \"Columns\": [ \"id\", \"name\" ] , \"SQL\": \"select count(1) from table;\"}",
          "SettingConfig": "SET odps.sql.udf.timeout=600s; \nSET odps.sql.python.version=cp27;",
          "SamplingFilter": "id IS NULL"
        },
        "CheckingConfig": {
          "Type": "Fixed",
          "ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }",
          "Thresholds": {
            "Expected": {
              "Operator": ">",
              "Value": "100.0",
              "Expression": "$checkValue > 0.01"
            },
            "Warned": {
              "Operator": ">",
              "Value": "100.0",
              "Expression": "$checkValue > 0.01"
            },
            "Critical": {
              "Operator": ">",
              "Value": "100.0",
              "Expression": "$checkValue > 0.01"
            }
          }
        },
        "ErrorHandlers": [
          {
            "Type": "SaveErrorData\n",
            "ErrorDataFilter": "SELECT * FROM tb_api_log WHERE id IS NULL"
          }
        ]
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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