文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据质量API/ 质量报告接口/ 获取质量报告子规则字段评分
更新时间：2024-09-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取质量报告子规则字段评分

功能介绍

获取质量报告子规则字段评分。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/quality/report/sub-rule/results

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。
表2 Query参数

参数

是否必选

参数类型

描述

data_connection_id

否

String

数据连接id，如果是获取技术报告规则评分，请务必填写data_connection_id，database_name，table_name参数值。

database_name

否

String

数据库名称，如果是获取技术报告规则评分，请务必填写data_connection_id，database_name，table_name参数值。

table_name

否

String

表名称，如果是获取技术报告规则评分，请务必填写data_connection_id，database_name，table_name参数值。

table_object_name

否

String

数据表对象名（数据连接.库.模式表/表）。如果是获取业务报告规则评分，data_connection_id，database_name，table_name参数值不需要填写，只需要填写table_object_name参数值。

sub_rule_instance_id

是

String

子规则实例ID。

start_timestamp

否

Long

开始时间戳。

end_timestamp

否

Long

结束时间戳。

limit

否

Long

分页条数,取值范围[0,100]。

offset

否

Long

分页偏移量,最小值0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

workspace

是

String

DataArts Studio工作空间ID，获取方法请参见实例ID和工作空间ID。

X-Auth-Token

是

String

IAM Token，Token获取请参见认证鉴权。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

header

Array of strings

表头内容。

rows

Array<Array<String>>

表行内容。

count

Integer

数据总行数，用于分页。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DQC.0000表示请求处理成功。

error_msg

String

错误信息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DQC.0000表示请求处理成功。

error_msg

String

错误信息。

请求示例

GET /v2/0833a5737480d53b2f25c010dc1a7b88/quality/report/sub-rule/results?data_connection_id=2d9dcb2076b34bbab1c675f070d6af9d&database_name=postgres&table_name=public.test&sub_rule_instance_id=1047298617787944960

响应示例

状态码： 200

Success

{
  "count" : 1,
  "header" : [ "字段名称", "规则描述", "分数", "字段权重", "空值行数", "总行数", "空值率", "告警状态" ],
  "rows" : [ [ "postgres.public.test.name", "数据表空值扫描", "0.0", "5", "0", "0", "1.0", "false" ] ]
}

状态码

状态码

描述

200

Success

400

BadRequest

500

INTERNAL SERVER ERROR
父主题： 质量报告接口

相关文档