GetDataQualityRule - DataWorks - Alibaba Cloud Documentation Center

Menampilkan detail aturan kualitas data.

Catatan

API ini telah ditinggalkan. Kami merekomendasikan migrasi ke dataworks-public(2024-05-18) - GetDataQualityScan guna memperoleh fungsionalitas yang lebih baik dan dukungan berkelanjutan. Meskipun API yang telah ditinggalkan ini masih dapat diakses sementara, tidak akan ada pembaruan atau perbaikan bug lebih lanjut.

Deskripsi operasi

Anda harus berlangganan DataWorks Basic Edition atau versi yang lebih tinggi untuk menggunakan fitur ini.

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:*

get

*Semua Sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Id	integer	Yes	ID aturan.	19715

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
RequestId	string	ID permintaan.	691CA452-D37A-4ED0-****
DataQualityRule	object	Detail aturan.
Id	integer	ID aturan.	16033
Name	string	Nama aturan.	The table cannot be empty.
ProjectId	integer	ID ruang kerja DataWorks.	1948
Enabled	boolean	Menentukan apakah aturan diaktifkan.	true
Severity	string	Tingkat keparahan aturan untuk bisnis (berkaitan dengan aturan kuat/lemah pada halaman). Nilai yang valid: Normal High	High
Description	string	Deskripsi aturan. Panjang maksimum adalah 500 karakter.	this is a odps _sql task
Target	object	Objek yang dipantau oleh aturan.
Type	string	Jenis objek yang dipantau. Table	Table
DatabaseType	string	Untuk set data bertipe Table, jenis database tempat tabel tersebut berada. maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	ID unik tabel tempat aturan diterapkan di Data Map.	odps.unit_test.tb_unit_test
PartitionSpec	string	Pengaturan partisi tabel partisi.	ds=$[yyyymmdd-1]
TemplateCode	string	Identifier unik templat aturan yang dirujuk oleh aturan ini.	SYSTEM:table:table_count:fixed
SamplingConfig	object	Pengaturan yang diperlukan untuk pengambilan sampel.
Metric	string	Nama metrik pengambilan sampel: Count: jumlah baris tabel Min: nilai minimum bidang Max: nilai maksimum bidang Avg: nilai rata-rata bidang DistinctCount: jumlah nilai unik bidang DistinctPercent: rasio jumlah nilai unik bidang terhadap jumlah baris data DuplicatedCount: jumlah nilai duplikat bidang DuplicatedPercent: rasio jumlah nilai duplikat bidang terhadap jumlah baris data TableSize: ukuran tabel NullValueCount: jumlah baris di mana bidang bernilai null NullValuePercent: proporsi baris di mana bidang bernilai null GroupCount: jumlah baris data yang sesuai dengan setiap nilai setelah agregasi berdasarkan nilai bidang CountNotIn: jumlah baris di mana nilai enum tidak cocok CountDistinctNotIn: jumlah nilai unik di mana nilai enum tidak cocok UserDefinedSql: melakukan pengambilan sampel menggunakan pernyataan SQL kustom	Max
MetricParameters	string	Parameter yang diperlukan untuk pengambilan sampel.	{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}
SettingConfig	string	Pernyataan pengaturan parameter waktu proses yang disisipkan dan dieksekusi sebelum pernyataan pengambilan sampel spesifik dijalankan. Panjang maksimum adalah 1.000 karakter. Saat ini hanya MaxCompute yang didukung.	SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;
SamplingFilter	string	Kondisi yang digunakan untuk melakukan filter sekunder terhadap data yang tidak menjadi fokus selama pengambilan sampel. Panjang maksimum adalah 16.777.215 karakter.	id IS NULL
CheckingConfig	object	Pengaturan pemeriksaan sampel.
Type	string	Metode perhitungan ambang batas: Fixed Fluctation FluctationDiscreate Auto Average Variance	Fixed
ReferencedSamplesFilter	string	Beberapa jenis ambang batas memerlukan pengambilan sampel referensi, lalu mengagregasi nilai sampel referensi tersebut untuk menentukan ambang batas yang digunakan dalam perbandingan. Ekspresi digunakan di sini untuk menunjukkan cara pengambilan sampel referensi.	{ "bizdate": [ "-1", "-7", "-1m" ] }
Thresholds	object	Pengaturan ambang batas.
Expected	object	Pengaturan ambang batas yang diharapkan.
Operator	string	Operator perbandingan: > >= < <= != =	>
Value	string	Nilai ambang batas.	100.0
Expression	string	Ekspresi ambang batas.	$checkValue <= 0.01
Warned	object	Pengaturan ambang batas untuk peringatan normal.
Operator	string	Operator perbandingan: > >= < <= != =	>
Value	string	Nilai ambang batas.	100.0
Expression	string	Ekspresi ambang batas.	$checkValue > 0.01
Critical	object	Pengaturan ambang batas untuk peringatan kritis.
Operator	string	Operator perbandingan: > >= < <= != =	>
Value	string	Nilai ambang batas.	100.0
Expression	string	Ekspresi ambang batas.	$checkValue > 0.05
ErrorHandlers	array<object>	Daftar penanganan masalah untuk pemeriksaan aturan kualitas.
	object	Penanganan masalah untuk pemeriksaan aturan kualitas.
Type	string	Jenis penanganan: SaveErrorData	SaveErrorData
ErrorDataFilter	string	Jika aturan merupakan aturan SQL kustom, Anda harus menentukan pernyataan SQL untuk memfilter data bermasalah.	SELECT * FROM tb_api_log WHERE id IS NULL

Contoh

Respons sukses

JSONformat

{
  "RequestId": "691CA452-D37A-4ED0-****",
  "DataQualityRule": {
    "Id": 16033,
    "Name": "The table cannot be empty.\n",
    "ProjectId": 1948,
    "Enabled": true,
    "Severity": "High",
    "Description": "this is a odps _sql task\n",
    "Target": {
      "Type": "Table",
      "DatabaseType": "maxcompute",
      "TableGuid": "odps.unit_test.tb_unit_test\n",
      "PartitionSpec": "ds=$[yyyymmdd-1]\n"
    },
    "TemplateCode": "SYSTEM:table:table_count:fixed",
    "SamplingConfig": {
      "Metric": "Max",
      "MetricParameters": "{ \"Columns\": [ \"id\", \"name\" ] , \"SQL\": \"select count(1) from table;\"}",
      "SettingConfig": "SET odps.sql.udf.timeout=600s; \nSET odps.sql.python.version=cp27;\n",
      "SamplingFilter": "id IS NULL\n"
    },
    "CheckingConfig": {
      "Type": "Fixed",
      "ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }\n",
      "Thresholds": {
        "Expected": {
          "Operator": ">",
          "Value": "100.0",
          "Expression": "$checkValue <= 0.01"
        },
        "Warned": {
          "Operator": ">",
          "Value": "100.0",
          "Expression": "$checkValue > 0.01"
        },
        "Critical": {
          "Operator": ">",
          "Value": "100.0",
          "Expression": "$checkValue > 0.05"
        }
      }
    },
    "ErrorHandlers": [
      {
        "Type": "SaveErrorData\n",
        "ErrorDataFilter": "SELECT * FROM tb_api_log WHERE id IS NULL\n"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.