获取质量报告业务报告数据 - GetQualityReportBusinessScores
功能介绍
获取质量报告业务报告数据。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/quality/report/business/scores
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方法请参见项目ID和账号ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| table_name | 否 | String | 表名称。 |
| l1 | 否 | String | 主题域分组。 |
| l2 | 否 | String | 主题域。 |
| l3 | 否 | String | 业务对象。 |
| l1_score_order | 否 | String | 主题域分组排序,0表示升序,1表示降序,与其他排序条件互斥。 |
| l2_score_order | 否 | String | 主题域排序,0表示升序,1表示降序,与其他排序条件互斥。 |
| l3_score_order | 否 | String | 业务对象排序,0表示升序,1表示降序,与其他排序条件互斥。 |
| table_score_order | 否 | String | 数据表评分排序,0表示升序,1表示降序,与其他排序条件互斥。 |
| start_timestamp | 否 | Long | 开始时间戳。 |
| end_timestamp | 否 | Long | 结束时间戳。 |
| limit | 否 | Long | 分页条数,取值范围[0,100]。 |
| offset | 否 | Long | 分页偏移量,最小值0。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace | 是 | String | DataArts Studio工作空间ID,获取方法请参见实例ID和工作空间ID。 |
| X-Auth-Token | 是 | String | IAM Token,Token获取请参见认证鉴权。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | Integer | 数据条数。 |
| scores | Array of BusinessScoreVO objects | 返回数据列表BusinessScoreVO。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 评分编号。 |
| l1 | String | 主题域分组。 |
| l2 | String | 主题域。 |
| l3 | String | 业务对象。 |
| table_name | String | 数据表对象名,格式为:数据连接.库.模式表/表。 |
| l1_score | Double | 主题域分组评分。 |
| l2_score | Double | 主题域评分。 |
| l3_score | Double | 业务对象评分。 |
| table_score | Double | 表评分。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,如DQC.0000表示请求处理成功。 |
| error_msg | String | 错误信息。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,如DQC.0000表示请求处理成功。 |
| error_msg | String | 错误信息。 |
请求示例
GET /v2/0833a5737480d53b2f25c010dc1a7b88/quality/report/business/scores
响应示例
状态码:200
Success
{
"count" : 1,
"scores" : [ {
"id" : "1047319323363946496",
"l1" : "test",
"l2" : null,
"l3" : null,
"table_name" : "2d9dcb2076b34bbab1c675f070d6af9d.postgres.public.test",
"l1_score" : 83.33,
"l2_score" : null,
"l3_score" : null,
"table_score" : 83.33
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Success |
| 400 | BadRequest |
| 500 | INTERNAL SERVER ERROR |