上传附件至obs
功能介绍
上传附件至obs
调用方法
请参见如何调用API。
URI
POST /v4/{project_id}/resources/temp-attachments
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
file |
否 |
File |
附件 |
|
override |
否 |
Boolean |
是否覆盖同名文件 |
|
parent_type |
否 |
String |
附件挂载资源类型 |
|
parent_uri |
否 |
String |
parentUri |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
success|error |
|
result |
ResultValueAttachmentFileVo object |
上传附件至obs返回数据 |
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
由接口调用方传入,建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
|
value |
AttachmentFileVo object |
附件Vo |
|
reason |
String |
业务失败的提示内容 |
|
page_size |
Integer |
分页大小 |
|
page_no |
Integer |
分页编码 |
|
has_more |
Boolean |
是否有更多 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
uri |
String |
附件Uri |
|
path |
String |
文件路径 |
|
project_id |
String |
项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
|
file_path |
String |
文件路径 |
|
file_type |
String |
文件类型 |
|
doc_name |
String |
文档名 |
|
store_name |
String |
保存文件名 |
|
doc_id |
Integer |
文档id |
|
doc_size |
String |
文档大小 |
|
related_type |
String |
相关类型 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
请求示例
post https://{endpoint}/v4/f3087a82b44744c29a1bd69ab6ada154/resources/temp-attachments
{
"file" : "a.txt",
"override" : true,
"parent_uri" : "231212421412"
}
响应示例
状态码:200
OK
{
"status" : "string",
"result" : {
"value" : {
"uri" : "15484131216515"
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。