获取质量报告规则评分 - GetQualityReportRules

功能介绍

获取质量报告规则评分。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/quality/report/rules

表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参数值。
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参数
参数	参数类型	描述
count	Integer	数据条数。
rules	Array of BusinessScoreRuleVO objects	返回数据列表BusinessScoreRuleVO

表5 BusinessScoreRuleVO
参数	参数类型	描述
rule_name	String	规则名。
type	Integer	规则类型，0表示自定义，1表示系统。
score	Double	规则得分。
rule_id	String	规则ID，用于跳转规则详情页。
instance_id	String	规则实例ID，用于跳转结果页。
scoring_weight	Integer	规则权重。
rule_type_name	String	规则类型名称。
dimension_name	String	规则维度。
sub_rule_instance_id	String	子规则实例ID。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DQC.0000表示请求处理成功。
error_msg	String	错误信息。

状态码：500

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DQC.0000表示请求处理成功。
error_msg	String	错误信息。

请求示例

GET /v2/0833a5737480d53b2f25c010dc1a7b88/quality/report/rules?data_connection_id=2d9dcb2076b34bbab1c675f070d6af9d&database_name=postgres&table_name=public.test

响应示例

状态码：200

Success

{
  "count" : 1,
  "rules" : [ {
    "rule_name" : "test",
    "type" : 0,
    "score" : 0.0,
    "rule_id" : "1044554894322835457",
    "instance_id" : "1047298515736334336",
    "scoring_weight" : 5,
    "rule_type_name" : "数据表空值扫描",
    "dimension_name" : "完整性",
    "sub_rule_instance_id" : "1047298617787944960"
  } ]
}