更新时间:2025-07-22 GMT+08:00
分享

下载文件接口

功能介绍

下载指定ID的文件的html。

URI

GET /v1/{project_id}/applications/{application_id}/uni-search/files/preview/{file_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

application_id

String

参数解释:

应用ID,获取方法请参见获取应用ID

约束限制:

字符串

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

file_id

String

参数解释:

文件ID。

约束限制:

不涉及

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

file_type

String

参数解释:

下载对应的预览文件,json类型 ,html类型, md类型。

约束限制:

不涉及

取值范围:

  • json

  • html

  • md

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

-

File

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

请求示例

下载指定ID的文件的html。

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/0ac621de-3624-454e-adcf-8c5b4cf7317c/uni-search/files/preview/1ecc8a18-99b1-4ea4-865c-b4a116619f26

响应示例

状态码

状态码

描述

200

下载成功的文件。

400

请求体参数错误。

500

内部异常。

错误码

请参见错误码

相关文档