全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：GetQualityRule - 获取规则的信息

    文档中心

    大数据开发治理平台 DataWorks：GetQualityRule - 获取规则的信息

    更新时间：Nov 15, 2024

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

    调试

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

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    RuleIdlong是

    校验规则的 ID。您可以调用 ListQualityRules 接口查看 RuleId 的相关信息。

    		1234
    ProjectNamestring是

    引擎或者数据源的名称。

    		autotest
    ProjectIdlong是

    DataWorks 项目空间 ID。

    		12345

    返回参数

    名称类型描述示例值
    object

    返回数据结构。

    HttpStatusCodeinteger

    HTTP 状态码。

    		200
    RequestIdstring

    请求 ID。

    		576b9457-2cf5-4****
    ErrorMessagestring

    错误信息。

    		You have no permission.
    ErrorCodestring

    错误码。

    		401
    Successboolean

    调用是否成功。

    		true
    Dataobject

    获取的规则信息。

    BlockTypeinteger

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

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

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

    		test
    WarningThresholdstring

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

    		10
    Propertystring

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

    		id
    RuleTypeinteger

    规则的类型。

    		0
    Commentstring

    校验规则的描述信息。

    		校验主键唯一
    OnDutystring

    配置校验规则的账号 ID。

    		1822931****
    Checkerinteger

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

    		9
    FixCheckboolean

    固定值校验。

    		true
    MethodIdinteger

    采集样本数据方法的 ID。

    		8
    CriticalThresholdstring

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

    		20
    PredictTypeinteger

    是否为动态阈值：

    • 0 表示非动态阈值。
    • 1 表示动态阈值规则。
    		0
    TemplateNamestring

    使用的校验模板的名称。

    		SQL task table rows, 1,7, 30 days fluctuation test
    CheckerNamestring

    校验器的名称。

    		compared with a fixed value
    RuleNamestring

    规则的名称。

    		查看表波动
    MethodNamestring

    采集样本数据方法的名称。包括 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 等。

    		table_count
    EntityIdlong

    分区表达式的 ID。

    		165523
    WhereConditionstring

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

    		id>10
    Operatorstring

    操作符。

    		>=
    ExpectValuestring

    期望值。

    		30
    Trendstring

    校验结果的趋势。

    		abs
    TemplateIdinteger

    使用的校验模板的 ID。

    		7
    Idlong

    规则的 ID。

    		123232
    OpenSwitchboolean

    规则是否开启

    		true

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-06-18OpenAPI 返回结构发生变更查看变更详情
    2023-08-29API 内部配置变更，不影响调用查看变更详情
    2023-03-08OpenAPI 入参发生变更查看变更详情