すべてのプロダクト
Search

このプロダクト

    DataWorks:ListDataQualityEvaluationTaskInstances

    ドキュメントセンター

    DataWorks:ListDataQualityEvaluationTaskInstances

    最終更新日:Sep 03, 2026

    品質モニタリングタスクインスタンスリストのページング照会を実行します。

    説明

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

    操作説明

    この機能を使用するには、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

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ProjectId

    integer

    必須

    DataWorks ワークスペースの ID。

    100
    DataQualityEvaluationTaskId

    integer

    任意

    データ品質評価タスクの ID。

    10000
    TableGuid

    string

    任意

    Data Map におけるテーブルの一意の ID。

    odps.unit_test.tb_unit_test
    CreateTimeFrom

    integer

    任意

    データ品質評価タスクインスタンスの最も早い開始時刻。

    1710239005403
    CreateTimeTo

    integer

    任意

    データ品質評価タスクインスタンスの最も遅い開始時刻。

    1710239005403
    BizdateFrom

    string

    任意

    品質評価タスクのビジネス開始日。

    2024-04-01
    BizdateTo

    string

    任意

    品質評価タスクのビジネス終了日。

    2024-05-01
    TriggerClientId

    string

    任意

    TriggerContext 内の TriggerClientId。

    1001
    TriggerClient

    string

    任意

    TriggerContext 内の TriggerClient。

    CWF2
    PageSize

    integer

    必須

    リストのページング照会のページサイズ。デフォルト値: 10。

    10
    PageNumber

    integer

    必須

    リストのページング照会のページ番号。デフォルト値: 1。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    戻り値。

    RequestId

    string

    API リクエスト ID。

    691CA452-D37A-4ED****
    PagingInfo

    object

    品質評価タスクインスタンスのページング照会結果。

    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    ページサイズ。

    10
    TotalCount

    integer

    レコードの総数。

    294
    DataQualityEvaluationTaskInstances

    array<object>

    正常にトリガーされた TaskInstance。

    array<object>

    Id

    integer

    The ID of the instance.

    10001
    CreateTime

    integer

    The time at which the instance was generated.

    1710239005403
    FinishTime

    integer

    The time at which the instance finished running.

    1710239005403
    Status

    string

    The status of the instance. Valid values:

    • Running

    • Error

    • Passed

    • Warned

    • Critical

    Critical
    Parameters

    string

    The parameters configured for the instance.

    { "bizdate": "20240517", "triggerTime": "1710239005403" }
    TriggerContext

    string

    The information about the trigger module of the instance.

    { "TriggerClientId": 10001, "TriggerClient": "CWF2" }
    ProjectId

    integer

    The DataWorks workspace ID.

    100
    Task

    object

    The snapshot of the configurations for the task when the task starts.

    Id

    integer

    The task ID.

    10001
    Description

    string

    The description of the task.

    This is a daily run data quality evaluation plan.
    ProjectId

    integer

    The workspace ID.

    100
    Target

    object

    The monitored object of the task.

    Type

    string

    The type of the monitored object. Valid values:

    • Table

    Table
    DatabaseType

    string

    The type of the database to which the table belongs. Valid values:

    • maxcompute

    • emr

    • cdh

    • hologres

    • analyticdb_for_postgresql

    • analyticdb_for_mysql

    • starrocks

    maxcompute
    TableGuid

    string

    The ID of the table in Data Map.

    odps.unit_test.tb_unit_test
    PartitionSpec

    string

    The configuration of the partitioned table.

    ds=$[yyyymmdd-1]
    Trigger

    object

    The trigger configuration of the task.

    Type

    string

    The trigger condition of the task. Valid values:

    • ByScheduledTaskInstance. The value indicates that the task is triggered when the instance of an auto triggered node is successfully run.

    ByScheduledTaskInstance
    TaskIds

    array

    The IDs of the auto triggered nodes of which the instances are successfully run.

    integer

    The ID of the auto triggered node.

    10000
    RuntimeConf

    string

    The configuration of the data source. The value of the queue field is default, and that of the sqlEngine field can be set to SPARK_SQL, KYUUBI, PRESTO_SQL, or HIVE_SQL. The value default indicates the YARN queue for E-MapReduce (EMR) tasks.

    { "queue": "default", "sqlEngine": "SPARK_SQL" }
    Hooks

    array<object>

    The callback configurations of the task during the instance lifecycle. Blocking an auto triggered node is a type of callback event. Only this type is supported.

    object

    Type

    string

    The type of the callback event. Valid values:

    • BlockTaskInstance. The value indicates that an auto triggered node is blocked.

    BlockTaskInstance
    Condition

    string

    The trigger configuration of the callback event.

    ${severity} == "High" AND ${status} == "Critical"
    Notifications

    object

    The configurations for alert notifications.

    Condition

    string

    The trigger condition of the alert notification.

    ${severity} == "High"
    Notifications

    array<object>

    The configurations for the alert notification.

    array<object>

    NofiticationReceivers

    array<object>

    The alert recipients.

    object

    ReceiverType

    string

    The type of the alert recipient. Valid values:

    • AliUid: Alibaba Cloud account ID

    • WebhookUrl: URL of a custom webhook

    • DingdingUrl: DingTalk chatbot URL

    • FeishuUrl: Lark chatbot URL

    • WeixinUrl: WeCom chatbot URL

    AliUid
    Extension

    string

    The extended information in the JSON format. For example, the DingTalk chatbot can remind all members in a DingTalk group by using the at sign (@).

    {"atAll":"true"}
    ReceiverValues

    array

    The alert recipients.

    string

    The alert recipient.

    10000001
    NotificationChannels

    array<object>

    The alert notification methods.

    object

    Channels

    array

    The alert notification methods.

    string

    • Mail

    • Sms

    • Phone

    • Feishu

    • Weixin: WeCom notification

    • Dingding

    • Webhook

    Mail
    Name

    string

    The name of the monitor.

    Quality verification task

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "691CA452-D37A-4ED****",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 294,
    "DataQualityEvaluationTaskInstances": [
      {
        "Id": 10001,
        "CreateTime": 1710239005403,
        "FinishTime": 1710239005403,
        "Status": "Critical",
        "Parameters": "{\n  \"bizdate\": \"20240517\",\n  \"triggerTime\": \"1710239005403\"\n}",
        "TriggerContext": "{\n  \"TriggerClientId\": 10001,\n  \"TriggerClient\": \"CWF2\"\n}",
        "ProjectId": 100,
        "Task": {
          "Id": 10001,
          "Description": "This is a daily run data quality evaluation plan.",
          "ProjectId": 100,
          "Target": {
            "Type": "Table",
            "DatabaseType": "maxcompute",
            "TableGuid": "odps.unit_test.tb_unit_test",
            "PartitionSpec": "ds=$[yyyymmdd-1]"
          },
          "Trigger": {
            "Type": "ByScheduledTaskInstance",
            "TaskIds": [
              10000
            ]
          },
          "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }",
          "Hooks": [
            {
              "Type": "BlockTaskInstance",
              "Condition": "${severity} == \"High\" AND ${status} == \"Critical\""
            }
          ],
          "Notifications": {
            "Condition": "${severity} == \"High\"",
            "Notifications": [
              {
                "NofiticationReceivers": [
                  {
                    "ReceiverType": "AliUid",
                    "Extension": "{\"atAll\":\"true\"}",
                    "ReceiverValues": [
                      "10000001"
                    ]
                  }
                ],
                "NotificationChannels": [
                  {
                    "Channels": [
                      "Mail"
                    ]
                  }
                ]
              }
            ]
          },
          "Name": "Quality verification task"
        }
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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