调用ListQualityResultsByRule,根据规则查询校验结果。

调试

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

请求参数

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

要执行的操作。

EndDate String 2020-09-22 00:00:00

查询截止时间,格式为yyyy-MM-dd HH:mm:ss。

PageNumber Integer 1

页码。

PageSize Integer 10

每页显示的条数,默认为10条,最大100条。

ProjectName String autotest

引擎或者数据源的名称。

RuleId Integer 152322134

规则ID。

StartDate String 2020-09-20 00:00:00

查询开始时间,格式为yyyy-MM-dd HH:mm:ss。

RegionId String cn-hangzhou

地域的信息。

返回数据

名称 类型 示例值 描述
QualityResults Struct

校验结果的顶级结构体。

PageNumber Integer 1

页码。

PageSize Integer 10

每页显示的条数,默认为10条,最大100条。

RuleChecks Array of RuleChecks

校验结果的列表。

ActualExpression String ds=20200925

实际分区。

BeginTime Long 1600704000000

校验的开始时间。

BizDate Long 1600704000000

校检的业务日期。

BlockType Integer 1

规则强弱。

CheckResult Integer 2

校验结果。

CheckResultStatus Integer 2

校验结果。

CheckerId Integer 7

校验器的ID。

CheckerName String fulx

校验器的名称。

CheckerType Integer 0

校验器的类型。

Comment String 这里是规则描述信息

规则描述。

CriticalThreshold Float 0.6

红色阈值。

DateType String YMD

日期的类型。

DiscreteCheck Boolean true

是否为离散校验。

EndTime Long 1600704000000

查询的截止时间。

EntityId Integer 14534343

分区表达式ID。

ExpectValue Float 90

期望值。

ExternalId String 123112232

外部系统触发的标识ID。

ExternalType String CWF2

外部系统的类型。

FixedCheck Boolean false

是否为固定值校验。

Id Integer 2231123

主键ID。

IsPrediction Boolean false

是否为预测的结果。

LowerValue Float 2344

预测下限。

MatchExpression String ds=$[yyyymmdd]

分区表达式。

MethodName String max

采集方法。

Op String >

比较符。

ProjectName String autotest

引擎和数据源的名称。

Property String type

规则属性的字段。

ReferenceValue Array of ReferenceValue

历史样本值。

BizDate Long 1600704000000

业务日期。

DiscreteProperty String type1

离散唯一值。

SingleCheckResult Integer 2

校验结果。

Threshold Float 0.2

趋势。

Value Float 20

样本值。

ResultString String ResultString

校验结果的字符串形式。

RuleId Integer 123421

规则ID。

RuleName String 这里是规则名称

规则的名称。

SampleValue Array of SampleValue

当次样本。

BizDate Long 1600704000000

业务日期。

DiscreteProperty String type2

离散属性。

Value Float 23

样本值。

TableName String dual

表名称。

TaskId String 16008552981681a0d6****

任务ID。

TemplateId Integer 5

模板ID。

TemplateName String 字段唯一值个数期望值校验

模板的名称。

TimeCost String 10

校验花费的时间。

Trend String up

趋势。

UpperValue Float 22200

预测上限。

WarningThreshold Float 0.1

橙色阈值。

WhereCondition String type!='type2'

过滤条件。

TotalCount Long 200

数据的总记录数。

