All Products
Search

This Product

    DataWorks:UpdateQualityRule

    Document Center

    DataWorks:UpdateQualityRule

    Last Updated:Jun 11, 2026

    Memperbarui aturan kualitas tertentu.

    Catatan

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

    integer

    No

    Kekuatan aturan kualitas. Anda dapat menentukan aturan sebagai aturan kuat atau lemah berdasarkan pentingnya aturan tersebut. Nilai valid:

    • 1: aturan kuat

    • 0: aturan lemah Jika Anda menentukan aturan sebagai aturan kuat dan peringatan kritis dipicu untuk aturan tersebut, penjadwalan tugas terkait akan diblokir.

    0
    EntityId

    integer

    No

    ID ekspresi filter partisi. Anda dapat memanggil operasi ListQualityRules untuk mengkueri ID ekspresi filter partisi.

    123
    Comment

    string

    No

    Deskripsi aturan kualitas.

    Verify the number of table rows
    Checker

    integer

    No

    ID checker. Anda dapat memanggil operasi ListQualityRules untuk mengkueri ID checker.

    9
    ExpectValue

    string

    No

    Nilai yang diharapkan.

    300
    Id

    integer

    Yes

    ID aturan. Anda dapat memanggil operasi ListQualityRules untuk mengkueri ID aturan.

    1234
    Trend

    string

    No

    Tren hasil pemeriksaan. Nilai valid:

    • up: tren naik

    • down: tren mati

    • abs: nilai absolut.

    up
    MethodName

    string

    Yes

    Nama metode yang digunakan untuk mengumpulkan data sampel. Nilai valid: 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, dan table_count-count_distinct.

    table_count
    Operator

    string

    No

    Operator perbandingan. Nilai valid: >, >=, =, !=, <, dan <=.

    Catatan

    Parameter ini wajib diisi jika Anda mengatur parameter Checker ke 9.

    >
    ProjectName

    string

    Yes

    Nama engine atau sumber data. Anda dapat masuk ke Konsol DataWorks dan membuka halaman Workspace Management untuk mendapatkan nama tersebut.

    autotest
    Property

    string

    Yes

    Nama bidang.

    id
    PropertyType

    string

    No

    Tipe data bidang.

    bigint
    RuleType

    integer

    No

    Tipe aturan. Nilai valid:

    • 0: templat sistem

    • 1: SQL kustom

    • 2: templat kustom.

    0
    WhereCondition

    string

    No

    Kondisi filter atau pernyataan SQL kustom yang digunakan untuk pemeriksaan.

    dt=$[yyyymmdd]
    CriticalThreshold

    string

    No

    Ambang batas untuk peringatan kritis. Ambang batas menentukan penyimpangan hasil pemeriksaan dari nilai yang diharapkan. Anda dapat menyesuaikan ambang batas berdasarkan kebutuhan bisnis Anda. Jika Anda menggunakan aturan kuat dan peringatan kritis dipicu, penjadwalan tugas terkait akan diblokir.

    10
    WarningThreshold

    string

    No

    Ambang batas untuk peringatan. Ambang batas menentukan penyimpangan hasil pemeriksaan dari nilai yang diharapkan. Anda dapat menyesuaikan ambang batas berdasarkan kebutuhan bisnis Anda.

    5
    TemplateId

    integer

    No

    ID templat yang digunakan untuk pemeriksaan. Anda dapat memanggil operasi ListQualityRules untuk mengkueri ID templat.

    7
    RuleName

    string

    No

    Nama aturan kualitas.

    123
    PredictType

    integer

    No

    Apakah akan menggunakan ambang batas dinamis. Nilai valid:

    • 0: tidak

    • 2: ya.

    0
    OpenSwitch

    boolean

    No

    Apakah akan mengaktifkan atau menonaktifkan aturan kualitas. Parameter ini menentukan apakah akan menjalankan aturan kualitas di lingkungan produksi.

    • true: Aturan kualitas dipicu saat tugas penjadwalan yang terkait dengan tabel keluaran aturan dijalankan.

    • false: Aturan kualitas tidak dipicu saat tugas penjadwalan yang terkait dengan tabel keluaran aturan dijalankan.

    true
    ProjectId

    integer

    Yes

    ID ruang kerja DataWorks.

    26
    TaskSetting

    string

    No

    Pengaturan variabel yang disisipkan sebelum aturan kustom. Pengaturan tersebut dalam format x=a,y=b.

    x=a,y=b

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The response data.

    HttpStatusCode

    integer

    The HTTP status code.

    200
    Data

    boolean

    Indicates whether the validation rule was successfully updated.

    true
    ErrorMessage

    string

    The error message returned when the request fails.

    You have no permission.
    RequestId

    string

    The ID of the request, used for troubleshooting.

    576b9457-2cf5-4****
    ErrorCode

    string

    The error code returned when the request fails.

    0
    Success

    boolean

    Indicates whether the API call was successful.

    true

    Contoh

    Respons sukses

    JSONformat

    {
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "You have no permission.",
  "RequestId": "576b9457-2cf5-4****",
  "ErrorCode": "0",
  "Success": true
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.