ListDataQualityResults - DataWorks - Alibaba Cloud Documentation Center

Mengkueri daftar hasil kualitas data menggunakan paging.

Catatan

API ini telah ditinggalkan. Kami merekomendasikan migrasi ke dataworks-public(2024-05-18) - ListDataQualityScanRuns 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

You must purchase DataWorks Basic Edition or a higher edition to use this feature.

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

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	ID ruang kerja DataWorks.	100
DataQualityRuleId	integer	No	ID aturan kualitas data.	100001
DataQualityEvaluationTaskId	integer	No	ID tugas evaluasi kualitas data.	200001
DataQualityEvaluationTaskInstanceId	integer	No	ID instans tugas evaluasi kualitas data.	10001
CreateTimeFrom	integer	No	Waktu paling awal saat hasil evaluasi kualitas data dibuat.	1710239005403
CreateTimeTo	integer	No	Waktu paling akhir saat hasil evaluasi kualitas data dibuat.	1710239005403
BizdateFrom	string	No	Tanggal bisnis awal instans aturan.	2024-05-01
BizdateTo	string	No	Tanggal bisnis akhir instans aturan.	2024-05-04
PageSize	integer	Yes	Ukuran halaman untuk kueri paging. Nilai default: 10.	10
PageNumber	integer	Yes	Nomor halaman untuk kueri paging. Nilai default: 1.	1

Elemen respons

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The API request ID.	691CA452-D37A-****
PagingInfo	object	The paged query results of data quality check results.
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
TotalCount	integer	The total number of entries.	219
DataQualityResults	array<object>	The list of quality check results.
	array<object>	The quality check result.
Id	integer	The ID of the check result.	16033
Status	string	The status of the check result. Valid values: Running Error Passed Warned Critical	Passed
CreateTime	integer	The time when the data quality check result was generated.	1708284916414
TaskInstanceId	integer	The ID of the instance generated by the check.	200001
Sample	string	The sample values used for the check.	[ { "gender": "male", "_count": 100 }, { "gender": "female", "_count": 100 } ]
Details	array<object>	The information about the data quality check.
	object	The information about the data quality check.
ReferencedValue	string	The value that is calculated based on sample data. The value serves as a baseline value during the calculation of the value of the CheckedValue parameter.	0.0
CheckedValue	string	The value that is used for comparison with the threshold.	100.0
Status	string	The comparison result between the value of CheckedValue and the threshold. Valid values: Error Passed Warned Critical	Passed
Rule	object	The snapshot of the rule configuration when the check starts.
Id	integer	The rule ID.	100001
Name	string	The name of the rule. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.	The table cannot be empty.
ProjectId	integer	The DataWorks workspace ID.	100
Enabled	boolean	Indicates whether the rule is enabled.	true
Severity	string	The strength of the rule. Valid values: High Normal	Normal
Description	string	The description of the rule. The description can be up to 500 characters in length.	this is a odps _sql task
TemplateCode	string	The code of the template that is referenced when you create a rule.	SYSTEM:user_defined_sql
Target	object	The monitored object of the rule.
Type	string	The type of the monitored object. Valid values: Table	Table
DatabaseType	string	The type of the database to which the table belongs. Valid values: maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	The ID of the table in Data Map.	odps.unit_test.tb_unit_test
SamplingConfig	object	The sampling settings.
Metric	string	The metrics used for sampling. Valid values: Count: the number of rows in the table. Min: the minimum value of the field. Max: the maximum value of the field. Avg: the average value of the field. DistinctCount: the number of unique values of the field after deduplication. DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table. DuplicatedCount: the number of duplicated values of the field. DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table. TableSize: the table size. NullValueCount: the number of rows in which the field value is null. NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table. GroupCount: the field value and the number of rows for each field value. CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule. CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication. UserDefinedSql: indicates that data is sampled by executing custom SQL statements.	Count
MetricParameters	string	The parameters required for sampling.	{ "columns": [ "id", "name" ] }
SettingConfig	string	The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.	SET odps.sql.udf.timeout=600s;
SamplingFilter	string	The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.	id IS NULL
CheckingConfig	object	The check settings for sample data.
Type	string	The threshold calculation method. Valid values: Fixed Fluctation FluctationDiscreate Auto Average Variance	Fixed
ReferencedSamplesFilter	string	The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference samples and perform aggregate operations on the reference values. In this example, an expression is used to indicate the query method of referenced samples.	{ "bizdate": [ "-1", "-7", "-1m" ] }
Thresholds	object	The threshold settings.
Expected	object	The expected threshold setting.
Value	string	The threshold value.	100.0
Operator	string	The comparison operator. Valid values: > >= < <= != =	>
Expression	string	The threshold expression. If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples: $checkValue > 0.01 $checkValue < -0.01 abs($checkValue) > 0.01 If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.	$checkValue > 0.01
Warned	object	The threshold settings for normal alerts.
Value	string	The threshold value.	100.0
Operator	string	The comparison operator. Valid values: > >= < <= != =	>
Expression	string	The threshold expression. If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples: $checkValue > 0.01 $checkValue < -0.01 abs($checkValue) > 0.01 If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.	$checkValue > 0.01
Critical	object	The threshold settings for critical alerts.
Value	string	The threshold value.	100.0
Operator	string	The comparison operator. Valid values: > >= < <= != =	>
Expression	string	The threshold expression. If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples: $checkValue > 0.01 $checkValue < -0.01 abs($checkValue) > 0.01 If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.	$checkValue > 0.01
ErrorHandlers	array<object>	The operations that you can perform after the rule-based check fails.
	object	The operation that you can perform after the rule-based check fails.
