生成结果导出任务状态查询 - ShowClassificationResultExportStatus
功能介绍
功能介绍:查询分类结果导出任务的状态。 关键参数说明:通过job_id定位导出任务。 返回值说明:返回导出任务状态(FINISHED等)、作业名称、资产信息和导出文件名。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/scan-jobs/{job_id}/classification-results/export/status
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
| job_id | 是 | String | 参数解释: 扫描作业ID,标识需要查询导出任务状态的扫描作业,可通过调用查询扫描作业列表接口获取 约束限制: 不涉及 取值范围: 长度1~64个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| job_name | String | 参数解释: 作业名称,标识导出任务对应的扫描作业名称 取值范围: 字符串类型 |
| asset_type | String | 参数解释: 分类结果导出响应类型 取值范围: 不涉及 |
| asset_name | String | 参数解释: 资产名称 取值范围: 不涉及 |
| bucket_name | String | 参数解释: 桶名称 取值范围: 不涉及 |
| file_name | String | 参数解释: 文件名称,导出结果的输出文件名 取值范围: 字符串类型 |
| start_time | String | 参数解释: 开始时间 取值范围: 不涉及 |
请求示例
生成结果导出任务状态查询
/v1/2b31ed520aabbccddeedb6e5712345678/scan-jobs/3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d/classification-results/export/status
响应示例
状态码: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 | 请求已成功 |
错误码
请参见错误码。