文档

CreateQualityRule - 创建质量监控规则

更新时间:

调用CreateQualityRule创建质量监控规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
BlockTypeinteger

规则的强弱:0 表示弱规则,1 表示强规则。

0
EntityIdlong

分区表达式的 ID。

15224
Commentstring

规则的描述信息。

验证
Checkerinteger

校验器的 ID,取值如下:

  • 2,表示 7 天平均值波动。
  • 3,表示 30 天平均值波动。
  • 4,表示 1 天周期比较。
  • 5,表示 7 天周期比较。
  • 6,表示 30 天周期比较。
  • 7,表示 7 天方差波动。
  • 8,表示 30 天方差波动。
  • 9,表示与固定值比较。
  • 10,表示 1、7、30 天波动检测。
  • 11,表示上一周期比较。
9
ExpectValuestring

期望值。

0
Trendstring

校验结果的趋势。取值如下:

  • up,表示上升趋势。
  • down,表示下降趋势。
  • abs,表示绝对值。
abs
MethodNamestring

采样方。如果是自定义 SQL,该参数的值为 user_defined。

count/table_count
Operatorstring

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

说明 当 Checker=9 时,Operator 为必选参数。
>
ProjectNamestring

引擎或者数据源的名称。

autotest
Propertystring

规则的字段。如果是表级别校验,行数为 table_count、大小为 table_size 字段。

table_id
PropertyTypestring

字段的类型,表级 table,字段级填写 bigint 等。

bigint
RuleTypeinteger

规则的类型:0 表示系统定义、1 表示用户自定义、2 表示项目级规则。

0
WhereConditionstring

过滤条件或自定义 SQL。

table_id>1
CriticalThresholdstring

红色告警阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值,会阻塞调度任务。

20
WarningThresholdstring

橙色告警阈值。表示与样本预期的偏离程度,您可以根据业务需求自定义该阈值。

10
TemplateIdinteger

模板的 ID。

7
RuleNamestring

规则的名称。

1234
PredictTypeinteger

是否为动态阈值:0 表示非动态阈值、2 表示动态阈值规则。

0
ProjectIdlong

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。

10000
TaskSettingstring

在自定义规则之前插入的变量设置,格式如:x=a,y=b。

x=a,y=b

返回参数

名称类型描述示例值
object

返回参数。

HttpStatusCodeinteger

HTTP 返回码。

200
Datastring

新建的规则 ID。

12345
ErrorMessagestring

错误信息。

You have no permission.
RequestIdstring

请求 ID。

ecb967ec-c137-48****
ErrorCodestring

错误码。

401
Successboolean

调用是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-15OpenAPI 入参发生变更查看变更详情
2023-03-08OpenAPI 入参发生变更查看变更详情