全部產品
Search

搜尋本產品

    DataWorks：UpdateQualityRule - 更新規則

    文件中心

    DataWorks：UpdateQualityRule - 更新規則

    更新時間：Mar 18, 2026

    調用UpdateQualityRule更新校正規則的資訊。

    說明

    目前該API介面已標記為棄用，推薦使用替代API：dataworks-public(2024-05-18) - UpdateDataQualityScan。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    當前API暫無授權資訊透出。

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BlockType

    integer

    否

    校正規則的強弱。強弱表示規則的重要程度。取值如下：

    • 1，表示強規則。

    • 0，表示弱規則。 您可以根據實際需求設定重要的規則為強規則。如果使用強規則並觸發了紅色警示，則會阻塞調度任務。

    0
    EntityId

    integer

    否

    分區運算式的 ID。您可以調用 ListQualityRules 介面獲分區運算式 ID。

    123
    Comment

    string

    否

    校正規則的描述資訊。

    Verify the number of table rows
    Checker

    integer

    否

    校正器 ID。 2，表示 7 天平均值波動。 3，表示 30 天平均值波動。 4，表示 1 天周期比較。 5，表示 7 天周期比較。 6，表示 30 天周期比較。 7，表示 7 天方差波動。 8，表示 30 天方差波動。 9，表示與固定值比較。 10，表示 1、7、30 天波動檢測。 11，表示上一周期比較。 您可以調用 ListQualityRules 介面擷取校正器 ID。

    9
    ExpectValue

    string

    否

    校正結果的期望值。

    300
    Id

    integer

    是

    校正規則的 ID。您可以調用 ListQualityRules 介面擷取規則 ID。

    1234
    Trend

    string

    否

    校正結果的趨勢。取值如下：

    • up，表示上升趨勢。

    • down，表示下降趨勢。

    • abs，表示絕對值。

    up
    MethodName

    string

    是

    採集樣本資料方法的名稱。包括 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、table_count-count_distinct 等。

    table_count
    Operator

    string

    否

    比較符。包括>、>=、=、≠、<和<=等。

    說明

    當 Checker=9 時，Operator 為必選參數。

    >
    ProjectName

    string

    是

    引擎或者資料來源的名稱。您可以登入 DataWorks 控制台，進入工作空間管理頁面擷取名稱。

    autotest
    Property

    string

    是

    欄位的名稱。

    id
    PropertyType

    string

    否

    欄位的類型。

    bigint
    RuleType

    integer

    否

    規則的類型：

    • 0：系統模板規則

    • 1：自訂 SQL 規則

    • 4：自訂模板規則

    0
    WhereCondition

    string

    否

    校正任務使用的過濾條件或自訂 SQL 陳述式。

    dt=$[yyyymmdd]
    CriticalThreshold

    string

    否

    紅色警示閾值。表示與樣本預期的偏離程度。您可以根據業務需求自訂該閾值。使用強規則並觸發紅色閾值，會阻塞調度任務。

    10
    WarningThreshold

    string

    否

    橙色警示閾值。表示與樣本預期的偏離程度，您可以根據業務需求自訂該閾值。

    5
    TemplateId

    integer

    否

    使用的校正模板的 ID。您可以調用 ListQualityRules 介面擷取校正模板的 ID。

    7
    RuleName

    string

    否

    校正規則的名稱。

    123
    PredictType

    integer

    否

    是否為動態閾值。取值如下：

    • 0，表示非動態閾值。

    • 2，表示動態閾值。

    0
    OpenSwitch

    boolean

    否

    規則的啟用或停用狀態，用於控制品質規則是否在生產環境中運行。

    • true：在資料品質規則關聯產出表資料的調度任務執行時，便會觸發品質規則校正。

    • false：在資料品質規則關聯產出表資料的調度任務執行時，不會觸發品質規則校正。

    true
    ProjectId

    integer

    是

    DataWorks 專案空間 ID。

    26
    TaskSetting

    string

    否

    在自訂規則之前插入的變數設定，格式如：x=a,y=b

    x=a,y=b

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料結構。

    HttpStatusCode

    integer

    HTTP 返回碼。

    200
    Data

    boolean

    校正規則是否更新成功。

    true
    ErrorMessage

    string

    錯誤資訊。

    You have no permission.
    RequestId

    string

    請求 ID。用於出現錯誤後排查問題。

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

    string

    錯誤碼。

    0
    Success

    boolean

    調用是否成功。

    true

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。