导出模板内容 - ExportScanTemplate
功能介绍
功能介绍:将识别模板内容导出到OBS桶,生成导出任务。 关键参数说明:请求体bucket必填,指定导出目标桶。 返回值说明:返回导出任务状态、桶信息、文件名及时间。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/scan-templates/{template_id}/export
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
| template_id | 是 | String | 参数解释: 识别模板ID,标识需要导出内容的识别模板,可通过调用查询模板列表接口获取 约束限制: 不涉及 取值范围: 长度1~64个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| bucket | 是 | String | 参数解释: OBS桶名 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| bucket | String | 参数解释: OBS桶名 取值范围: 不涉及 |
| full_file_name | String | 参数解释: 完整文件名称 取值范围: 不涉及 |
| create_time | Long | 参数解释: 创建时间,模板导出任务的创建时间,为Unix时间戳,单位为毫秒 取值范围: 毫秒级Unix时间戳 |
| start_time | Long | 参数解释: 开始时间,模板导出任务的开始时间,为Unix时间戳,单位为毫秒 取值范围: 毫秒级Unix时间戳 |
| end_time | Long | 参数解释: 结束时间,模板导出任务的结束时间,为Unix时间戳,单位为毫秒 取值范围: 毫秒级Unix时间戳 |
| failed_description | String | 参数解释: 失败描述 取值范围: 不涉及 |
请求示例
导出模板内容
{
"bucket" : "export-01"
} 响应示例
状态码:200
{
"status" : "FINISHED",
"bucket" : "export-01",
"full_file_name" : "classification-result-20231114.xlsx",
"create_time" : 1700000000000,
"start_time" : 1700000000000,
"end_time" : 1700000000000,
"failed_description" : "export示例描述"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。