すべてのプロダクト
Search

このプロダクト

    DataWorks:GetDataQualityRule

    ドキュメントセンター

    DataWorks:GetDataQualityRule

    最終更新日:Sep 03, 2026

    Data Quality ルールの詳細を照会します。

    説明

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

    操作説明

    この特徴を使用するには、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:*

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Id

    integer

    必須

    ルールの ID。

    19715

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    RequestId

    string

    API リクエストの ID。

    691CA452-D37A-4ED0-****
    DataQualityRule

    object

    ルールの詳細。

    Id

    integer

    ルールの ID。

    16033
    Name

    string

    ルール名。

    テーブルは空にできません
    ProjectId

    integer

    DataWorks ワークスペースの ID。

    1948
    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

    ルールが適用されるデータマップ内のテーブルの一意な ID。

    odps.unit_test.tb_unit_test
    PartitionSpec

    string

    パーティションテーブルのパーティション設定。

    ds=$[yyyymmdd-1]
    TemplateCode

    string

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

    SYSTEM:table:table_count:fixed
    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

    サンプリング文の前に実行される実行時パラメーター設定文。値は最大 1,000 文字まで指定できます。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

    しきい値の式。

    $checkValue <= 0.01
    Warned

    object

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

    Operator

    string

    比較演算子。有効な値:

    • >

    • >=

    • <

    • <=

    • !=

    • =

    >
    Value

    string

    しきい値。

    100.0
    Expression

    string

    しきい値の式。

    $checkValue > 0.01
    Critical

    object

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

    Operator

    string

    比較演算子。有効な値:

    • >

    • >=

    • <

    • <=

    • !=

    • =

    >
    Value

    string

    しきい値。

    100.0
    Expression

    string

    しきい値の式。

    $checkValue > 0.05
    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-****",
  "DataQualityRule": {
    "Id": 16033,
    "Name": "The table cannot be empty.\n",
    "ProjectId": 1948,
    "Enabled": true,
    "Severity": "High",
    "Description": "this is a odps _sql task\n",
    "Target": {
      "Type": "Table",
      "DatabaseType": "maxcompute",
      "TableGuid": "odps.unit_test.tb_unit_test\n",
      "PartitionSpec": "ds=$[yyyymmdd-1]\n"
    },
    "TemplateCode": "SYSTEM:table:table_count:fixed",
    "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;\n",
      "SamplingFilter": "id IS NULL\n"
    },
    "CheckingConfig": {
      "Type": "Fixed",
      "ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }\n",
      "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.05"
        }
      }
    },
    "ErrorHandlers": [
      {
        "Type": "SaveErrorData\n",
        "ErrorDataFilter": "SELECT * FROM tb_api_log WHERE id IS NULL\n"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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