文档

Batch - 批量调用API

更新时间:

支持批量调用部分API,提升调用效率。

调试

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

授权信息

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

请求语法

POST /v2/batch

请求参数

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

请求体参数。

resourcestring

请求的资源,支持的资源类型包括:

  • file(文件)
  • drive(个人/团队云盘)
  • user(用户)
  • group(群组)
  • membership(群组成员)
  • share_link(分享)
  • async_task(异步任务)
file
requestsobject []

子请求合集

子请求的数量,有效范围是[1,100]

idstring

子请求 id,用于 request 和 response 关联, 不允许重复

93433894994ad2e1
methodstring

子请求的方法,支持:

  • POST
  • GET
  • PUT
  • DELETE
  • HEAD
POST
urlstring

url 子请求的 api path 路径, 支持:

  • /file/get(获取文件详情)
  • /file/update(修改文件信息)
  • /file/search(搜索文件)
  • /file/copy(复制文件或文件夹)
  • /file/move(移动文件或文件夹)
  • /file/delete(删除文件或文件夹)
  • /file/get_download_url(获取文件下载地址)
  • /file/get_share_link_download_url(获取分享下载地址)
  • /recyclebin/trash(放入回收站)
  • /recyclebin/restore(恢复文件或文件夹)
  • /file/put_usertags(设置用户标签)
  • /file/delete_usertags(删除用户标签)
  • /drive/get(获取空间信息)
  • /user/get(获取用户信息)
  • /group/get(获取群组信息)
  • /share_link/create(创建分享)
  • /share_link/update(修改分享)
  • /share_link/cancel(取消分享)
  • /share_link/list(列举分享)
  • /share_link/get(获取分享信息)
  • /share_link/get_share_token(获取分享令牌)
  • /async_task/get(获取异步任务信息)
/file/get
bodyobject

子请求的请求参数 JSON 字符串,可参考相应子请求 API 文档

当指定了 body 必须传 headers:"Content-Type" 对应的类型,目前子请求入参是"application/json"

any

子请求的请求 body

{"domain_id":"1","drive_id":"1"}
headersobject

子请求的请求头,表示 body 传入数据的类型

string

子请求的请求 headers

{"Content-Type":"application/json"}

返回参数

名称类型描述示例值
object

Schema of Response

responsesobject []

子请求的响应合集

idstring

子请求 id,和 request 进行关联

93433894994ad2e1
statusinteger

子请求的返回状态码,可参考相应子请求 API 文档

200
bodyobject

子请求的响应结果,可参考相应子请求 API 文档

any

子请求的响应 body

{"domain_id":"1","drive_id":"1","file_id":"9520943DC264"}

示例

正常返回示例

JSON格式

{
  "responses": [
    {
      "id": "93433894994ad2e1",
      "status": 200,
      "body": {
        "key": "{\"domain_id\":\"1\",\"drive_id\":\"1\",\"file_id\":\"9520943DC264\"}"
      }
    }
  ]
}

错误码

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