更新时间:2024-05-11 GMT+08:00
分享

下载对比任务结果文件

功能介绍

下载对比任务结果文件。

URI

GET /v3/{project_id}/jobs/{job_id}/compare/result/file

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

job_id

String

任务ID。

表2 Query参数

参数

是否必选

参数类型

描述

compare_type

String

对比任务类型:

  • contents: 内容对比。
  • lines:行数对比。
  • random:抽样对比。
  • objects_comparison:对象对比。

compare_job_id

String

对比任务的ID,内容对比、抽样对比、行数对比场景必填。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

指定类型为application/json。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

X-Language

String

请求语言类型。

缺省值:en-us

枚举值:

  • en-us
  • zh-cn

Region

String

区域ID,例如:cn-north-4。

表4 请求Body参数

参数

是否必选

参数类型

描述

compare_type

String

对比任务类型:

  • contents: 内容对比。
  • lines:行数对比。
  • random:抽样对比。
  • objects_comparison:对象对比。

compare_job_id

String

对比任务的ID,内容对比、抽样对比、行数对比场景必填。

time_zone

String

时区,如GMT+08:00,用于生成当前时间标识,拼接到文件名称中。

响应参数

请求示例

下载对比任务结果文件

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/f8688cfa-4e05-406f-a2e6-37a773cjb20ycompare/result/file?compare_type=objects_comparison

响应示例

状态码: 200

OK

响应体为文件流格式,文件下载内容为.xlsx类型。

状态码: 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Task not found. Check the task ID."
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档