调用CreateQualityRule创建质量监控规则。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | CreateQualityRule |
系统规定参数。取值:CreateQualityRule。 |
BlockType | Integer | 是 | 0 |
规则的强弱:0表示弱规则,1表示强规则。 |
EntityId | Long | 是 | 15224 |
分区表达式的ID。 |
Comment | String | 否 | 验证 |
规则的描述信息。 |
Checker | Integer | 是 | 9 |
校验器的ID。 |
ExpectValue | String | 否 | 0 |
期望值。 |
Trend | String | 否 | abs |
校验结果的趋势。取值如下:
|
MethodName | String | 是 | count/table_count |
采样方。如果是自定义SQL,该参数的值为user_defined。 |
Operator | String | 否 | > |
比较符。包括>、>=、=、≠、<和<=等。 说明 当Checker=9时,Operator为必选参数。 |
ProjectName | String | 是 | autotest | 引擎或者数据源的名称。 |
Property | String | 否 | table_id |
规则的字段。如果是表级别校验,行数为table_count、大小为table_size字段。 |
PropertyType | String | 否 | bigint |
字段的类型,表级table,字段级填写bigint等。 |
RuleType | Integer | 是 | 0 |
规则的类型:0表示系统定义、1表示用户自定义、2表示项目级规则。 |
WhereCondition | String | 否 | table_id>1 |
过滤条件或自定义SQL。 |
CriticalThreshold | String | 否 | 20 |
红色告警阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值,会阻塞调度任务。 |
WarningThreshold | String | 否 | 10 |
橙色告警阈值。表示与样本预期的偏离程度,您可以根据业务需求自定义该阈值。 |
TemplateId | Integer | 否 | 7 |
模板的ID。 |
RuleName | String | 是 | 1234 |
规则的名称。 |
PredictType | Integer | 是 | 0 |
是否为动态阈值:0表示非动态阈值、2表示动态阈值规则。 |
ProjectId | Long | 是 | 10000 |
DataWorks工作空间的ID。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间ID。 |
TaskSetting | String | 否 | x=a,y=b |
在自定义规则之前插入的变量设置,格式如:x=a,y=b。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 |
HTTP返回码。 |
Data | String | 12345 |
新建的规则ID。 |
ErrorMessage | String | You have no permission. |
错误信息。 |
RequestId | String | ecb967ec-c137-48**** |
请求ID。 |
ErrorCode | String | 401 |
错误码。 |
Success | Boolean | true |
调用是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateQualityRule
&BlockType=0
&EntityId=15224
&Comment=验证
&Checker=9
&ExpectValue=0
&Trend=abs
&MethodName=count/table_count
&Operator=>
&ProjectName=autotest
&Property=table_id
&PropertyType=bigint
&RuleType=0
&WhereCondition=table_id>1
&CriticalThreshold=20
&WarningThreshold=10
&TemplateId=7
&RuleName=1234
&PredictType=0
&ProjectId=10000
&TaskSetting=x=a,y=b
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
200
12345
You have no permission.
ecb967ec-c137-48****
401
true
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"Data" : 12345,
"ErrorMessage" : "You have no permission.",
"RequestId" : "ecb967ec-c137-48****",
"ErrorCode" : 401,
"Success" : true
}
错误码
访问错误中心查看更多错误码。
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/171181.html