生成结果导出任务 - ExportClassificationResults
功能介绍
功能介绍:创建分类结果导出任务,将指定扫描作业的分类识别结果按条件导出到OBS桶。 关键参数说明:请求体支持按资产类型、资产ID、桶名称、时间范围、安全等级、关键字等条件筛选导出内容;可通过security_level_ids指定安全等级,mask控制是否脱敏。 返回值说明:返回导出任务状态、作业名称、资产信息和导出文件名。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/scan-jobs/{job_id}/classification-results/export
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
| job_id | 是 | String | 参数解释: 扫描作业ID,标识需要导出分类结果的扫描作业,可通过调用查询扫描作业列表接口获取 约束限制: 不涉及 取值范围: 长度1~64个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| bucket_name | 否 | String | 参数解释: 桶名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| asset_type | 否 | String | 参数解释: 导出类型 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| asset_id | 否 | String | 参数解释: 资产ID,标识需要导出结果的资产,可通过调用查询资产列表接口获取 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| start_time | 否 | Long | 参数解释: 开始时间,导出结果的时间范围起始点,为Unix时间戳,单位为秒 约束限制: 不涉及 取值范围: Unix时间戳,单位为秒 默认取值: 不涉及 |
| database_name | 否 | String | 参数解释: 数据库名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| table_name | 否 | String | 参数解释: 表名称,标识需要导出结果的数据库表名称 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| filter_bucket_name | 否 | String | 参数解释: 过滤桶名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| security_level_ids | 否 | Array of strings | 参数解释: 安全级别ID列表,指定需要导出的安全等级范围,列表元素为字符串类型的安全级别ID,可通过调用查询安全级别列表接口获取 约束限制: 不涉及 取值范围: 数组类型 默认取值: 不涉及 |
| keyword | 否 | String | 参数解释: 关键字 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| sort | 否 | String | 参数解释: 排序,用于指定导出结果的排序方式,格式为「字段名:asc」或「字段名:desc」,asc表示升序,desc表示降序 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| mask | 否 | Boolean | 参数解释: 是否脱敏 约束限制: 不涉及 取值范围: true-启用,false-不启用 默认取值: true |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| job_name | String | 参数解释: 作业名称,标识导出任务对应的扫描作业名称 取值范围: 字符串类型 |
| asset_type | String | 参数解释: 分类结果导出响应类型 取值范围: 不涉及 |
| asset_name | String | 参数解释: 资产名称 取值范围: 不涉及 |
| bucket_name | String | 参数解释: 桶名称 取值范围: 不涉及 |
| file_name | String | 参数解释: 文件名称,导出结果的输出文件名 取值范围: 字符串类型 |
| start_time | String | 参数解释: 开始时间 取值范围: 不涉及 |
请求示例
生成结果导出任务
{
"bucket_name" : "obs-bucket-01",
"asset_type" : "OBS",
"asset_id" : "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f",
"start_time" : 1700000000000,
"database_name" : "database-01",
"table_name" : "user_info_table",
"filter_bucket_name" : "obs-bucket-01",
"security_level_ids" : [ "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e", "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b" ],
"keyword" : "phone",
"sort" : "export-01",
"mask" : true
} 响应示例
状态码:200
{
"status" : "FINISHED",
"job_name" : "scan-job-01",
"asset_type" : "OBS",
"asset_name" : "asset-obs-01",
"bucket_name" : "obs-bucket-01",
"file_name" : "classification-result-20231114.xlsx",
"start_time" : "2023-11-14T22:13:20Z"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。