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