调用ListQualityResultsByEntity,根据分区表达式查询校验历史结果。

调试

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

请求参数

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

要执行的操作。

EndDate String 2020-09-21 00:00:00

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

EntityId Integer 152322134

分区表达式ID。

PageNumber Integer 1

页码。

PageSize Integer 10

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

ProjectName String autotest

引擎或者数据源的名称。

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

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

RegionId String cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
QualityResults Struct

校验结果的顶级结构体。

PageNumber Integer 1

页码。

PageSize Integer 10

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

RuleChecks Array of RuleChecks

校验结果列表。

ActualExpression String ds=20200912

实际分区。

BeginTime Long 1600704000000

校验开始时间。

BizDate Long 1600704000000

业务日期。

BlockType Integer 0

规则强弱:

  • 0:弱规则
  • 1:强规则
CheckResult Integer 0

校验结果:

  • 0:正常
  • 1:橙色告警
  • 2:红色告警
CheckResultStatus Integer 0

校验结果,同checkresult。

CheckerId Integer 7

校验器的ID。

CheckerName String fulx

校验器的名称。

CheckerType Integer 0

校验类型。

Comment String 测试规则的描述

规则描述。

CriticalThreshold Float 0.5

橙色阈值。

DateType String YMD

任务时间类型。

DiscreteCheck Boolean true

是否为离散校验。

EndTime Long 1600704000000

校验的结束时间。

EntityId Integer 15432322

分区表达式ID。

ExpectValue Float 200

期望值。

ExternalId String 1112323123

外部触发系统的标识ID。

ExternalType String CWF2

外部系统触发类型。

FixedCheck Boolean false

是否为固定值校验。

Id Integer 121212121

内部主键ID。

IsPrediction Boolean true

是否为预测结果。

LowerValue Float 232222

预测结果的下限。

MatchExpression String ds=$[yyyymmdd]

分区表达式。

MethodName String count_distinct

采集方法的名称。

Op String >

比较符号。

ProjectName String autotest

引擎或者数据源的名称。

Property String type

规则属性的字段。

ReferenceValue Array of ReferenceValue

历史样本值。

BizDate Long 1600704000000

业务日期

DiscreteProperty String 0

唯一值

SingleCheckResult Integer 0

校验结果

Threshold Float 0.5

阈值

Value Float 19

校验值

ResultString String test

校验结果字符形式。

RuleId Integer 123123232

规则ID。

RuleName String 测试规则

规则的名称。

SampleValue Array of SampleValue

当次样本。

BizDate Long 1600704000000

业务日期。

DiscreteProperty String 0

唯一值。

Value Float 19

当次样本值。

TableName String dual

表名称。

TaskId String 16008552981681a0d6****

任务ID。

TemplateId Integer 5

模板ID。

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

模板的名称。

TimeCost String 202s

校验时长。

Trend String abs

趋势。

UpperValue Float 25555

预测结果的上限。

WarningThreshold Float 0.1

橙色阈值。

WhereCondition String id>0

规则过滤条件。

TotalCount Long 50

总条数。

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

请求ID。

示例

请求示例

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

正常返回示例

XML 格式