RequestId String CBA58543-00D4-41****

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListQualityResultsByRule
&EndDate=2020-09-22 00:00:00
&PageNumber=1
&PageSize=10
&ProjectName=autotest
&RuleId=152322134
&StartDate=2020-09-20 00:00:00
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>CBA58543-00D4-41****</RequestId>
<QualityResults>
    <TotalCount>200</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RuleChecks>
        <Op>&amp;gt;</Op>
        <TaskId>16008552981681a0d6****</TaskId>
        <EndTime>1600704000000</EndTime>
        <DiscreteCheck>true</DiscreteCheck>
        <CheckerName>fulx</CheckerName>
        <ExpectValue>90</ExpectValue>
        <ProjectName>autotest</ProjectName>
        <RuleId>123421</RuleId>
        <WarningThreshold>0.1</WarningThreshold>
        <WhereCondition>type!='type2'</WhereCondition>
        <BeginTime>1600704000000</BeginTime>
        <CheckResultStatus>2</CheckResultStatus>
        <MatchExpression>ds=$[yyyymmdd]</MatchExpression>
        <UpperValue>22200</UpperValue>
        <IsPrediction>false</IsPrediction>
        <CheckResult>2</CheckResult>
        <TemplateName>字段唯一值个数期望值校验</TemplateName>
        <TimeCost>10</TimeCost>
        <FixedCheck>false</FixedCheck>
        <MethodName>max</MethodName>
        <ResultString>ResultString</ResultString>
        <Property>type</Property>
        <DateType>YMD</DateType>
        <BizDate>1600704000000</BizDate>
        <TemplateId>5</TemplateId>
        <RuleName>这里是规则名称</RuleName>
        <Comment>这里是规则描述信息</Comment>
        <CriticalThreshold>0.6</CriticalThreshold>
        <ExternalId>123112232</ExternalId>
        <Trend>up</Trend>
        <CheckerType>0</CheckerType>
        <ExternalType>CWF2</ExternalType>
        <CheckerId>7</CheckerId>
        <EntityId>14534343</EntityId>
        <TableName>dual</TableName>
        <BlockType>1</BlockType>
        <Id>2231123</Id>
        <ActualExpression>ds=20200925</ActualExpression>
        <LowerValue>2344</LowerValue>
    </RuleChecks>
    <RuleChecks>
        <SampleValue>
            <SingleCheckResult>2</SingleCheckResult>
            <Value>20</Value>
            <BizDate>1600704000000</BizDate>
            <DiscreteProperty>type1</DiscreteProperty>
            <Threshold>0.2</Threshold>
        </SampleValue>
        <SampleValue>
            <Value>23</Value>
            <BizDate>1600704000000</BizDate>
            <DiscreteProperty>type2</DiscreteProperty>
        </SampleValue>
        <ReferenceValue>
            <SingleCheckResult>2</SingleCheckResult>
            <Value>20</Value>
            <BizDate>1600704000000</BizDate>
            <DiscreteProperty>type1</DiscreteProperty>
            <Threshold>0.2</Threshold>
        </ReferenceValue>
        <ReferenceValue>
            <Value>23</Value>
            <BizDate>1600704000000</BizDate>
            <DiscreteProperty>type2</DiscreteProperty>
        </ReferenceValue>
    </RuleChecks>
</QualityResults>

JSON 格式

{
    "RequestId": "CBA58543-00D4-41****",
    "QualityResults": {
        "TotalCount": 200,
        "PageSize": 10,
        "PageNumber": 1,
        "RuleChecks": [
            {
                "Op": "&gt;",
                "TaskId": "16008552981681a0d6****",
                "EndTime": 1600704000000,
                "DiscreteCheck": true,
                "CheckerName": "fulx",
                "ExpectValue": 90,
                "ProjectName": "autotest",
                "RuleId": 123421,
                "WarningThreshold": 0.1,
                "WhereCondition": "type!='type2'",
                "BeginTime": 1600704000000,
                "CheckResultStatus": 2,
                "MatchExpression": "ds=$[yyyymmdd]",
                "UpperValue": 22200,
                "IsPrediction": false,
                "CheckResult": 2,
                "TemplateName": "字段唯一值个数期望值校验",
                "TimeCost": 10,
                "FixedCheck": false,
                "MethodName": "max",
                "ResultString": "ResultString",
                "Property": "type",
                "DateType": "YMD",
                "BizDate": 1600704000000,
                "TemplateId": 5,
                "RuleName": "这里是规则名称",
                "Comment": "这里是规则描述信息",
                "CriticalThreshold": 0.6,
                "ExternalId": 123112232,
                "Trend": "up",
                "CheckerType": 0,
                "ExternalType": "CWF2",
                "CheckerId": 7,
                "EntityId": 14534343,
                "TableName": "dual",
                "BlockType": 1,
                "Id": 2231123,
                "ActualExpression": "ds=20200925",
                "LowerValue": 2344
            },
            {
                "SampleValue": [
                    {
                        "SingleCheckResult": 2,
                        "Value": 20,
                        "BizDate": 1600704000000,
                        "DiscreteProperty": "type1",
                        "Threshold": 0.2
                    },
                    {
                        "Value": 23,
                        "BizDate": 1600704000000,
                        "DiscreteProperty": "type2"
                    }
                ],
                "ReferenceValue": [
                    {
                        "SingleCheckResult": 2,
                        "Value": 20,
                        "BizDate": 1600704000000,
                        "DiscreteProperty": "type1",
                        "Threshold": 0.2
                    },
                    {
                        "Value": 23,
                        "BizDate": 1600704000000,
                        "DiscreteProperty": "type2"
                    }
                ]
            }
        ]
    }
}

错误码

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