文档

ApplyFileUploadLease - 申请文档上传租约

更新时间:
一键部署

该接口用于支持百炼数据中心-数据管理模块文档上传操作,用于申请一个文件上传租约(返回一个http链接),并将文件上传到百炼指定的存储空间内。

接口说明

该接口用于申请文档上传租约,接口返回一个上传文件的 http 链接,您可以通过返回的 http 链接以及相应的参数上传文件到百炼指定的存储空间内。需要注意的是,申请上传租约并上传文件后,文件只是会暂存在百炼的存储空间内,您需要进一步调用 AddFile 接口才可以真正将文件导入到百炼系统中。

特别说明 申请上传文件接口(即这里的 ApplyFileUploadLease 接口)调用成功后,返回的链接有效期为分钟级,请立即启动文件上传,否则可能因连接过期而无法上传。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /{WorkspaceId}/datacenter/category/{CategoryId}

请求参数

名称类型必填描述示例值
CategoryIdstring

类目 ID,取值请登录百炼(数据中心-数据管理)页面查看,允许传入“default”,即使用系统创建的"默认类目"。

cate_cdd11b1b79a74e8bbd675c356a91ee3510024405
FileNamestring

上传文件的完整名称,该名称会展示在百炼数据管理页面上。支持的文件类型:pdf、doc、docx、md、txt、ppt、pptx。 文件名称长度限制 4-128 个字符。

测试文件名.pdf
Md5string

文件 MD5 值,文件服务器会验证该字段,请正确填写。

19657c391f6c70bcea63c154d8606bb3
SizeInBytesstring

文件内容长度,单位字节,文件服务器会验证该字段,请正确填写。取值范围:1B-100M。

1000
WorkspaceIdstring

业务空间 id,请登录百炼后,在左上角业务空间详情中获取。

ws_3AXoiweeTyTd03IN

此接口调用成功后,后台颁发了 1 个最多不超 12 小时的启动文件解析租约(从申请上传、到启动文件解析接口之间),请在网络状况良好的环境上传文件后,并尽快调用 AddFile 将文件添加到系统中。否则会因为租约过期而失败。

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

每次请求的唯一 ID

778C0B3B-xxxx-5FC1-A947-36EDD13606AB
Successboolean

接口调用是否成功:

  • true:成功
  • false:失败
true
Messagestring

错误信息,有错误信息时返回该值。

User not authorized to operate on the specified resource
Codestring

错误状态码

DataCenter.FileTooLarge
Statusstring

接口返回的状态码

200
Dataobject

接口返回的业务字段。

FileUploadLeaseIdstring

租约唯一 ID,调用后续添加文件(AddFile)接口时,需要使用该参数

1e6a159107384782be5e45ac4759b247.1719325231035
Typestring

文件上传方式,可能取值如下(后续可能会扩充): OSS.PreSignedURL、HTTP

HTTP
Paramobject

用于上传文档的 HTTP 请求参数

Methodstring

HTTP 调用方法,字符串,包含 PUT、POST 等

PUT
Urlstring

文件上传 URL 地址,字符串

https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D
Headersany

需要放到 Header 中的 KV 字段,K 和 V 均为字符串

"X-bailian-extra": "MTAwNTQyNjQ5NTE2OTE3OA==", "Content-Type": "application/pdf"

示例

正常返回示例

JSON格式

{
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Success": true,
  "Message": "User not authorized to operate on the specified resource",
  "Code": "DataCenter.FileTooLarge",
  "Status": "200",
  "Data": {
    "FileUploadLeaseId": "1e6a159107384782be5e45ac4759b247.1719325231035",
    "Type": "HTTP",
    "Param": {
      "Method": "PUT",
      "Url": "https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D",
      "Headers": "        \"X-bailian-extra\": \"MTAwNTQyNjQ5NTE2OTE3OA==\",\n        \"Content-Type\": \"application/pdf\""
    }
  }
}

错误码

访问错误中心查看更多错误码。