ListDataQualityTemplates - 資料品質規則模板列表查詢 - DataWorks

查詢指定專案下的資料品質規則模板列表。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListDataQualityTemplates

list

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Catalog	string	否	資料品質模板所屬的目錄路徑。	/timeliness/ods_layer
ProjectId	integer	否	專案 ID。	10000
Name	string	否	模板規則名稱模糊比對。	table_rows
PageNumber	integer	否	結果分頁大小，預設為 10。	1
PageSize	integer	否	結果分頁頁碼，預設為 1。	10

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	0bc14115***159376359
PageInfo	object	資料品質規則模板分頁查詢結果。
TotalCount	integer	總條數。	10
PageSize	integer	頁數。	20
PageNumber	integer	頁碼。	1
DataQualityTemplates	array<object>	規則模板列表。
	object	規則模板。
ModifyTime	integer	資料品質規則模板更新時間。	1729816478147
Owner	string	資料品質規則模板責任人。	205250754596036836
ModifyUser	string	資料品質規則模板最新動向人。	205250754596036836
CreateTime	integer	資料品質規則模板建立時間。	1729816478147
ProjectId	integer	專案 ID。	7635
CreateUser	string	資料品質規則模板建立人。	7892346529452
Id	string	資料品質規則模板 ID。	819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a
Spec	string	資料品質規則模板的具體配置。具體含義，請參見資料品質 Spec 配置說明	{ "assertion": "anomaly detection fro id_not_null_cnt", "id_not_null_cnt": { "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';" }, "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a" }

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 10,
    "PageSize": 20,
    "PageNumber": 1,
    "DataQualityTemplates": [
      {
        "ModifyTime": 1729816478147,
        "Owner": "205250754596036836",
        "ModifyUser": "205250754596036836",
        "CreateTime": 1729816478147,
        "ProjectId": 7635,
        "CreateUser": "7892346529452",
        "Id": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a",
        "Spec": "{\n    \"assertion\": \"anomaly detection fro id_not_null_cnt\",\n    \"id_not_null_cnt\": {\n        \"query\": \"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';\"\n    },\n    \"identity\": \"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\"\n}"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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