文档首页/CodeArts IDE Online/API参考/API/插件市场/文件上传归一化 - UploadFilePublisher
更新时间：2026-01-15 GMT+08:00
查看PDF
分享

文件上传归一化 - UploadFilePublisher

功能介绍

在CodeArts IDE Online中，文件上传归一化是指在文件上传过程中，对文件进行标准化处理，以确保文件在不同环境和系统中的一致性和兼容性。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

当前API调用无需身份策略权限。

URI

POST /v2/fileservice/file/upload

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：

通过调用IAM服务获取用户的Token（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

1~100000。

默认取值：

不涉及。

x-publisher-token

否

String

参数解释：

发布商凭证。

约束限制：

不涉及。

取值范围：

1~100000。

默认取值：

不涉及。

表2 FormData参数

参数

是否必选

参数类型

描述

file

是

File

参数解释：

文件。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

publisher_id

否

String

参数解释：

发布商ID。

约束限制：

传用户token时，此字段为必传项。

取值范围：

1~10000。

默认取值：

不涉及。

chunk_index

是

Long

参数解释：

分片索引。

约束限制：

传用户token时，此字段为必传项。

取值范围：

1~100。

默认取值：

不涉及。

merge

是

Boolean

参数解释：

是否合并已上传的分片（包含本次分片内容）。

约束限制：

不涉及。

取值范围：

  • true ：合并已上传的分片。

  • false ：不合并已上传的分片。

默认取值：

不涉及。

total_chunk_num

是

Long

参数解释：

总分片数。

约束限制：

不涉及

取值范围：

1~100。

默认取值：

不涉及。

parent_file_size

是

Long

参数解释：

父文件大小。

约束限制：

不涉及

取值范围：

0~9223372036854775807。

默认取值：

不涉及。

parent_file_name

是

String

参数解释：

父文件名称。

约束限制：

不涉及

取值范围：

0~10000。

默认取值：

不涉及。

override

是

Boolean

参数解释：

是否覆盖原有文件。

约束限制：

不涉及

取值范围：

  • true ：覆盖原有文件。

  • false ：不覆盖原有文件。

默认取值：

不涉及。

chunk_md5

是

String

参数解释：

文件分片的md5，用于校验文件分片是否完整。

约束限制：

不涉及

取值范围：

1~10000。

默认取值：

不涉及。

parent_file_sha256

否

String

参数解释：

父文件hash，用于校验合并后的文件。

约束限制：

不涉及

取值范围：

1~10000。

默认取值：

不涉及。

task_id

否

String

参数解释：

上传任务的唯一标识，第一次上传分片时可不传。

约束限制：

不涉及

取值范围：

1~10000。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

Object

参数解释：

返回值。

取值范围：

不涉及。

status

String

参数解释：

请求响应的状态，表明请求是否成功。

取值范围：

  • success：请求响应成功。

  • error：请求响应失败。

状态码：201

Created

状态码：401

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

不涉及。

状态码：403

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

不涉及。

状态码：404

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

不涉及。

请求示例

文件上传归一化

POST https://{endpoint}/v1/fileservice/file/upload

响应示例

状态码：200

OK

{
  "result" : {
    "task_id" : "597a3fc9-a023-48fa-93bd-14386bf5936b"
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题：插件市场

相关文档