调用UpdateQualityRule更新校验规则的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BlockType | integer | 否 | 校验规则的强弱。强弱表示规则的重要程度。取值如下:
| 0 |
EntityId | long | 否 | 分区表达式的 ID。您可以调用 ListQualityRules 接口获分区表达式 ID。 | 123 |
Comment | string | 否 | 校验规则的描述信息。 | 校验表行数 |
Checker | integer | 是 | 校验器 ID。您可以调用 ListQualityRules 接口获取校验器 ID。 | 9 |
ExpectValue | string | 否 | 校验结果的期望值。 | 300 |
Id | long | 是 | 校验规则的 ID。您可以调用 ListQualityRules 接口获取规则 ID。 | 1234 |
Trend | string | 否 | 校验结果的趋势。取值如下:
| 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 | 否 | 比较符。包括>、>=、=、≠、<和<=等。 | > |
ProjectName | string | 是 | 引擎或者数据源的名称。您可以登录 DataWorks 控制台,进入工作空间管理页面获取名称。 | autotest |
Property | string | 是 | 字段的名称。 | id |
PropertyType | string | 否 | 字段的类型。 | bigint |
RuleType | integer | 否 | 规则的类型:
| 0 |
WhereCondition | string | 否 | 校验任务使用的过滤条件或自定义 SQL 语句。 | dt=$[yyyymmdd] |
CriticalThreshold | string | 否 | 红色告警阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值,会阻塞调度任务。 | 10 |
WarningThreshold | string | 否 | 橙色告警阈值。表示与样本预期的偏离程度,您可以根据业务需求自定义该阈值。 | 5 |
TemplateId | integer | 否 | 使用的校验模板的 ID。您可以调用 ListQualityRules 接口获取校验模板的 ID。 | 7 |
RuleName | string | 否 | 校验规则的名称。 | 123 |
PredictType | integer | 否 | 是否为动态阈值。取值如下:
| 0 |
OpenSwitch | boolean | 否 | 规则的启用或停用状态,用于控制质量规则是否在生产环境中运行。
| true |
ProjectId | long | 是 | DataWorks 项目空间 ID。 | 26 |
TaskSetting | string | 否 | 在自定义规则之前插入的变量设置,格式如:x=a,y=b | x=a,y=b |
返回参数
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"Data": true,
"ErrorMessage": "You have no permission.",
"RequestId": "576b9457-2cf5-4****",
"ErrorCode": "0",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-11-15 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-08 | OpenAPI 入参发生变更 | 查看变更详情 |