文件下载
功能介绍
文件下载。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data/download
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
eihealth_project_id |
是 |
String |
参数解释: 空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
否 |
String |
参数解释: 下载类型,仅支持PRIVATE、PUBLIC、EXTRANET。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
url |
否 |
String |
参数解释: 资源地址,支持https、obs地址。 约束限制: 不涉及 取值范围: 长度为[1-2000]个字符。 默认取值: 不涉及 |
range_start |
否 |
Long |
参数解释: 指定下载对象的开始位置。 约束限制: 不涉及 取值范围: 长整型整数,范围为[0-9223372036854775807]。 默认取值: 0。 |
range_end |
否 |
Long |
参数解释: 指定下载对象的结束位置。 约束限制: 不涉及 取值范围: 长整型整数,范围为[0-9223372036854775807]。 默认取值: 不涉及 |
响应参数
状态码:200
OK
无
请求示例
-
文件下载,其中文件类型为PUBLIC,文件链接如下。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/data/download { "type" : "PUBLIC", "url" : "https://eihealth-6a713322-72ad-4080-bdcb-acf571576015.obs.endpoint.com/test.txt" }
-
下载数据中心的文件,其中文件类型为PRIVATE,文件链接如下。
{ "type" : "PRIVATE", "url" : "projectName:/test.txt" }
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。