文档首页/ 数据安全中心 DSC/ API参考/ API/ 风险评估/ 获取体检任务总览信息与RDS列表 - ShowTask
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

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

功能介绍

功能介绍：获取体检任务总览信息与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获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32。

默认取值：

不涉及

task_id

是

String

参数解释：

任务ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

分页偏移

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

risk_level

否

String

参数解释：

风险等级

约束限制：

最大长度256字符

取值范围：

不涉及

默认取值：

不涉及

resource_type

否

String

参数解释：

资源类型

约束限制：

最大长度256字符

取值范围：

不涉及

默认取值：

不涉及

is_security_config

否

Boolean

参数解释：

是否检查安全配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

task_id

否

String

参数解释：

任务ID

约束限制：

最大长度256字符

取值范围：

不涉及

默认取值：

不涉及

rds_id

否

String

参数解释：

RDS实例ID

约束限制：

最大长度256字符

取值范围：

不涉及

默认取值：

不涉及

db_name

否

String

参数解释：

数据库名称

约束限制：

最大长度256字符

取值范围：

不涉及

默认取值：

不涉及

table_name

否

String

参数解释：

表名称

约束限制：

最大长度256字符

取值范围：

不涉及

默认取值：

不涉及

limit

否

Integer

参数解释：

每页数量限制

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

IAM服务查询用户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

参数解释：

资源ID，唯一标识

取值范围：

不涉及

instance_id

String

参数解释：

实例ID

取值范围：

不涉及

rds_name

String

参数解释：

RDS名称

取值范围：

不涉及

请求示例

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

/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/dsc/data-health-check/task/xxxx-xxxx-xxxx-xxxx

响应示例

状态码：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",
      "instance_id" : "inst-2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e",
      "rds_name" : "finance-mysql-rds-prod"
    } ]
  }
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题： 风险评估

相关文档