文档首页/ 数据安全中心 DSC/ API参考/ API/ 风险评估/ 创建数据健康检查任务 - CreateTask
更新时间:2026-11-13 GMT+08:00
分享

创建数据健康检查任务 - CreateTask

功能介绍

功能介绍:创建数据健康检查任务,请求体指定待检查的RDS实例ID列表(1~10个),服务端校验RDS端点配置后发起体检任务并返回任务状态。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/dsc/data-health-check/task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

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

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

rds_ids

是

Array of strings

参数解释:

关系型数据库ID列表,数组元素为待检查的关系型数据库实例ID,RDS实例ID可参考查询RDS实例列表接口获取

约束限制:

最少1个,最多10个

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

操作结果状态

取值范围:

不涉及

msg

String

参数解释:

操作结果描述信息

取值范围:

不涉及

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

请求示例

创建数据健康检查任务

{
  "rds_ids" : [ "rds-1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d" ]
}

响应示例

状态码:200

{
  "status" : "success"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档