CreateQualityRule - 创建质量监控规则_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
BlockType	integer	是	规则的强弱：0 表示弱规则，1 表示强规则。	0
EntityId	long	是	分区表达式的 ID。	15224
Comment	string	否	规则的描述信息。	验证
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 表示用户自定义、2 表示项目级规则。	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	long	是	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
}

错误码

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

变更历史

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