GetDataQualityScan - DataWorks - Alibaba Cloud Documentation Center

Mendapatkan detail pemantauan kualitas data.

Deskripsi operasi

Diperlukan DataWorks Edisi Dasar atau edisi yang lebih tinggi.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:GetDataQualityScan

get

*All Resource

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
Id	integer	No	ID pemantau.	10001

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan	204EAF68-CCE3-5112-8DA0-E7A60F02XXXX
DataQualityScan	object	Detail pemantauan kualitas data.
Id	integer	ID pemantauan kualitas data.	10001
Name	string	Nama pemantau kualitas data.	data_quality_scan_001
Description	string	Deskripsi pemantau kualitas data.	aily data quality scanning of ods tables.
ProjectId	integer	ID ruang kerja tempat pemantau kualitas data berada. Anda dapat memperoleh ID ruang kerja dengan memanggil operasi ListProjects.	101
CreateTime	integer	Waktu pembuatan pemantau kualitas data.	1731550150000
ModifyTime	integer	Waktu terakhir pemantau kualitas data dimodifikasi.	1731550150000
CreateUser	string	ID pengguna yang membuat pemantau kualitas data.	2374924198591250
ModifyUser	string	ID pengguna yang terakhir memodifikasi pemantau kualitas data.	23482597582479
Owner	string	ID pengguna yang memiliki pemantau kualitas data.	231263586109857423
Spec	string	Kode Spec untuk konten pemantauan kualitas data.	{ "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>	Definisi parameter eksekusi untuk pemantau kualitas data.
	object	Informasi parameter.
Value	string	The parameter name.	10
Name	string	The parameter value.	e2e_autolabel
ComputeResource	object	Mesin komputasi yang digunakan saat runtime. Opsional. Jika tidak ditentukan, sumber data yang didefinisikan dalam Spec akan digunakan.
Name	string	The name of the compute engine, which is a unique identifier.	polardb_to_holo
Runtime	object	More settings for data quality monitor at runtime.
Engine	string	The type of the compute engine. Only EMR compute engines support these settings. Valid values: Hive: Hive SQL Spark: Spark SQL Kyuubi	Hive
HiveConf	object	Additional Hive engine parameters. Currently, only the mapreduce.job.queuename parameter is supported.	mapreduce.job.queuename=dq_queue
SparkConf	object	Additional Spark engine parameters. Currently, only the spark.yarn.queue parameter is supported.	spark.yarn.queue=dq_queue
EnvType	string	The workspace environment to which the compute engine belongs. Valid values: Prod: production environment . Dev: development environment.	Prod
RuntimeResource	object	Grup sumber daya yang digunakan selama menjalankan pemantau kualitas data.
Id	string	The resource group ID.	122878
Cu	number	Reserved compute units (CU) for the resource group.	10
Image	string	The image ID used in the runtime configuration.	hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008
Trigger	object	Konfigurasi pemicu dari tugas pemantauan kualitas data.
Type	string	The trigger mode of the monitoring task. Valid values: ByManual: Manual trigger. This is the default setting. BySchedule: Triggered by a scheduled task instance.	BySchedule
TaskIds	array	If the trigger mode is set to BySchedule, the scheduling task ID must be specified.
	integer	The ID of the scheduling task.	1023777390
Hooks	array<object>	Konfigurasi Hook setelah eksekusi pemantauan kualitas data berakhir.
	object	Konfigurasi Hook setelah eksekusi pemantauan kualitas data berakhir.
Condition	string	The Hook trigger condition. The hook will run if the condition is met. Currently, only one type of expression syntax is supported: You can specify multiple combinations of rule severity levels and validation statuses using an expression such as `results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' \|\| r.status == 'Error' && r.rule.severity == 'High' \|\| r.status == 'Warn' && r.rule.severity == 'High' }`. This expression means the condition is met if any executed rule has a result of Fail with severity Normal, Error with severity High, or Warn with severity High. In the condition expression, the values of severity and status are predefined enums. The values of severity must match those defined in the Spec, and the values of status must match those in DataQualityResult.	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	The type of the Hook. Valid values: BlockTaskInstance: BlockTaskInstance: Blocks the scheduling of the task instance.	BlockTaskInstance

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.