All Products
Search

This Product

    DataWorks:UpdateDataQualityScan

    Document Center

    DataWorks:UpdateDataQualityScan

    Last Updated:Jun 11, 2026

    Memperbarui monitor kualitas data.

    Deskripsi operasi

    Diperlukan DataWorks Basic Edition 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

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

    Sintaks permintaan

    POST  HTTP/1.1

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    Description

    string

    No

    Deskripsi monitor kualitas data.

    Daily data quality scanning of ods tables.
    ProjectId

    integer

    No

    ID ruang kerja DataWorks tempat monitor kualitas data berada. Anda dapat memperoleh ID ruang kerja dengan memanggil operasi ListProjects.

    101
    Id

    integer

    No

    ID monitor kualitas data.

    10001
    Owner

    string

    No

    ID pengguna pemilik monitor kualitas data.

    231263586109857423
    Spec

    string

    No

    Kode Spec konten pemantauan kualitas data. Untuk informasi lebih lanjut, lihat Deskripsi konfigurasi Spec 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>

    No

    Definisi parameter eksekusi untuk monitor kualitas data.

    object

    No

    Informasi parameter.

    Value

    string

    No

    Nilai parameter.

    smtp.qiye.aliyun.com
    Name

    string

    No

    Nama parameter.

    temp_237669.zip_byBwm_1734661241752
    RuntimeResource

    object

    No

    Grup sumber daya yang digunakan untuk menjalankan monitor kualitas data.

    Id

    string

    No

    ID grup sumber daya.

    20315
    Cu

    number

    No

    Jumlah CU default yang dikonfigurasi untuk menjalankan tugas.

    0.25
    Image

    string

    No

    ID image dari konfigurasi runtime tugas.

    i-xxxxxx
    ComputeResource

    object

    No

    Mesin komputasi yang digunakan untuk eksekusi. Jika parameter ini tidak ditentukan, koneksi sumber data yang didefinisikan dalam Spec akan digunakan.

    Name

    string

    No

    Nama mesin komputasi, yang berfungsi sebagai pengidentifikasi unik.

    auto_createAlertRule_Finished_1kUTk6
    Runtime

    object

    No

    Pengaturan tambahan untuk mesin komputasi.

    Engine

    string

    No

    Tipe mesin. Pengaturan ini hanya didukung untuk mesin komputasi EMR. Nilai valid:

    • Hive: Hive SQL

    • Spark: Spark SQL

    • Kyuubi

    Hive
    SparkConf

    object

    No

    Parameter tambahan untuk mesin Spark. Saat ini, hanya parameter spark.yarn.queue yang didukung.

    spark.yarn.queue=dq_queue
    HiveConf

    object

    No

    Parameter tambahan untuk mesin Hive. Saat ini, hanya parameter mapreduce.job.queuename yang didukung.

    mapreduce.job.queuename=dq_queue
    EnvType

    string

    No

    Lingkungan ruang kerja mesin komputasi. Nilai valid:

    • Prod

    • Dev

    Prod
    Trigger

    object

    No

    Pengaturan pemicu untuk monitor kualitas data.

    Type

    string

    No

    Mode pemicu monitor kualitas data. Nilai valid:

    • ByManual: Dipicu secara manual. Ini adalah nilai default.

    • BySchedule: Dipicu oleh instans tugas terjadwal.

    BySchedule
    TaskIds

    array

    No

    Jika mode pemicu adalah BySchedule, Anda harus mengonfigurasi ID tugas penjadwalan yang memicu monitor.

    integer

    No

    ID tugas penjadwalan.

    30001
    Hooks

    array<object>

    No

    Konfigurasi hook yang berlaku setelah monitor kualitas data berhenti.

    object

    No

    Konfigurasi hook yang berlaku setelah monitor kualitas data berhenti.

    Condition

    string

    No

    Kondisi pemicu hook. Ketika kondisi ini terpenuhi, hook akan dipicu. Format ekspresi yang valid:

    Menentukan beberapa kombinasi tingkat keparahan aturan dan status validasi aturan, misalnya, results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' || r.status == 'Error' && r.rule.severity == 'High' || r.status == 'Warn' && r.rule.severity == 'High' }. Ini berarti hook akan dipicu jika ada aturan yang dieksekusi memiliki Fail dengan keparahan Normal, Error dengan keparahan High, atau Warn dengan keparahan High. Nilai severity harus cocok dengan yang didefinisikan dalam Spec. Nilai status harus cocok dengan yang ada di 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

    No

    Tipe hook. Nilai valid:

    • BlockTaskInstance: Memblokir penjadwalan instans tugas.

    BlockTaskInstance
    Name

    string

    No

    Nama monitor kualitas data.

    data_quality_scan_001

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Respons

    RequestId

    string

    ID permintaan.

    22C97E95-F023-56B5-8852-B1A77A1****
    Success

    boolean

    Menunjukkan apakah panggilan berhasil.

    true

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A1****",
  "Success": true
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.