すべてのプロダクト
Search

このプロダクト

    DataWorks:ListDataQualityScans

    ドキュメントセンター

    DataWorks:ListDataQualityScans

    最終更新日:Mar 21, 2026

    プロジェクト内のデータ品質スキャンタスクの一覧を照会します。

    操作説明

    DataWorks ベーシックエディション以上をご購入いただく必要があります。

    今すぐお試しください

    この 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:ListDataQualityScans

    list

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Name

    string

    任意

    あいまい一致によるデータ品質スキャンタスク名。

    test
    SortBy

    string

    任意

    ソートフィールドの一覧。最終更新時刻や作成時刻などのフィールドをサポートしています。形式：「SortField+SortOrder (Desc/Asc)」。Asc がデフォルトです。有効な値：

    • ModifyTime (Desc/Asc)

    • CreateTime (Desc/Asc)

    • Id (Desc/Asc)

    ModifyTime Desc
    PageSize

    integer

    必須

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

    10
    PageNumber

    integer

    必須

    ページ番号。デフォルト値：1。

    1
    ProjectId

    integer

    必須

    プロジェクト ID。

    10000
    Table

    string

    任意

    監視対象テーブル名のあいまい一致。

    video_album

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ

    RequestId

    string

    API リクエスト ID。UUID 形式で生成されます。

    0bc14115***159376359
    PageInfo

    object

    ページ情報。

    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1 ページあたりのレコード数。デフォルト値：10。

    10
    TotalCount

    integer

    返されたレコードの総数。

    1
    DataQualityScans

    array<object>

    データ品質モニターの一覧。

    array<object>

    データ品質モニターに関する情報。

    ModifyTime

    integer

    データ品質モニターの最終更新時刻。

    17236236472
    Owner

    string

    データ品質モニターの責任者となるユーザー ID。

    23782382795249
    Description

    string

    データ品質スキャンタスクの説明。最大長：65,535 文字。

    This is a hourly run data quality evaluation plan.
    ModifyUser

    string

    データ品質モニターを最後に更新したユーザー ID。

    23782382795249
    Parameters

    array<object>

    データ品質モニターの実行パラメーター定義。

    object

    データ品質モニターの実行パラメーター定義。

    Value

    string

    パラメーター値。

    $[yyyy-mm-dd-1]
    Name

    string

    パラメーター名。

    dt
    CreateTime

    integer

    データ品質モニターの作成時刻。

    1694512304000
    ProjectId

    integer

    プロジェクト ID。

    59094
    CreateUser

    string

    データ品質モニターの作成者。

    7892346529452
    ComputeResource

    object

    実行時に使用されるコンピュートエンジン。指定しない場合、Spec で定義されたデータソース接続が使用されます。

    Runtime

    object

    データ品質モニターの追加ランタイム設定。

    HiveConf

    string

    Hive エンジン用の追加パラメーター。現在は mapreduce.job.queuename のみがキュー設定に対応しています。

    mapreduce.job.queuename=dq_queue
    SparkConf

    string

    Spark エンジン用の追加パラメーター。現在は spark.yarn.queue のみがキュー設定に対応しています。

    spark.yarn.queue=dq_queue
    Engine

    string

    エンジンタイプ。これらの設定は EMR コンピュートエンジンでのみサポートされています。有効な値：

    • Hive：Hive SQL

    • Spark：Spark SQL

    • Kyuubi

    Hive
    EnvType

    string

    コンピュートエンジンのワークスペース環境。有効な値：

    • Prod

    • Dev

    Prod
    Name

    string

    コンピュートエンジンの名前。エンジンを一意に識別します。

    emr_cluster_001
    Name

    string

    データ品質スキャンタスクの名前。数字、英字、漢字、半角および全角の句読点を含めることができます。最大長：255 文字。

    Hourly partition quality monitoring
    RuntimeResource

    object

    データ品質モニターの実行時に使用されるリソースグループ。

    Cu

    number

    タスク実行時の CU 消費量。

    0.25
    Id

    string

    リソースグループの ID。

    Serverless_resource_group_xxxxx
    Image

    string

    タスク実行用に設定されたイメージの ID。

    i-xxxxx
    Trigger

    object

    データ品質モニターのトリガー設定。

    Type

    string

    データ品質モニターのトリガーモード。有効な値：

    • ByManual：手動トリガー（デフォルト設定）

    • BySchedule：定期タスクインスタンスによるトリガー

    BySchedule
    TaskIds

    array

    トリガーモードが BySchedule の場合、モニターをトリガーするスケジューリングタスクの ID を設定する必要があります。

    integer

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

    1023777390
    Hooks

    array<object>

    データ品質モニター停止後のフック構成。

    object

    データ品質モニター停止後のフック構成。

    Condition

    string

    フックのトリガー条件。この条件が満たされると、フックがトリガーされます。有効な式の形式：

    ルールの重大度レベルとルール検証ステータスの複数の組み合わせを指定します。例：results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' || r.status == 'Error' && r.rule.severity == 'High' || r.status == 'Warn' && r.rule.severity == 'High' }。これは、実行されたルールのいずれかが「Fail かつ Normal 重大度」、「Error かつ High 重大度」、または「Warn かつ High 重大度」の場合にフックがトリガーされることを意味します。重大度の値は Spec で定義されたものと一致する必要があります。ステータスの値は DataQualityResult のものと一致する必要があります。

    results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' || r.status == 'Error' && r.rule.severity == 'High' || r.status == 'Warn' && r.rule.severity == 'High' }
    Type

    string

    フックのタイプ。有効な値：

    • BlockTaskInstance：タスクインスタンスのスケジューリングをブロックします。

    BlockTaskInstance
    Id

    integer

    データ品質モニターの ID。

    26433

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "DataQualityScans": [
      {
        "ModifyTime": 17236236472,
        "Owner": "23782382795249",
        "Description": "This is a hourly run data quality evaluation plan.",
        "ModifyUser": "23782382795249",
        "Parameters": [
          {
            "Value": "$[yyyy-mm-dd-1]",
            "Name": "dt"
          }
        ],
        "CreateTime": 1694512304000,
        "ProjectId": 59094,
        "CreateUser": "7892346529452",
        "ComputeResource": {
          "Runtime": {
            "HiveConf": "mapreduce.job.queuename=dq_queue",
            "SparkConf": "spark.yarn.queue=dq_queue",
            "Engine": "Hive"
          },
          "EnvType": "Prod",
          "Name": "emr_cluster_001"
        },
        "Name": "Hourly partition quality monitoring",
        "RuntimeResource": {
          "Cu": 0.25,
          "Id": "Serverless_resource_group_xxxxx",
          "Image": "i-xxxxx"
        },
        "Trigger": {
          "Type": "BySchedule",
          "TaskIds": [
            1023777390
          ]
        },
        "Hooks": [
          {
            "Condition": "results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' || r.status == 'Error' && r.rule.severity == 'High' || r.status == 'Warn' && r.rule.severity == 'High' }",
            "Type": "BlockTaskInstance"
          }
        ],
        "Id": 26433
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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