获取体检任务具体信息 - ShowRds
功能介绍
功能介绍:获取指定体检任务下某个RDS实例的详细检测结果,支持按风险等级筛选返回敏感列级检测明细;isSecurityConfig 为 true 时仅返回 RDS 安全配置项状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/dsc/data-health-check/task/{task_id}/rds/{rds_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 满足正则匹配"^[a-z0-9]{32}$",即32位小写字母和数字组合。 取值范围: 以IAM服务接口返回值为准,由数字和字母组成,长度为32个字符。 默认取值: 不涉及 |
| task_id | 是 | String | 参数解释: 任务ID,标识一个数据健康检查任务,可通过调用创建数据健康检查任务接口获取,或可在数据安全中心控制台体检任务列表中查看 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| rds_id | 是 | String | 参数解释: 关系型数据库ID,标识待查询的具体关系型数据库实例,可通过调用RDS服务查询实例列表接口获取,或可在RDS控制台实例详情页查看 约束限制: 最大长度65535字符 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释: 分页偏移 约束限制: ≥0,且 offset + limit ≤ 1000000 取值范围: ≥0 默认取值: 0 |
| riskLevel | 否 | String | 参数解释: 风险等级 约束限制: 取值必须为 HIGH、MIDDLE、LOW 之一(大小写不敏感) 取值范围: 默认取值: 不涉及 |
| isSecurityConfig | 否 | Boolean | 参数解释: 是否仅查询 RDS 安全配置项状态 约束限制: 为 true 时仅返回 rds_security_config,limit、offset、riskLevel、dbName、tableName 均不生效 取值范围: true-仅查询安全配置,false-查询敏感列检测明细 默认取值: 不涉及 |
| dbName | 否 | String | 参数解释: 数据库名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| tableName | 否 | String | 参数解释: 表名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 每页数量限制 约束限制: 1~10000,且 offset + limit ≤ 1000000 取值范围: 1~10000 默认取值: 1000 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rds_id | String | 参数解释: 关系型数据库ID 取值范围: 不涉及 |
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| rds_infos | Array of RdsCheckResult objects | 参数解释: RDS信息列表 取值范围: 不涉及 |
| rds_security_config | RdsSecurityConfig object | 参数解释: RDS安全配置 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| db_name | String | 参数解释: 数据库名称 取值范围: 不涉及 |
| table_name | String | 参数解释: 表名称 取值范围: 不涉及 |
| column_name | String | 参数解释: 列名称 取值范围: 不涉及 |
| risk_level | Integer | 参数解释: 风险等级数值,取值 0~10 取值范围: 说明: 7-高风险、4~7-中风险、1~2-低风险 |
| rule_name | String | 参数解释: 规则名称 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| encrypt_config_status | String | 参数解释: 加密配置状态 取值范围: true-已开启,false-未开启 |
| ssl_config_status | String | 参数解释: SSL配置状态 取值范围: true-已开启,false-未开启 |
| public_ip_config_status | String | 参数解释: 公共IP地址配置状态 取值范围: true-已开启,false-未开启 |
| cbh_config_status | String | 参数解释: CBH配置状态 取值范围: true-已开启,false-未开启 |
| dbss_config_status | String | 参数解释: 数据库安全服务配置状态 取值范围: true-已开启,false-未开启 |
请求示例
获取体检任务RDS详细检测结果
/v1/2b31ed520aabbccddeedb6e571234567/dsc/data-health-check/task/0b02392f3d0042bd8f80376485d9b7d8/rds/0b02392f3d0042bd8f80376485d9b7d8
响应示例
状态码:200
{
"rds_id" : "rds-1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d",
"total" : 1,
"rds_infos" : [ {
"db_name" : "finance_db",
"table_name" : "customer_accounts",
"column_name" : "balance",
"risk_level" : 9,
"rule_name" : "金融敏感数据识别规则-账户余额"
} ],
"rds_security_config" : {
"encrypt_config_status" : "true",
"ssl_config_status" : "true",
"public_ip_config_status" : "false",
"cbh_config_status" : "true",
"dbss_config_status" : "true"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。