Skip to content

🏞️ 图床

图床是一种传播图片的方式，它可以轻松的将图片嵌入到你的网站中

🛠️ 函数

创建目录

pan.oss.mkdir(name, parent_id)
  • name
    • 文件夹名
  • parent_id
    • 父目录id，上传到根目录时填写 0

重命名文件

pan.oss.rename(rename_dict)
  • rename_dict
    • 文件重命名字典，格式为 {文件ID: 新文件名}

移动文件

pan.oss.move(file_id_list, to_parent_file_id)
  • file_id_list
    • 要移动的文件ID列表
  • to_parent_file_id
    • 移动到的目标文件夹ID

删除文件

pan.oss.delete(file_ids)
  • file_ids
    • 要彻底删除的文件ID列表，文件必须在回收站中

获取文件详情

pan.oss.detail(file_id)
  • file_id
    • 要获取详情的文件ID

上传文件

一键上传（推荐）

pan.oss.upload(parent_file_id, file_path)
  • parent_file_id
    • 文件上传到哪个目录下
  • file_path
    • 要上传的文件的路径

手动上传

更多内容请参考123云盘开放文档

  1. 使用pan.oss.create(parent_file_id, filename, etag, size, duplicate)创建文件，接口返回的reuse为true时，表示秒传成功，上传结束。非秒传的情况将会返回预上传ID preuploadID 与分片大小 sliceSize,请将文件根据分片大小切分。
  2. 非秒传时，携带步骤1返回的preuploadID 与分片序号sliceNo，使用get_upload_url(preupload_id, slice_no)获取上传地址。
  3. 用PUT请求步骤2中返回的地址，上传文件分片。
    • (推荐操作)文件分片上传完成后，使用list_upload_parts(preupload_id)函数，在本地进行与云端的分片md5比对

      注:如果您的文件小于 sliceSize ,该操作将会返回空值,可以不进行这步操作。

  4. 校验完成后，使用upload_complete(preupload_id)函数，完成上传。
    • 根据步骤4返回的结果，判断是否需要使用upload_async_result(preupload_id)函数，获取上传的最终结果。该时间需要等待，123云盘服务器会校验用户预上传时的MD5与实际上传成功的MD5是否一致。

发起离线下载请求

方法已弃用 将在v0.1.7提示删除 v0.1.8彻底移除

oss.offline_download.download(download_url, file_name, save_path, call_back_url)
  • download_url
    • 需要下载的资源URL。示例："https://example.com/file.mp4"
  • file_name
    • 下载保存的文件名（可选）。示例："video.mp4"
  • save_path
    • 父文件夹（可选）
  • call_back_url
    • 下载完成后的回调通知地址（可选）。示例："https://example.com/callback"

查询离线下载进度

方法已弃用 将在v0.1.7提示删除 v0.1.8彻底移除

oss.offline_download.download_process(task_id)
  • task_id
    • 离线下载任务ID。示例："123456"

获取复制任务详情

pan.oss_source_copy.process(task_id)
  • task_id
    • 复制任务ID

获取复制失败文件列表

pan.oss_source_copy.fail(task_id, limit, page)
  • task_id
    • 失败任务ID
  • limit
    • 每页文件数量，最大不超过100
  • page
    • 当前页码。示例:1

创建复制任务

pan.oss_source_copy.copy(file_ids, to_parent_file_id, sourceType, type)
  • file_ids
    • 需要复制的文件ID列表。示例:["1", "2", "3", "4"]
  • to_parent_file_id
    • 要移动到的图床目标文件夹id，移动到根目录时为空
  • sourceType
    • 复制来源(1=云盘)
  • type
    • 业务类型，固定为 1