Type	string	The type of the operation. Valid values: SaveErrorData	SaveErrorData
ErrorDataFilter	string	The SQL statement that is used to filter failed tasks. If the rule is defined by custom SQL statements, you must specify an SQL statement to filter failed tasks.	SELECT * FROM tb_api_log WHERE id IS NULL

Contoh

Respons sukses

JSONformat

{
  "RequestId": "691CA452-D37A-****",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 219,
    "DataQualityResults": [
      {
        "Id": 16033,
        "Status": "Passed",
        "CreateTime": 1708284916414,
        "TaskInstanceId": 200001,
        "Sample": "[\n  {\n    \"gender\": \"male\",\n    \"_count\": 100\n  }, {\n    \"gender\": \"female\",\n    \"_count\": 100\n  }\n]",
        "Details": [
          {
            "ReferencedValue": "0.0",
            "CheckedValue": "100.0",
            "Status": "Passed"
          }
        ],
        "Rule": {
          "Id": 100001,
          "Name": "The table cannot be empty.",
          "ProjectId": 100,
          "Enabled": true,
          "Severity": "Normal",
          "Description": "this is a odps _sql task",
          "TemplateCode": "SYSTEM:user_defined_sql",
          "Target": {
            "Type": "Table",
            "DatabaseType": "maxcompute",
            "TableGuid": "odps.unit_test.tb_unit_test"
          },
          "SamplingConfig": {
            "Metric": "Count",
            "MetricParameters": "{ \"columns\": [ \"id\", \"name\" ] }",
            "SettingConfig": "SET odps.sql.udf.timeout=600s; ",
            "SamplingFilter": "id IS NULL"
          },
          "CheckingConfig": {
            "Type": "Fixed",
            "ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }",
            "Thresholds": {
              "Expected": {
                "Value": "100.0",
                "Operator": ">",
                "Expression": "$checkValue > 0.01"
              },
              "Warned": {
                "Value": "100.0",
                "Operator": ">",
                "Expression": " $checkValue > 0.01"
              },
              "Critical": {
                "Value": "100.0",
                "Operator": ">",
                "Expression": " $checkValue > 0.01"
              }
            }
          },
          "ErrorHandlers": [
            {
              "Type": "SaveErrorData\n",
              "ErrorDataFilter": "SELECT * FROM tb_api_log WHERE id IS NULL"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.