全部產品
Search

搜尋本產品

    DataWorks：CreateQualityRule - 建立品質監控規則

    文件中心

    DataWorks：CreateQualityRule - 建立品質監控規則

    更新時間：Mar 18, 2026

    調用CreateQualityRule建立品質監控規則。

    說明

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

    調試

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

    調試

    授權資訊

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BlockType

    integer

    是

    規則的強弱：

    • 0 表示弱規則

    • 1 表示強規則。

    0
    EntityId

    integer

    是

    分區運算式的 ID。

    15224
    Comment

    string

    否

    規則的描述資訊。

    Verification
    Checker

    integer

    否

    校正器的 ID，取值如下：

    • 2，表示 7 天平均值波動。

    • 3，表示 30 天平均值波動。

    • 4，表示 1 天周期比較。

    • 5，表示 7 天周期比較。

    • 6，表示 30 天周期比較。

    • 7，表示 7 天方差波動。

    • 8，表示 30 天方差波動。

    • 9，表示與固定值比較。

    • 10，表示 1、7、30 天波動檢測。

    • 11，表示上一周期比較。

    9
    ExpectValue

    string

    否

    期望值。

    0
    Trend

    string

    否

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

    • up，表示上升趨勢。

    • down，表示下降趨勢。

    • abs，表示絕對值。

    abs
    MethodName

    string

    否

    採樣方。如果是自訂 SQL，該參數的值為 user_defined。

    count/table_count
    Operator

    string

    否

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

    說明

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

    >
    ProjectName

    string

    是

    引擎或者資料來源的名稱。

    autotest
    Property

    string

    否

    規則的欄位。如果是表層級校正，行數為 table_count、大小為 table_size 欄位。

    table_id
    PropertyType

    string

    否

    欄位的類型，表級 table，欄位級填寫 bigint 等。

    bigint
    RuleType

    integer

    是

    規則的類型：

    • 0：系統模板規則

    • 1：自訂 SQL 規則

    • 4：自訂模板規則

    0
    WhereCondition

    string

    否

    過濾條件或自訂 SQL。

    table_id>1
    CriticalThreshold

    string

    否

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

    20
    WarningThreshold

    string

    否

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

    10
    TemplateId

    integer

    否

    模板的 ID。

    7
    RuleName

    string

    是

    規則的名稱。

    1234
    PredictType

    integer

    是

    是否為動態閾值：0 表示非動態閾值、2 表示動態臨界值規則。

    0
    ProjectId

    integer

    是

    DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間 ID。

    10000
    TaskSetting

    string

    否

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

    x=a,y=b

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數。

    HttpStatusCode

    integer

    HTTP 返回碼。

    200
    Data

    string

    建立的規則 ID。

    12345
    ErrorMessage

    string

    錯誤資訊。

    You have no permission.
    RequestId

    string

    請求 ID。

    ecb967ec-c137-48****
    ErrorCode

    string

    錯誤碼。

    401
    Success

    boolean

    調用是否成功。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "Data": "12345",
  "ErrorMessage": "You have no permission.",
  "RequestId": "ecb967ec-c137-48****",
  "ErrorCode": "401",
  "Success": true
}

    錯誤碼

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

    變更歷史

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