Referensi API ListQualityResultsByRule - DataWorks - Alibaba Cloud - DataWorks

Memvalidasi kualitas Sumber Data terhadap Aturan Validasi dan mengembalikan Hasil Validasi.

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.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
RuleId	integer	Yes	ID aturan pemantauan. Anda dapat menggunakan ID aturan dan filter partisi untuk mengkueri hasil pemantauan aturan tersebut.	152322134
StartDate	string	Yes	Awal rentang waktu yang akan dikueri. Tentukan waktu dalam format yyyy-MM-dd HH:mm:ss. Anda harus mengonfigurasi parameter ini bersama dengan parameter EndDate. Rentang waktu yang dikueri tidak boleh melebihi 7 hari.	2020-09-20 00:00:00
EndDate	string	Yes	Akhir rentang waktu yang akan dikueri. Tentukan waktu dalam format yyyy-MM-dd HH:mm:ss. Anda harus mengonfigurasi parameter ini bersama dengan parameter StartDate. Rentang waktu yang dikueri tidak boleh melebihi 7 hari.	2020-09-22 00:00:00
PageSize	integer	Yes	Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 20.	10
PageNumber	integer	Yes	Nomor halaman.	1
ProjectName	string	Yes	Nama mesin komputasi atau sumber data yang ingin Anda lakukan pemantauan kualitas datanya.	autotest
ProjectId	integer	Yes	ID ruang kerja DataWorks.	123456

Elemen respons

Element	Type	Description	Example
	object	Hasil pemeriksaan.
HttpStatusCode	integer	Kode status HTTP.	200
ErrorMessage	string	Pesan kesalahan.	You have no permission.
RequestId	string	ID permintaan.	CBA58543-00D4-41****
ErrorCode	string	Kode kesalahan.	401
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
Data	object	Objek tingkat atas dari hasil pemeriksaan.
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman. Nilai default: 10. Nilai maksimum: 100.	10
TotalCount	integer	Jumlah total catatan.	200
RuleChecks	array<object>	Daftar hasil pemeriksaan.
	array<object>	Sebuah hasil pemeriksaan.
BlockType	integer	The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values: 1: indicates that the monitoring rule is a strong rule. 0: indicates that the monitoring rule is a weak rule. You can specify the strength of a monitoring rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.	1
WarningThreshold	number	The threshold for a warning alert. The threshold specifies the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements.	0.1
Property	string	The field whose data quality is checked based on the monitoring rule. This field is a column in the data source table that is monitored.	type
TableName	string	The name of the table that is monitored.	dual
Comment	string	The description of the monitoring rule.	The description of the rule.
CheckResultStatus	integer	The status of the monitoring result.	2
TemplateName	string	The name of the monitoring template.	Expected value verification
CheckerName	string	The name of the checker.	fulx
RuleId	integer	The ID of the monitoring rule.	123421
FixedCheck	boolean	Indicates whether the monitoring is performed based on a fixed value. Valid values: true false	false
Op	string	The comparison operator.	>
UpperValue	number	The upper limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.	22200
ActualExpression	string	The partition in the monitored data source table.	ds=20200925
ExternalId	string	The node ID.	123112232
TimeCost	string	The time that was taken to run the monitoring task.	10
Trend	string	The trend of the monitoring result.	up
ExternalType	string	The type of the scheduling system. Only CWF scheduling systems are supported.	CWF2
BizDate	integer	The data timestamp. If the monitored business entity is offline data, the value is usually one day before the monitoring is performed.	1600704000000
CheckResult	integer	The monitoring result.	2
ResultString	string	The string of the monitoring result.	ResultString
MatchExpression	string	The partition filter expression.	ds=$[yyyymmdd]
CheckerType	integer	The type of the checker.	0
ProjectName	string	The name of the compute engine or data source for which data quality is monitored.	autotest
BeginTime	integer	The time when the monitoring started.	1600704000000
DateType	string	The scheduling frequency. In most cases, the value of this parameter is YMD. This value indicates year, month, and day.	YMD
CriticalThreshold	number	The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.	0.6
IsPrediction	boolean	Indicates whether the monitoring result is the same as the predicted result. Valid values: true false	false
RuleName	string	The name of the monitoring rule.	The name of the rule.
CheckerId	integer	The checker ID.	7
DiscreteCheck	boolean	Indicates whether the monitoring is discrete monitoring. Valid values: true false	true
EndTime	integer	The time when the monitoring ended.	1600704000000
MethodName	string	The method used to collect sample data, such as such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.	max
LowerValue	number	The lower limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.	2344
EntityId	integer	The ID of the partition filter expression.	14534343
WhereCondition	string	The filter condition of the monitoring task.	type!='type2'
ExpectValue	number	The expected value.	90
TemplateId	integer	The ID of the monitoring template.	5
TaskId	string	The monitoring task ID.	16008552981681a0d6****
Id	integer	The primary key ID.	2231123
ReferenceValue	array<object>	The historical sample values.
	object
DiscreteProperty	string	The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of DiscreteProperty are Male, Female, and null.	type1
Value	number	The sample value.	20
BizDate	string	The data timestamp. If the monitored business entity is offline data, the value is usually one day before the monitoring is performed.	1600704000000
SingleCheckResult	integer	The string of the monitoring result.	2
Threshold	number	The threshold.	0.2
SampleValue	array<object>	The current sample values.
	object
DiscreteProperty	string	The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of DiscreteProperty are Male, Female, and null.	type2
BizDate	string	The data timestamp. If the monitored business entity is offline data, the value is usually one day before the monitoring is performed.	1600704000000
Value	number	The sample value.	23
Open	boolean	Indicates whether the monitoring rule is enabled.	true

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "You have no permission.",
  "RequestId": "CBA58543-00D4-41****",
  "ErrorCode": "401",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 200,
    "RuleChecks": [
      {
        "BlockType": 1,
        "WarningThreshold": 0.1,
        "Property": "type",
        "TableName": "dual",
        "Comment": "The description of the rule.",
        "CheckResultStatus": 2,
        "TemplateName": "Expected value verification",
        "CheckerName": "fulx",
        "RuleId": 123421,
        "FixedCheck": false,
        "Op": ">",
        "UpperValue": 22200,
        "ActualExpression": "ds=20200925",
        "ExternalId": "123112232",
        "TimeCost": "10",
        "Trend": "up",
        "ExternalType": "CWF2",
        "BizDate": 1600704000000,
        "CheckResult": 2,
        "ResultString": "ResultString",
        "MatchExpression": "ds=$[yyyymmdd]",
        "CheckerType": 0,
        "ProjectName": "autotest",
        "BeginTime": 1600704000000,
        "DateType": "YMD",
        "CriticalThreshold": 0.6,
        "IsPrediction": false,
        "RuleName": "The name of the rule.",
        "CheckerId": 7,
        "DiscreteCheck": true,
        "EndTime": 1600704000000,
        "MethodName": "max",
        "LowerValue": 2344,
        "EntityId": 14534343,
        "WhereCondition": "type!='type2'",
        "ExpectValue": 90,
        "TemplateId": 5,
        "TaskId": "16008552981681a0d6****",
        "Id": 2231123,
        "ReferenceValue": [
          {
            "DiscreteProperty": "type1",
            "Value": 20,
            "BizDate": "1600704000000",
            "SingleCheckResult": 2,
            "Threshold": 0.2
          }
        ],
        "SampleValue": [
          {
            "DiscreteProperty": "type2",
            "BizDate": "1600704000000",
            "Value": 23
          }
        ],
        "Open": true
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.