调用GetQualityRule获取校验规则的信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetQualityRule

要执行的操作。

ProjectName String autotest

引擎或者数据源的名称。

RegionId String cn-shanghai

地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

RuleId Long 1234

校验规则的ID。

返回数据

名称 类型 示例值 描述
Data Struct

获取的规则信息。

BlockType Integer 1

校验规则的强弱。强弱表示规则的重要程度。取值如下:

  • 1,表示强规则。
  • 0,表示弱规则。

    您可以根据实际需求设置重要的规则为强规则。如果使用强规则并触发了红色告警,则会阻塞调度任务。

Checker Integer 9

校验器ID。该字段对应前端的ID标识,需要由pkId转换。

CheckerName String compared with a fixed value

校验器的名称。

Comment String 校验主键唯一

校验规则的描述信息。

CriticalThreshold String 20

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

EntityId Long 165523

分区表达式的ID。

ExpectValue String 30

期望值。

FixCheck Boolean true

固定值校验。

Id Long 123232

规则的ID。

MethodId Integer 8

采集样本数据方法的ID。

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等。

OnDuty String 1822931****

配置校验规则的账号ID。

OnDutyAccountName String test

配置校验规则的阿里云账号名称。

Operator String >=

操作符。

PredictType Integer 0

是否为动态阈值:

  • 0表示非动态阈值。
  • 1表示动态阈值规则。
Property String id

规则属性的字段,即被校验数据源表的column名称。

RuleName String 查看表波动

规则的名称。

RuleType Integer 0

规则的类型。

TemplateId Integer 7

使用的校验模板的ID。

TemplateName String SQL task table rows, 1,7, 30 days fluctuation test

使用的校验模板的名称。

Trend String abs

校验结果的趋势。

WarningThreshold String 10

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

WhereCondition String id>10

校验任务使用的过滤条件或自定义SQL语句。

ErrorCode String 401

错误码。

ErrorMessage String You have no permission.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 576b9457-2cf5-4****

请求ID。

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=GetQualityRule
&ProjectName=autotest
&RegionId=cn-shanghai
&RuleId=1234
&<公共请求参数>

正常返回示例

XML格式

<RequestId>576b9457-2cf5-4***</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <Operator>&gt;&amp;gt;=</Operator>
    <Comment>校验主键唯一</Comment>
    <Checker>9</Checker>
    <CriticalThreshold>20</CriticalThreshold>
    <CheckerName>compared with a fixed value</CheckerName>
    <ExpectValue>30</ExpectValue>
    <WarningThreshold>10</WarningThreshold>
    <OnDuty>1822931****</OnDuty>
    <OnDutyAccountName>test</OnDutyAccountName>
    <Trend>abs</Trend>
    <WhereCondition>id&amp;gt;10</WhereCondition>
    <RuleType>0</RuleType>
    <EntityId>165523</EntityId>
    <MethodId>8</MethodId>
    <FixCheck>true</FixCheck>
    <BlockType>1</BlockType>
    <TemplateName>SQL task table rows, 1,7, 30 days fluctuation test</TemplateName>
    <PredictType>0</PredictType>
    <Id>123232</Id>
    <MethodName>table_count</MethodName>
    <Property>id</Property>
    <TemplateId>7</TemplateId>
    <RuleName>查看表波动</RuleName>
</Data>
<ErrorCode>401</ErrorCode>
<ErrorMessage>You have no permission.</ErrorMessage>
<Success>true</Success>

JSON格式

{
    "RequestId": "576b9457-2cf5-4***",
    "HttpStatusCode": 200,
    "Data": {
        "Operator": ">&gt;=",
        "Comment": "校验主键唯一",
        "Checker": 9,
        "CriticalThreshold": 20,
        "CheckerName": "compared with a fixed value",
        "ExpectValue": 30,
        "WarningThreshold": 10,
        "OnDuty": "1822931****",
        "OnDutyAccountName": "test",
        "Trend": "abs",
        "WhereCondition": "id&gt;10",
        "RuleType": 0,
        "EntityId": 165523,
        "MethodId": 8,
        "FixCheck": true,
        "BlockType": 1,
        "TemplateName": "SQL task table rows, 1,7, 30 days fluctuation test",
        "PredictType": 0,
        "Id": 123232,
        "MethodName": "table_count",
        "Property": "id",
        "TemplateId": 7,
        "RuleName": "查看表波动"
    },
    "ErrorCode": 401,
    "ErrorMessage": "You have no permission.",
    "Success": true
}

错误码

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