全部產品
Search
文件中心

DataWorks:ListDataQualityScanRuns - 資料品質掃描運行記錄查詢

更新時間:Apr 03, 2026

查詢指定專案下的資料品質掃描運行記錄。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListDataQualityScanRuns

list

*全部資源

*

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

DataQualityScanId

integer

資料品質監控 ID。

10001

CreateTimeFrom

integer

資料品質監控運行最早開始時間。

1710239005403

CreateTimeTo

integer

資料品質監控運行最晚開始時間。

1710239005403

Status

string

資料品質校正結果狀態。

  • Pass

  • Running

  • Error

  • Fail

  • Warn

Fail

SortBy

string

排序欄位列表,支援修改時間、建立時間等欄位,格式為"排序欄位+排序方式(Desc/Asc)"(預設 Asc,可以省略)。排序欄位的枚舉值如下:

  • CreateTime (Desc/Asc)

  • Id (Desc/Asc)

CreateTime Desc

PageSize

integer

列表翻頁查詢頁大小,預設為 10。

20

PageNumber

integer

列表翻頁查詢頁碼,預設為 1。

1

ProjectId

integer

專案 ID。

12345

Filter

object

擴充的查詢 Filter,目前支援以下過濾參數:

  • TaskInstanceId 調度任務執行個體 ID

  • RunNumber 執行個體運行次數

{ "TaskInstanceId": "111", "RunNumber": "1" }

返回參數

名稱

類型

描述

樣本值

object

返回結果。

RequestId

string

請求 ID。

0bc14115***159376359

PageInfo

object

分頁資訊。

TotalCount

integer

總條數。

324

PageSize

integer

列表翻頁查詢頁大小,預設為 10。

10

PageNumber

integer

列表翻頁查詢頁碼,預設為 1。

1

DataQualityScanRuns

array<object>

資料品質監控運行記錄列表。

array<object>

資料品質監控運行記錄列表。

Id

integer

資料品質監控運行記錄 ID。

3155

CreateTime

integer

資料品質監控運行開始時間。

1710239005403

FinishTime

integer

資料品質監控運行結束時間。

1710239005403

Status

string

當前運行狀態。

  • Pass

  • Running

  • Error

  • Warn

  • Fail

Fail

Parameters

array<object>

實際運行時,使用的參數設定。

object

參數資訊。

Name

string

參數名。

dt

Value

string

參數值,可以使用調度時間運算式。

$[yyyy-mm-dd-1]

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 324,
    "PageSize": 10,
    "PageNumber": 1,
    "DataQualityScanRuns": [
      {
        "Id": 3155,
        "CreateTime": 1710239005403,
        "FinishTime": 1710239005403,
        "Status": "Fail",
        "Parameters": [
          {
            "Name": "dt",
            "Value": "$[yyyy-mm-dd-1]"
          }
        ]
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情