GetDataQualityScan - 擷取資料品質監控詳情 - DataWorks

擷取資料品質監控詳情

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:GetDataQualityScan

get

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Id	integer	否	資料品質監控 ID。	10001

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	204EAF68-CCE3-5112-8DA0-E7A60F02XXXX
DataQualityScan	object	資料品質監控詳情。
Id	integer	資料品質監控 ID。	10001
Name	string	資料品質監控名稱。	data_quality_scan_001
Description	string	資料品質監控描述資訊。	aily data quality scanning of ods tables.
ProjectId	integer	資料品質監控所在的 DataWorks 工作空間 ID。您可以通過 ListProjects 介面擷取工作空間 ID。	101
CreateTime	integer	資料品質監控建立時間。	1731550150000
ModifyTime	integer	資料品質監控最近修改時間。	1731550150000
CreateUser	string	資料品質監控建立人使用者識別碼。	2374924198591250
ModifyUser	string	資料品質監控最近修改人使用者識別碼。	23482597582479
Owner	string	資料品質監控負責人使用者識別碼。	231263586109857423
Spec	string	資料品質監控的內容的 Spec 代碼，詳情請參見資料品質 Spec 配置說明。	{ "datasets": [ { "type": "Table", "dataSource": { "name": "odps_first", "envType": "Prod" }, "tables": [ "ods_d_user_info" ], "filter": "pt = $[yyyymmdd-1]" } ], "rules": [ { "assertion": "row_count > 0" }, { "templateId": "SYSTEM:field:null_value:fixed", "pass": "when = 0", "name": "The id cannot be empty.", "severity": "High", "identity": "a-customized-data-quality-rule-uuid" } ] }
Parameters	array<object>	資料品質監控執行參數定義。
	object	參數資訊。
Value	string	參數名。	10
Name	string	參數值。	e2e_autolabel
ComputeResource	object	資料品質監控在運行時使用的計算引擎，可空，如果沒有指定，則使用 Spec 中所指定的資料來源串連。
Name	string	計算引擎名字，唯一標識。	polardb_to_holo
Runtime	object	資料品質監控在運行時的更多設定。
Engine	string	使用的引擎類型，只有 EMR 計算引擎支援設定這部分內容。取值範圍： Hive：Hive SQL Spark：Spark SQL Kyuubi	Hive
HiveConf	object	使用 Hive 引擎時，更多的參數設定，目前只支援通過 mapreduce.job.queuename 設定隊列。	mapreduce.job.queuename=dq_queue
SparkConf	object	使用 Spark 引擎時，更多的參數設定，目前只支援通過 spark.yarn.queue 設定隊列。	spark.yarn.queue=dq_queue
EnvType	string	計算引擎所屬的工作空間環境。取值範圍： Prod：生產環境 Dev：開發環境	Prod
RuntimeResource	object	資料品質監控運行時，使用的資源群組。
Id	string	資源群組 ID。	122878
Cu	number	資源群組預留 CU。	10
Image	string	回合組態的鏡像 ID。	hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008
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

樣本

正常返回樣本

JSON格式

{
  "RequestId": "204EAF68-CCE3-5112-8DA0-E7A60F02XXXX",
  "DataQualityScan": {
    "Id": 10001,
    "Name": "data_quality_scan_001",
    "Description": "aily data quality scanning of ods tables.",
    "ProjectId": 101,
    "CreateTime": 1731550150000,
    "ModifyTime": 1731550150000,
    "CreateUser": "2374924198591250",
    "ModifyUser": "23482597582479",
    "Owner": "231263586109857423",
    "Spec": "{\n    \"datasets\": [\n        {\n            \"type\": \"Table\",\n            \"dataSource\": {\n                \"name\": \"odps_first\",\n                \"envType\": \"Prod\"\n            },\n            \"tables\": [\n                \"ods_d_user_info\"\n            ],\n            \"filter\": \"pt = $[yyyymmdd-1]\"\n        }\n    ],\n    \"rules\": [\n        {\n            \"assertion\": \"row_count > 0\"\n        }, {\n            \"templateId\": \"SYSTEM:field:null_value:fixed\",\n            \"pass\": \"when = 0\",\n            \"name\": \"The id cannot be empty.\",\n            \"severity\": \"High\",\n             \"identity\": \"a-customized-data-quality-rule-uuid\"\n        }\n    ]\n}",
    "Parameters": [
      {
        "Value": "10",
        "Name": "e2e_autolabel"
      }
    ],
    "ComputeResource": {
      "Name": "polardb_to_holo",
      "Runtime": {
        "Engine": "Hive",
        "HiveConf": {
          "test": "test",
          "test2": 1
        },
        "SparkConf": {
          "test": "test",
          "test2": 1
        }
      },
      "EnvType": "Prod"
    },
    "RuntimeResource": {
      "Id": "122878",
      "Cu": 10,
      "Image": "hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008"
    },
    "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"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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