<RequestId>CBA58543-00D4-41****</RequestId>
<QualityResults>
    <TotalCount>50</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>200</ExpectValue>
        <ProjectName>autotest</ProjectName>
        <RuleId>123123232</RuleId>
        <WarningThreshold>0.1</WarningThreshold>
        <WhereCondition>id&amp;gt;0</WhereCondition>
        <BeginTime>1600704000000</BeginTime>
        <CheckResultStatus>0</CheckResultStatus>
        <MatchExpression>ds=$[yyyymmdd]</MatchExpression>
        <UpperValue>25555</UpperValue>
        <IsPrediction>true</IsPrediction>
        <CheckResult>0</CheckResult>
        <TemplateName>字段唯一值个数期望值校验</TemplateName>
        <TimeCost>202s</TimeCost>
        <FixedCheck>false</FixedCheck>
        <MethodName>count_distinct</MethodName>
        <ResultString>test</ResultString>
        <Property>type</Property>
        <DateType>YMD</DateType>
        <BizDate>1600704000000</BizDate>
        <TemplateId>5</TemplateId>
        <RuleName>测试规则</RuleName>
        <Comment>测试规则的描述</Comment>
        <CriticalThreshold>0.5</CriticalThreshold>
        <ExternalId>1112323123</ExternalId>
        <Trend>abs</Trend>
        <CheckerType>0</CheckerType>
        <ExternalType>CWF2</ExternalType>
        <CheckerId>7</CheckerId>
        <EntityId>15432322</EntityId>
        <TableName>dual</TableName>
        <BlockType>0</BlockType>
        <Id>121212121</Id>
        <ActualExpression>ds=20200912</ActualExpression>
        <LowerValue>232222</LowerValue>
    </RuleChecks>
    <RuleChecks>
        <SampleValue>
            <SingleCheckResult>0</SingleCheckResult>
            <Value>19</Value>
            <BizDate>1600704000000</BizDate>
            <DiscreteProperty>0</DiscreteProperty>
            <Threshold>0.5</Threshold>
        </SampleValue>
        <SampleValue>
            <Value>19</Value>
            <BizDate>1600704000000</BizDate>
            <DiscreteProperty>0</DiscreteProperty>
        </SampleValue>
        <ReferenceValue>
            <SingleCheckResult>0</SingleCheckResult>
            <Value>19</Value>
            <BizDate>1600704000000</BizDate>
            <DiscreteProperty>0</DiscreteProperty>
            <Threshold>0.5</Threshold>
        </ReferenceValue>
        <ReferenceValue>
            <Value>19</Value>
            <BizDate>1600704000000</BizDate>
            <DiscreteProperty>0</DiscreteProperty>
        </ReferenceValue>
    </RuleChecks>
</QualityResults>

JSON 格式

{
    "RequestId": "CBA58543-00D4-41****",
    "QualityResults": {
        "TotalCount": 50,
        "PageSize": 10,
        "PageNumber": 1,
        "RuleChecks": [
            {
                "Op": "&gt;",
                "TaskId": "16008552981681a0d6****",
                "EndTime": 1600704000000,
                "DiscreteCheck": true,
                "CheckerName": "fulx",
                "ExpectValue": 200,
                "ProjectName": "autotest",
                "RuleId": 123123232,
                "WarningThreshold": 0.1,
                "WhereCondition": "id&gt;0",
                "BeginTime": 1600704000000,
                "CheckResultStatus": 0,
                "MatchExpression": "ds=$[yyyymmdd]",
                "UpperValue": 25555,
                "IsPrediction": true,
                "CheckResult": 0,
                "TemplateName": "字段唯一值个数期望值校验",
                "TimeCost": "202s",
                "FixedCheck": false,
                "MethodName": "count_distinct",
                "ResultString": "test",
                "Property": "type",
                "DateType": "YMD",
                "BizDate": 1600704000000,
                "TemplateId": 5,
                "RuleName": "测试规则",
                "Comment": "测试规则的描述",
                "CriticalThreshold": 0.5,
                "ExternalId": 1112323123,
                "Trend": "abs",
                "CheckerType": 0,
                "ExternalType": "CWF2",
                "CheckerId": 7,
                "EntityId": 15432322,
                "TableName": "dual",
                "BlockType": 0,
                "Id": 121212121,
                "ActualExpression": "ds=20200912",
                "LowerValue": 232222
            },
            {
                "SampleValue": [
                    {
                        "SingleCheckResult": 0,
                        "Value": 19,
                        "BizDate": 1600704000000,
                        "DiscreteProperty": 0,
                        "Threshold": 0.5
                    },
                    {
                        "Value": 19,
                        "BizDate": 1600704000000,
                        "DiscreteProperty": 0
                    }
                ],
                "ReferenceValue": [
                    {
                        "SingleCheckResult": 0,
                        "Value": 19,
                        "BizDate": 1600704000000,
                        "DiscreteProperty": 0,
                        "Threshold": 0.5
                    },
                    {
                        "Value": 19,
                        "BizDate": 1600704000000,
                        "DiscreteProperty": 0
                    }
                ]
            }
        ]
    }
}

错误码

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