文档首页/ 数据安全中心 DSC/ API参考/ API/ 风险评估/ 获取体检任务总览信息与RDS列表 - ShowTask
更新时间:2026-11-13 GMT+08:00
分享

获取体检任务总览信息与RDS列表 - ShowTask

功能介绍

功能介绍:获取指定体检任务的总览信息与RDS实例列表,返回数据库数量、表数量、敏感列数量、异常配置数量、评分及各RDS实例概要。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/dsc/data-health-check/task/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

满足正则匹配"^[a-z0-9]{32}$",即32位小写字母和数字组合。

取值范围:

以IAM服务接口返回值为准,由数字和字母组成,长度为32个字符。

默认取值:

不涉及

task_id

是

String

参数解释:

任务ID,标识一个数据健康检查任务,可通过创建体检任务接口的返回结果获取,或可通过查询体检任务列表接口获取

约束限制:

最大长度65535字符

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

分页偏移

约束限制:

≥0,且 offset + limit ≤ 1000000

取值范围:

≥0

默认取值:

0

resourceType

是

String

参数解释:

资源类型,当前仅支持 RDS

约束限制:

必须为 RDS(大小写不敏感),否则返回参数错误

取值范围:

  • RDS-关系型数据库

默认取值:

不涉及

limit

否

Integer

参数解释:

每页数量限制

约束限制:

1~10000,且 offset + limit ≤ 1000000

取值范围:

1~10000

默认取值:

1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

db_num

Integer

参数解释:

数据库数量

取值范围:

不涉及

table_num

Integer

参数解释:

表数量

取值范围:

不涉及

sensitive_column_num

Integer

参数解释:

敏感列数量

取值范围:

不涉及

exception_config_num

Integer

参数解释:

异常配置数量

取值范围:

不涉及

score

Integer

参数解释:

分数

取值范围:

不涉及

rds_overview

RdsOverview object

参数解释:

RDS概览

取值范围:

不涉及

表5 RdsOverview

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

rds_infos

Array of RdsCheckTaskInfo objects

参数解释:

RDS信息列表

取值范围:

不涉及

表6 RdsCheckTaskInfo

参数

参数类型

描述

id

String

参数解释:

体检任务中 RDS 记录ID

取值范围:

不涉及

instanceId

String

参数解释:

RDS 实例ID

取值范围:

不涉及

rdsName

String

参数解释:

RDS名称

取值范围:

不涉及

请求示例

获取体检任务总览信息与RDS列表

/v1/2b31ed520aabbccddeedb6e571234567/dsc/data-health-check/task/0b02392f3d0042bd8f80376485d9b7d8

响应示例

状态码:200

{
  "db_num" : 1,
  "table_num" : 48,
  "sensitive_column_num" : 120,
  "exception_config_num" : 5,
  "score" : 78,
  "rds_overview" : {
    "total" : 1,
    "rds_infos" : [ {
      "id" : "rds-1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d",
      "instanceId" : "inst-2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e",
      "rdsName" : "finance-mysql-rds-prod"
    } ]
  }
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档