ListDataQualityScans - 資料品質校正工作清單查詢 - DataWorks

查詢指定專案下的資料品質校正工作清單。

介面說明

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

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListDataQualityScans

list

*全部資源

*

無

請求文法

GET  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	模糊比對資料品質校正任務名稱。	test
SortBy	string	否	排序欄位列表，支援修改時間、建立時間等欄位，格式為"排序欄位+排序方式(Desc/Asc)"（預設 Asc，可以省略）。排序欄位的枚舉值如下： ModifyTime (Desc/Asc) CreateTime (Desc/Asc) Id (Desc/Asc)	ModifyTime Desc
PageSize	integer	是	列表翻頁大小，預設為 10。	10
PageNumber	integer	是	列表翻頁頁碼，預設為 1。	1
ProjectId	integer	是	專案 ID。	10000
Table	string	否	模糊比對監控的表名。	video_album

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	0bc14115***159376359
PageInfo	object	分頁資訊。
PageNumber	integer	頁碼。	1
PageSize	integer	列表翻頁大小，預設為 10。	10
TotalCount	integer	總條數。	1
DataQualityScans	array<object>	資料品質監控列表。
	array<object>	資料品質監控資訊。
ModifyTime	integer	資料品質監控更新時間。	17236236472
Owner	string	資料品質監控責任人使用者識別碼。	23782382795249
Description	string	資料品質校正任務描述，最長 65535 個字元。	This is a hourly run data quality evaluation plan.
ModifyUser	string	資料品質監控最新動向人使用者識別碼。	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>	資料品質監控運行結束後的 Hook 配置。
	object	資料品質監控運行結束後的 Hook 配置。
Condition	string	Hook 觸發條件，當滿足這個條件時，會觸發 Hook 運行。目前只支援一種運算式寫法：指定多組規則嚴重類型和規則校正狀態，如`results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' \|\| r.status == 'Error' && r.rule.severity == 'High' \|\| r.status == 'Warn' && r.rule.severity == 'High' }`，代表執行的規則中，如果有 severity 為 Normal 的規則校正結果是 Fail、或者 severity 為 High 的規則校正結果是 Error、或者 severity 為 High 的規則校正結果是 Warn，則滿足條件。條件運算式中 severity 的枚舉與 Spec 中 severity 的枚舉一致、status 的枚舉與 DataQualityResult 中的 status 一致。	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	Hook 類型。取值範圍： BlockTaskInstance：阻塞任務執行個體調度	BlockTaskInstance
Id	integer	資料品質監控 ID。	26433

樣本

正常返回樣本

JSON格式

{
  "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
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。