创建文件或文件夹。
接口说明
文件创建使用方法参考最佳实践:文件上传。
文件上传过程中,已上传的文件分片会产生存储费用。分片将保留 10 天,直到文件上传完成或 10 天后分片过期被清理。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /v2/file/create HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| domain_id |
string |
是 |
||
| body |
object |
否 |
请求体参数。 |
|
| name |
string |
是 |
文件名称,按照 utf8 编码最长 1024 字节,不能包含 / |
a.txt |
| type |
string |
是 |
文件类型,可选值如下: file:文件 folder:文件夹 |
file |
| parent_file_id |
string |
是 |
父目录 id,上传到根目录时填写 root |
fileid1 |
| drive_id |
string |
否 |
空间 id,除通过分享链接上传之外,必填 |
1 |
| share_id |
string |
否 |
分享 id,当通过分享链接上传时必填 |
7JQX1FswpQ8 |
| size |
integer |
否 |
文件大小,单位为 byte。 |
1024 |
| content_type |
string |
否 |
文件内容类型,默认值 application/oct-stream,常见的 content_type 可以参考 OSS 《如何设置 Content-Type(MIME)?》。 |
application/json |
| part_info_list |
array<object> |
否 |
分片信息列表,最多 10000 个分片,当不填时,默认返回 1 个分片 |
|
|
array<object> |
否 |
分片信息 |
||
| part_number |
integer |
否 |
分片序列号,从 1 开始 |
1 |
| parallel_sha1_ctx |
object |
否 |
该分片前所有数据的 SHA1 上下文,该字段只在多分片并发上传的模式下有效 |
|
| h |
array |
否 |
该分片前所有数据的 SHA1 上下文的第 1-5 个 32 位变量,该字段只在多分片并发上传的模式下有效 |
|
|
integer |
否 |
该分片前所有数据的 SHA1 上下文的第 1-5 个 32 位变量 |
1 |
|
| part_offset |
integer |
否 |
到上一个数据块为止的总长度,字节,需要为 64 的倍数,该字段只在多分片并发上传的模式下有效 |
10240 |
| content_md5 |
string |
否 |
分片的 MD5, 需要在上传分片时校验分片的 MD5 时填写。 |
ASKJDJSKDJJSJDJS |
| content_type |
string |
否 |
application/json |
|
| user_tags |
array |
否 |
用户自定义 tag,最多 1000 个 tag |
|
| UserTag |
否 |
用户自定义 tag |
||
| description |
string |
否 |
文件描述信息,最长 1024 字符,默认为空 |
团队文件 |
| content_hash |
string |
否 |
文件内容 hash 值,需要根据 content_hash_name 指定的算法计算 |
7C4A8D09CA3762AF61E59520943DC26494F8941B |
| content_hash_name |
string |
否 |
文件内容 hash 算法名,当前只支持 sha1 |
sha1 |
| pre_hash |
string |
否 |
使用预秒传功能时填写,为文件前 1KB sha1 值,当远端没有匹配上时,客户端无需再计算文件完整 sha1 去尝试秒传。 |
7C4A8D09CA3762AF61E59520943DC26494F89411 |
| check_name_mode |
string |
否 |
同名文件处理模式,可选值如下: ignore:允许同名文件; auto_rename:当发现同名文件是,云端自动重命名,默认为追加当前时间点,如 xxx _20060102_150405; refuse:当云端存在同名文件时,拒绝创建新文件,返回客户端已存在同名文件的详细信息。 默认为 ignore 枚举值:
|
ignore |
| file_id |
string |
否 |
文件 id,覆盖写时必填 |
9520943DC264 |
| local_created_at |
string |
否 |
文件本地创建时间,默认为空,格式为:yyyy-MM-ddTHH:mm:ssZ,采用 UTC +0 时区 |
2023-10-04T14:30:00Z |
| local_modified_at |
string |
否 |
文件本地修改时间,默认为空,格式为:yyyy-MM-ddTHH:mm:ssZ,采用 UTC +0 时区 |
2023-10-04T14:30:00Z |
| parallel_upload |
boolean |
否 |
是否开启并行上传分片功能 |
true |
| upload_type |
string |
否 |
multipart |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回信息 |
||
| parent_file_id |
string |
父目录 id |
fileid5 |
| part_info_list |
array |
分段信息列表 |
|
| UploadPartInfo |
分段信息 |
||
| upload_id |
string |
上传 id |
uploadid1 |
| rapid_upload |
boolean |
是否已经秒传 |
true |
| type |
string |
文件类型 |
file |
| file_id |
string |
文件 id |
fileid1 |
| domain_id |
string |
域 id |
bj1 |
| drive_id |
string |
空间 id |
1 |
| file_name |
string |
文件名 |
a.txt |
| status |
string |
文件状态 |
uploading |
| exist |
boolean |
文件是否存在 |
false |
示例
正常返回示例
JSON格式
{
"parent_file_id": "fileid5",
"part_info_list": [
{
"part_number": 1,
"part_size": 1024,
"upload_url": "https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661",
"internal_upload_url": "https://data-vpc.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661\n",
"etag": "\"0CC175B9C0F1B6A831C399E269772661\"",
"parallel_sha1_ctx": {
"h": [
0
],
"part_offset": 10240
},
"parallel_sha256_ctx": {
"h": [
0
],
"part_offset": 0
}
}
],
"upload_id": "uploadid1",
"rapid_upload": true,
"type": "file",
"file_id": "fileid1",
"domain_id": "bj1",
"drive_id": "1",
"file_name": "a.txt",
"status": "uploading",
"exist": false
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。