BaiduPCS-Go Documentation

Technical Documentation: qjfoidnh/BaiduPCS-Go

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

BaiduPCS-Go 百度网盘客户端(加强版)

仿 Linux shell 文件处理命令的百度网盘命令行客户端.

iikira/BaiduPCS-Go was largely inspired by GangZhuo/BaiduPCS and this project was largely based on iikira/BaiduPCS-Go

注意 Copy Chapter

此版本基于iikira原版BaiduPCS-Go v3.6.2继续开发, 并添加了转存功能.

本软件不提供超出官方客户端的下载提速, 普通用户和SVIP的配置建议参见 显示和修改程序配置项

目录 Copy Chapter

• 特色
• 版本更新
• 编译/交叉编译 说明
• 下载/运行 说明
  • 安装
  • Windows
  • Linux / macOS
  • Android / iOS
• 命令列表及说明
  • 注意 ! ! !
  • 检测程序更新
  • 登录百度帐号
  • 列出帐号列表
  • 获取当前帐号
  • 切换百度帐号
  • 退出百度帐号
  • 获取网盘配额
  • 切换工作目录
  • 输出工作目录
  • 列出目录
  • 列出目录树形图
  • 获取文件/目录的元信息
  • 搜索文件
  • 下载文件/目录
  • 上传文件/目录
  • 获取下载直链
  • 修复文件MD5
  • 创建目录
  • 删除文件/目录
  • 拷贝文件/目录
  • 移动/重命名文件/目录
  • 转存文件/目录
  • 分享文件/目录
    • 设置分享文件/目录
    • 列出已分享文件/目录
    • 取消分享文件/目录
  • 离线下载
    • 添加离线下载任务
    • 精确查询离线下载任务
    • 查询离线下载任务列表
    • 取消离线下载任务
    • 删除离线下载任务
  • 回收站
    • 列出回收站文件列表
    • 还原回收站文件或目录
    • 删除回收站文件或目录/清空回收站
  • 显示和修改程序配置项
  • 测试通配符
  • 工具箱
• 初级使用教程
  • 1. 查看程序使用说明
  • 2. 登录百度帐号 (必做)
  • 3. 切换网盘工作目录
  • 4. 网盘内列出文件和目录
  • 5. 下载文件
  • 6. 设置下载最大并发量
  • 7. 恢复默认配置
  • 8. 退出程序
• 已知问题
• TODO
• 交流反馈

特色

多平台支持, 支持 Windows, macOS, linux, 移动设备等.

百度帐号多用户支持;

通配符匹配网盘路径和 Tab 自动补齐命令和路径, 通配符_百度百科;

下载网盘内文件, 支持多个文件或目录下载, 支持断点续传和单文件并行下载;

上传本地文件, 支持上传最大128G大文件, 支持多个文件或目录上传;

转存其他用户分享的文件, 支持带密码的分享链接;

离线下载, 支持http/https/ftp/电驴/磁力链协议.

版本更新

2026.08.21 v4.0.2

• 修复转存误报STOKEN缺失
• feat: add --fs_id flag to transfer command to support granular file selection
• fix: 支持下载/查看对象数量超过1000的目录
• fix: remove quotes from cookie values to prevent invalid byte error
• 修复上传失败错误码仍为0
• 转存支持分享口令
• 上传链接复用优化

2026.03.26 v4.0.1

• 紧急修复ls等命令的param error

2025.10.29 v4.0.0

• 上传重新支持跳过秒传--norapid
• 上传同名文件覆盖策略--policy支持skip,overwrite,rsync; 支持config配置全局默认策略
• 因接口变化上传不再支持断点续传, 下载不受影响
• 增加config配置proxy_hostnames, 国外VPS用户如遇上传问题可尝试为pan.baidu.com配置回国代理
• 其他细节优化

2025.08.30 v3.9.9

• 最大上传单文件支持至128G
• 上传速度优化
• 下载取消文件预分配
• 因官方接口变动上传文件强制计算秒传
• transfer命令修复--download参数

2025.08.29 v3.9.8

• 全面修复了上传文件的问题
• 全面修复了下载文件的问题
• 去除部分已不可用的功能和已不支持的参数

2025.01.07 v3.9.7

• fix #359, #360
• fix #339

2024.12.14 v3.9.6

• 关闭秒传转存功能
• 修复常规转存失败

2023.09.30 v3.9.5

• 恢复秒传转存功能, 使用前需设置accessToken, 参见setastoken --help
• 本地文件上传用秒传无须accessToken
• fix #301
• fix #302

2023.09.06 v3.9.5-beta

• 恢复了秒传转存(支持长短链), 感谢油猴脚本开发者tousakarin的贡献
• 新秒传接口需要开发者授权, 稳定性未知, 该测试版本仅供有秒传强需求的用户试用, 请谨慎更新

2023.09.05 v3.9.4

• fix #244, 修复断点上传时偶发崩溃
• 优化本地上传秒传失败时的处理逻辑

2023.08.26 v3.9.3

• 因官方接口从原理层面封禁秒传, 取消秒传转存功能
• 更新部分使用说明
• 建议使用文件上传功能的用户更新此版本

2023.06.03 v3.9.2

• 修复秒传链接无法转存, 因官方接口变动秒传已不再支持短链接格式
• 修复上传文件无法使用秒传
• fix #254 支持-f参数输出带密码分享链接
• fix #251 根据mengzonefire同志提供函数增加md5解密

2023.03.19 v3.9.1

• 修复秒传转存返回错误码9019

2022.12.04 v3.9.0:

• 优化转存错误提示
• fix #239
• update go version to 1.18

2022.11.25 v3.8.9:

• fix #234, 继续修复无法转存文件

2022.11.12 v3.8.8:

• fix #234, 修复无法转存文件

2022.2.18 v3.8.7:

• fix #175, 在正式上传前即进行文件大小检测

2022.2.14 v3.8.6:

• fix #160 #173, 修复上传出现空文件的bug
• fix #165, 支持自带提取码的转存链接
• fix #175, upload增加-policy=rsync策略, 配合--norapid使用, 只跳过大小未发生改变的文件
• 鉴于 #172, 建议下载线程数最大不超过12

2022.1.1 v3.8.5:

该版本存在已知问题将导致上传文件失败及出现空文件，建议跳过更新

• 2022新年好, 本次更新增加较多特性, 欢迎测试
• fix #146, 提前fail和skip上传策略中重名文件的检测环节（存在问题）
• fix #158, config可配置关闭文件名合法性检测
• fix #141, download增加--mtime选项可保持文件修改时间
• fix #130, config可配置force_login_username, 强制登录指定用户名
• 首条下载链接不可用时自动切换, 增加下载成功率

2021.10.6 v3.8.4:

• fix 登录时可能出现内存溢出
• 上传文件名允许包含单引号

2021.8.27 v3.8.3:

• fix 更换默认panUA解决svip限速
• fix 移除失效的秒传修复功能
• 优化秒传逻辑, 提高成功率
• 优化秒传导出逻辑, 提高新文件的导出成功率

2021.7.20 v3.8.2:

• fix 读取大量文件信息容易超时
• fix 秒传链接文件名带"#"时解析错误
• share list增加分享下载数显示
• config增加配置: 上传的同名文件处理策略

2021.6.9 v3.8.1:

• fix 部分旧链接无法转存
• 增加上传同名文件自动跳过选项

2021.5.21 v3.8.0:

• fix 上传到100M左右自动回滚（待测试）
• fix 个别正常的秒传链接无法转存
• fix 文件名含有百分号导出异常
• 优化上传重试策略（待测试）

2021.4.14 v3.7.9:

• fix 上传时异常退出导致无法加载断点信息
• fix 上传偶发出现0B/s卡住
• 上传时预先检查文件名合法性
• 在线更新使用镜像源加速

2021.3.20 v3.7.8:

• 优化了上传的输出信息格式
• 优化了上传逻辑，提升上传速度
• transfer增加--fix参数，可转存被屏蔽的秒传链接（inspired by dupan-rapid-extract）

2021.3.11 v3.7.7:

• fix 移动和重命名文件时末尾/导致报错
• fix 3.7.2版本后在线升级无效
• fix 转存误报缺少STOKEN

2021.2.23 v3.7.6:

• fix 下载文件报x509: certificate is valid错误
• 完善了下载错误的捕获种类
• download增加--fullpath参数，本地目录保留网盘从根目录开始的完整结构

2021.2.8 v3.7.5:

• fix 某些时候误报stoken缺失
• fix windows平台上秒传链接转存失败
• fix 某些时候pcs请求缺少Host
• 当分享链接包含多文件/目录时，可选归档到第一个文件命名的目录里（不支持秒传）

2021.1.31 v3.7.4:

• fix 下载目录会丢失目录结构
• fix 分享列表状态信息显示错误
• 支持自定义文件上传服务器

2021.1.22 v3.7.3:

• 分享支持自定义分享码和有效天数
• 转存支持转存完毕后自动下载到默认目录
• 增加恢复默认配置功能
• tree命令支持指定输出最大层数和带fsid输出

2021.1.9 v3.7.2:

• 基本修复了登录验证失效问题(#15)
• 优化下载模块的实现策略, 保证稳定性同时进一步提升下载速度 (需按显示和修改程序配置项中建议修改)
• update 功能恢复, 以后可以在线升级了
• 支持导出秒传链接不写文件, 直接输出到控制台; 支持通用秒传格式导出, 具体参见export --help
• 其他bug修正

2021.1.2 v3.7.1:

• 支持了多文件并发上传，文件并发数和单文件分片数可在配置中指定
• 修复了最大同时下载文件数配置不生效的问题
• 修正了部分显示和帮助的错误

2020.12.19 v3.7.0:

• 替换了iikira版本的失效仓库
• 转存功能支持旧的短链接
• 默认关闭下载文件校验，配置文件可设置开启
• 修复了关闭校验时会误报下载失败的问题
• 转存功能除了cookies方式登录，现已支持用户名密码登录和bduss登录；bduss登录需同时指定stoken

2020.11.08 v3.6.3:

• 修复转存失败
• 修复分享文件失败

编译/交叉编译 说明

设置好 GOOS 和 GOARCH 环境变量,

运行 go tool dist list 查看所有支持的 GOOS/GOARCH

Linux/Darwin 例子: 编译 Windows 下的 64 位程序 Copy Chapter

GOOS=windows GOARCH=amd64 CGO_ENABLED=0 go build

Windows 例子: 编译 Linux 下的 32 位程序 Copy Chapter

set GOOS=linux
set GOARCH=386
set CGO_ENABLED=0
go build

下载/运行 说明

Go语言程序, 常用几种平台的已编译程序可直接在蓝奏云下载使用. 密码:4pix

如果程序运行时输出乱码, 请检查下终端的编码方式是否为 UTF-8.

使用本程序之前, 建议学习一些 linux 基础知识 和 基础命令.

如果未带任何参数运行程序, 程序将会进入仿Linux shell系统用户界面的cli交互模式, 可直接运行相关命令.

cli交互模式下, 光标所在行的前缀应为 BaiduPCS-Go >, 如果登录了百度帐号则格式为 BaiduPCS-Go:<工作目录> <百度ID>$

程序会提供相关命令的使用说明.

安装 Copy Chapter

Windows Copy Chapter

程序应在 命令提示符 (Command Prompt) 或 PowerShell 中运行, 在 mintty (例如: GitBash) 可能会有显示问题.

也可直接双击程序运行, 具体使用方法请参见 命令列表及说明 和 初级使用教程.

Linux / macOS Copy Chapter

程序应在 终端 (Terminal) 运行.

具体使用方法请参见 命令列表及说明 和 初级使用教程.

Android / iOS Copy Chapter

Android / iOS 移动设备操作比较麻烦, 不建议在移动设备上使用本程序. 移动设备不可直接使用预编译的Linux arm64版本, 使用者需下载源码自行交叉编译.

安卓, 建议使用 Termux 或 NeoTerm 或 终端模拟器, 以提供终端环境.

示例: Android 运行本项目程序参考示例, 有兴趣的可以参考一下.

苹果iOS, 需要越狱, 在 Cydia 搜索下载并安装 MobileTerminal, 或者其他提供终端环境的软件.

示例: iOS 运行本项目程序参考示例, 有兴趣的可以参考一下.

具体使用方法请参见 命令列表及说明 和 初级使用教程.

命令列表及说明

注意 ! ! ! Copy Chapter

命令的前缀 BaiduPCS-Go 为指向程序运行的全路径名 (ARGv 的第一个参数)

直接运行程序时, 未带任何其他参数, 则程序进入cli交互模式, 运行以下命令时, 要把命令的前缀 BaiduPCS-Go 去掉!

cli交互模式已支持按tab键自动补全命令和路径.

检测程序更新 Copy Chapter

BaiduPCS-Go update

登录百度帐号 Copy Chapter

常规登录百度帐号 Copy Section

支持在线验证绑定的手机号或邮箱,
注: 此方式已长期不维护, 建议使用其他登录方式

BaiduPCS-Go login

使用百度 BDUSS 和 百度网盘 STOKEN 来登录百度账号 Copy Section

关于 获取百度 BDUSS STOKEN 获取方式与 BDUSS 基本相同。注意 STOKEN 必须在百度网盘页面获取，否则无效.
STOKEN是cookie中的一个字段, 注意不是bdstoken, 如果拿到的STOKEN里没有大写字母多半是拿错了

BaiduPCS-Go login -bduss=<BDUSS> -stoken=<STOKEN>

使用百度 Cookies 来登录百度账号(推荐) Copy Section

关于 获取百度 Cookies
教程中为百度经验的Cookies获取, 这里换成百度网盘首页即可.

BaiduPCS-Go login -cookies=<Cookies>

例子

BaiduPCS-Go login -bduss=1234567 -stoken=234567

BaiduPCS-Go login # 交互式login已不再维护，不推荐使用
请输入百度用户名(手机号/邮箱/用户名), 回车键提交 > 1234567

BaiduPCS-Go login -cookies="BAIDUID=50949C0890YG9735EA6Q3870AFE38:FG=1; BIDUPSID=112335C0ACCAFFJW675EA69A870AFE38; PSTM=1981928511; BDORZ=D6745EBF6F3SW24E515D22A1598; PANWEB=1; BDUSS=ASAYUGFHSTFKGBGSU; STOKEN=gfsdge9gisfgspig34254d7879eee5756b10sgeyrw5vyw342td510ffc9414d32251; SCRC=cwrywec5evyetra26bvvehefvfg6a8; BDCLND=C%4sfgGysrZ%2BML6; PANPSC=wreyewygdfhdggedhsdfg4353"

列出帐号列表 Copy Chapter

BaiduPCS-Go loglist

列出所有已登录的百度帐号

获取当前帐号 Copy Chapter

BaiduPCS-Go who

切换百度帐号 Copy Chapter

切换已登录的百度帐号

BaiduPCS-Go su <uid>

BaiduPCS-Go su

请输入要切换帐号的 # 值 >

退出百度帐号 Copy Chapter

退出当前登录的百度帐号

BaiduPCS-Go logout

程序会进一步确认退出帐号, 防止误操作.

获取网盘配额 Copy Chapter

BaiduPCS-Go quota

获取网盘的总储存空间, 和已使用的储存空间

切换工作目录 Copy Chapter

BaiduPCS-Go cd <目录>

切换工作目录后自动列出工作目录下的文件和目录 Copy Section

BaiduPCS-Go cd -l <目录>

例子

# 切换 /我的资源 工作目录
BaiduPCS-Go cd /我的资源

# 切换 上级目录
BaiduPCS-Go cd ..

# 切换 根目录
BaiduPCS-Go cd /

# 切换 /我的资源 工作目录, 并自动列出 /我的资源 下的文件和目录
BaiduPCS-Go cd -l 我的资源

# 使用通配符
BaiduPCS-Go cd /我的*

输出工作目录 Copy Chapter

BaiduPCS-Go pwd

列出目录 Copy Chapter

列出当前工作目录的文件和目录或指定目录

BaiduPCS-Go ls

BaiduPCS-Go ls <目录>

可选参数 Copy Section

-asc: 升序排序
-desc: 降序排序
-time: 根据时间排序
-name: 根据文件名排序
-size: 根据大小排序

例子

# 列出 我的资源 内的文件和目录
BaiduPCS-Go ls 我的资源

# 绝对路径
BaiduPCS-Go ls /我的资源

# 降序排序
BaiduPCS-Go ls -desc 我的资源

# 按文件大小降序排序
BaiduPCS-Go ls -size -desc 我的资源

# 使用通配符
BaiduPCS-Go ls /我的*

列出目录树形图 Copy Chapter

列出当前工作目录的文件和目录或指定目录的树形图

BaiduPCS-Go tree <目录>

# 默认获取工作目录元信息
BaiduPCS-Go tree

获取文件/目录的元信息 Copy Chapter

BaiduPCS-Go meta <文件/目录1> <文件/目录2> <文件/目录3> ...

# 默认获取工作目录元信息
BaiduPCS-Go meta

例子

BaiduPCS-Go meta 我的资源
BaiduPCS-Go meta /

搜索文件 Copy Chapter

按文件名搜索文件（不支持查找目录）。

默认在当前工作目录搜索.

BaiduPCS-Go search [-path=<需要检索的目录>] [-r] <关键字>

例子

# 搜索根目录的文件
BaiduPCS-Go search -path=/ 关键字

# 搜索当前工作目录的文件
BaiduPCS-Go search 关键字

# 递归搜索当前工作目录的文件
BaiduPCS-Go search -r 关键字

下载文件/目录 Copy Chapter

BaiduPCS-Go download <网盘文件或目录的路径1> <文件或目录2> <文件或目录3> ...
BaiduPCS-Go d <网盘文件或目录的路径1> <文件或目录2> <文件或目录3> ...

可选参数 Copy Section

--test          测试下载, 此操作不会保存文件到本地
  --ow            overwrite, 覆盖已存在的文件
  --status        输出所有线程的工作状态
  --save          将下载的文件直接保存到当前工作目录
  --saveto value  将下载的文件直接保存到指定的目录
  -x              为文件加上执行权限, (windows系统无效)
  --mode value    下载模式, 可选值: pcs, stream, locate, 默认为 locate, 相关说明见上面的帮助 (default: "locate")
  -p value        指定下载线程数 (default: 0)
  -l value        指定同时进行下载文件的数量 (default: 0)
  --retry value   下载失败最大重试次数 (default: 3)
  --nocheck       下载文件完成后不校验文件

下载的文件默认保存到 程序所在目录 的 download/ 目录, 支持设置指定目录, 重名的文件会自动跳过!

下载的文件默认保存到, 程序所在目录的 download/ 目录.

通过 BaiduPCS-Go config set -savedir <savedir>, 自定义保存的目录.

支持多个文件或目录下载.

自动跳过下载重名的文件!

例子

# 设置保存目录, 保存到 D:\Downloads
# 注意区别反斜杠 "\" 和 斜杠 "/" !!!
BaiduPCS-Go config set -savedir D:/Downloads

# 下载 /我的资源/1.mp4
BaiduPCS-Go d /我的资源/1.mp4

# 下载 /我的资源 整个目录!!
BaiduPCS-Go d /我的资源

# 下载网盘内的全部文件!!
BaiduPCS-Go d /
BaiduPCS-Go d *

上传文件/目录 Copy Chapter

BaiduPCS-Go upload <本地文件/目录的路径1> <文件/目录2> <文件/目录3> ... <目标目录>
BaiduPCS-Go u <本地文件/目录的路径1> <文件/目录2> <文件/目录3> ... <目标目录>

• 上传默认采用分片上传的方式, 上传的文件将会保存到, <目标目录>. 不支持断点续传

• 遇到同名文件会自动跳过, 也可配置upload_policy选择覆盖或者只跳过同大小文件

• 当上传的文件名和网盘的目录名称相同时, 不会覆盖目录, 防止丢失数据.

• 所有上传均默认检测秒传, 可添加参数--norapid跳过

例子:

# 将本地的 C:\Users\Administrator\Desktop\1.mp4 上传到网盘 /视频 目录
# 注意区别反斜杠 "\" 和 斜杠 "/" !!!
BaiduPCS-Go upload C:/Users/Administrator/Desktop/1.mp4 /视频

# 将本地的 C:\Users\Administrator\Desktop\1.mp4 上传到网盘 /视频 目录, 不检测秒传
BaiduPCS-Go upload C:/Users/Administrator/Desktop/1.mp4 /视频 --norapid

# 将本地的 C:\Users\Administrator\Desktop\1.mp4 和 C:\Users\Administrator\Desktop\2.mp4 上传到网盘 /视频 目录
BaiduPCS-Go upload C:/Users/Administrator/Desktop/1.mp4 C:/Users/Administrator/Desktop/2.mp4 /视频

# 将本地的 C:\Users\Administrator\Desktop 整个目录上传到网盘 /视频 目录, 只覆盖与本地大小不同的同名文件
BaiduPCS-Go upload C:/Users/Administrator/Desktop /视频 --policy rsync

获取下载直链 Copy Chapter

BaiduPCS-Go locate <文件1> <文件2> ...

例子:

BaiduPCS-Go config set -user_agent "netdisk;2.2.51.6;netdisk;10.0.63;PC;android-android"

导出文件/目录 Copy Chapter

BaiduPCS-Go export <文件/目录1> <文件/目录2> ...

BaiduPCS-Go ep <文件/目录1> <文件/目录2> ...

导出网盘内的文件或目录, 原理为秒传文件, 此操作会生成导出文件或目录的命令.

注意

秒传已不被支持, 该功能已无实际作用

例子:

# 导出当前工作目录:

BaiduPCS-Go export

# 导出所有文件和目录, 并设置新的根目录为 /root

BaiduPCS-Go export -root=/root /

# 导出 /我的资源

BaiduPCS-Go export /我的资源

# 导出 /我的资源 格式为通用秒传链接格式

BaiduPCS-Go export /我的资源 --link

创建目录 Copy Chapter

BaiduPCS-Go mkdir <目录>

例子

BaiduPCS-Go mkdir 123

删除文件/目录 Copy Chapter

BaiduPCS-Go rm <网盘文件或目录的路径1> <文件或目录2> <文件或目录3> ...

注意: 删除多个文件和目录时, 请确保每一个文件和目录都存在, 否则删除操作会失败.

被删除的文件或目录可在网盘文件回收站找回.

例子

# 删除 /我的资源/1.mp4
BaiduPCS-Go rm /我的资源/1.mp4

# 删除 /我的资源/1.mp4 和 /我的资源/2.mp4
BaiduPCS-Go rm /我的资源/1.mp4 /我的资源/2.mp4

# 删除 /我的资源 内的所有文件和目录, 但不删除该目录
BaiduPCS-Go rm /我的资源/*

# 删除 /我的资源 整个目录 !!
BaiduPCS-Go rm /我的资源

拷贝文件/目录 Copy Chapter

BaiduPCS-Go cp <文件/目录> <目标 文件/目录>
BaiduPCS-Go cp <文件/目录1> <文件/目录2> <文件/目录3> ... <目标目录>

注意: 拷贝多个文件和目录时, 请确保每一个文件和目录都存在, 否则拷贝操作会失败.

例子

# 将 /我的资源/1.mp4 复制到 根目录 /
BaiduPCS-Go cp /我的资源/1.mp4 /

# 将 /我的资源/1.mp4 和 /我的资源/2.mp4 复制到 根目录 /
BaiduPCS-Go cp /我的资源/1.mp4 /我的资源/2.mp4 /

移动/重命名文件/目录 Copy Chapter

# 移动:
BaiduPCS-Go mv <文件/目录1> <文件/目录2> <文件/目录3> ... <目标目录>
# 重命名:
BaiduPCS-Go mv <文件/目录> <重命名的文件/目录>

注意: 移动多个文件和目录时, 请确保每一个文件和目录都存在, 否则移动操作会失败.

例子

# 将 /我的资源/1.mp4 移动到 根目录 /
BaiduPCS-Go mv /我的资源/1.mp4 /

# 将 /我的资源/1.mp4 重命名为 /我的资源/3.mp4
BaiduPCS-Go mv /我的资源/1.mp4 /我的资源/3.mp4

转存文件/目录 Copy Chapter

# 转存分享链接里的文件到当前目录:
BaiduPCS-Go transfer <分享链接> <提取码>

注意: 转存文件保存到当前工作目录下, 不支持指定.

例子

# 将 https://pan.baidu.com/s/12L_ZZVNxz5f_2CccoyyVrW (提取码edv4) 转存到当前目录
BaiduPCS-Go transfer https://pan.baidu.com/s/12L_ZZVNxz5f_2CccoyyVrW edv4
BaiduPCS-Go transfer https://pan.baidu.com/s/12L_ZZVNxz5f_2CccoyyVrW?pwd=edv4

分享文件/目录 Copy Chapter

BaiduPCS-Go share

设置分享文件/目录 Copy Section

BaiduPCS-Go share set <文件/目录1> <文件/目录2> ...
BaiduPCS-Go share s <文件/目录1> <文件/目录2> ...

列出已分享文件/目录 Copy Section

BaiduPCS-Go share list
BaiduPCS-Go share l

取消分享文件/目录 Copy Section

BaiduPCS-Go share cancel <shareid_1> <shareid_2> ...
BaiduPCS-Go share c <shareid_1> <shareid_2> ...

目前只支持通过分享id (shareid) 来取消分享.

离线下载 Copy Chapter

BaiduPCS-Go offlinedl
BaiduPCS-Go clouddl
BaiduPCS-Go od

离线下载支持http/https/ftp/电驴/磁力链协议

离线下载同时进行的任务数量有限, 超出限制的部分将无法添加.

添加离线下载任务 Copy Section

BaiduPCS-Go offlinedl add -path=<离线下载文件保存的路径> 资源地址1 地址2 ...

添加任务成功之后, 返回离线下载的任务ID.

精确查询离线下载任务 Copy Section

BaiduPCS-Go offlinedl query 任务ID1 任务ID2 ...

查询离线下载任务列表 Copy Section

BaiduPCS-Go offlinedl list

取消离线下载任务 Copy Section

BaiduPCS-Go offlinedl cancel 任务ID1 任务ID2 ...

删除离线下载任务 Copy Section

BaiduPCS-Go offlinedl delete 任务ID1 任务ID2 ...

# 清空离线下载任务记录, 程序不会进行二次确认, 谨慎操作!!!
BaiduPCS-Go offlinedl delete -all

例子

# 将百度和腾讯主页, 离线下载到根目录 /
BaiduPCS-Go offlinedl add -path=/ http://baidu.com http://qq.com

# 添加磁力链接任务
BaiduPCS-Go offlinedl add magnet:?xt=urn:btih:xxx

# 查询任务ID为 12345 的离线下载任务状态
BaiduPCS-Go offlinedl query 12345

# 取消任务ID为 12345 的离线下载任务
BaiduPCS-Go offlinedl cancel 12345

回收站 Copy Chapter

BaiduPCS-Go recycle

回收站操作.

列出回收站文件列表 Copy Section

BaiduPCS-Go recycle list

可选参数

--page value  回收站文件列表页数 (default: 1)

还原回收站文件或目录 Copy Section

BaiduPCS-Go recycle restore <fs_id 1> <fs_id 2> <fs_id 3> ...

根据文件/目录的 fs_id, 还原回收站指定的文件或目录.

删除回收站文件或目录/清空回收站 Copy Section

BaiduPCS-Go recycle delete [-all] <fs_id 1> <fs_id 2> <fs_id 3> ...

根据文件/目录的 fs_id 或 -all 参数, 删除回收站指定的文件或目录或清空回收站.

例子

# 从回收站还原两个文件, 其中的两个文件的 fs_id 分别为 1013792297798440 和 643596340463870
BaiduPCS-Go recycle restore 1013792297798440 643596340463870

# 从回收站删除两个文件, 其中的两个文件的 fs_id 分别为 1013792297798440 和 643596340463870
BaiduPCS-Go recycle delete 1013792297798440 643596340463870

# 清空回收站, 程序不会进行二次确认, 谨慎操作!!!
BaiduPCS-Go recycle delete -all

显示程序环境变量 Copy Chapter

BaiduPCS-Go env

BAIDUPCS_GO_CONFIG_DIR: 配置文件路径,

BAIDUPCS_GO_VERBOSE: 是否启用调试.

显示和修改程序配置项 Copy Chapter

# 显示配置
BaiduPCS-Go config

# 设置配置
BaiduPCS-Go config set

注意: v3.5 以后, 程序对配置文件储存路径的寻找做了调整, 配置文件所在的目录可以是程序本身所在目录, 也可以是家目录.

配置文件所在的目录为家目录的情况:

Windows: %APPDATA%\BaiduPCS-Go

其他操作系统: $HOME/.config/BaiduPCS-Go

可通过设置环境变量 BAIDUPCS_GO_CONFIG_DIR, 指定配置文件存放的目录.

谨慎修改 appid, user_agent, pcs_ua, pan_ua 的值, 否则访问网盘服务器时, 可能会出现错误.

如上传遇到异常可尝试修改 pcs_addr, 目前已知的地址有:

pcs.baidu.com
c.pcs.baidu.com
c2.pcs.baidu.com
c3.pcs.baidu.com
c4.pcs.baidu.com
c5.pcs.baidu.com
d.pcs.baidu.com

v3.9.8后上传时支持动态获取pcs服务器, 理论上不需要手动配置. 如希望使用静态pcs服务器, 可配置打开fix_pcs_addr

cache_size 的值支持可选设置单位了, 单位不区分大小写, b 和 B 均表示字节的意思, 如 64KB, 1MB, 32kb, 65536b, 65536.

max_download_rate, max_upload_rate 的值支持可选设置单位了, 单位为每秒的传输速率, 后缀/s 可省略, 如 2MB/s, 2MB, 2m, 2mb 均为一个意思.

普通用户请将max_parallel和max_download_load都设置为1, 调大线程数只会在短时间内提升下载速度, 且极易很快触发限速, 导致几小时至几天内账号在各客户端都接近0速. 本软件不支持普通用户提速.

SVIP用户建议max_parallel设置为10以上, 根据实际带宽可调大, 但不建议超过20, max_download_load设置为1 - 2, 实验表明可以稳定满速下载.

例子

# 显示所有可以设置的值
BaiduPCS-Go config -h
BaiduPCS-Go config set -h

# 设置下载文件的储存目录
BaiduPCS-Go config set -savedir D:/Downloads

# 设置下载最大并发量为 15
BaiduPCS-Go config set -max_parallel 15

# 组合设置
BaiduPCS-Go config set -max_parallel 150 -savedir D:/Downloads

测试通配符 Copy Chapter

BaiduPCS-Go match <通配符表达式>

测试通配符匹配路径, 操作成功则输出所有匹配到的路径.

例子

# 匹配 /我的资源 目录下所有mp4格式的文件
BaiduPCS-Go match /我的资源/*.mp4

工具箱 Copy Chapter

BaiduPCS-Go tool

目前工具箱支持加解密文件等.

初级使用教程

新手建议: 双击运行程序, 进入仿 Linux shell 的 cli 交互模式;

cli交互模式下, 光标所在行的前缀应为 BaiduPCS-Go >, 如果登录了百度帐号则格式为 BaiduPCS-Go:<工作目录> <百度ID>$

以下例子的命令, 均为 cli交互模式下的命令

运行命令的正确操作: 输入命令, 按一下回车键 (键盘上的 Enter 键), 程序会接收到命令并输出结果

1. 查看程序使用说明 Copy Chapter

cli交互模式下, 运行命令 help

2. 登录百度帐号 (必做) Copy Chapter

cli交互模式下, 运行命令 login -h (注意空格) 查看帮助

cli交互模式下, 运行命令 login 程序将会提示你输入百度用户名(手机号/邮箱/用户名)和密码, 必要时还可以在线验证绑定的手机号或邮箱

3. 切换网盘工作目录 Copy Chapter

cli交互模式下, 运行命令 cd /我的资源 将工作目录切换为 /我的资源 (前提: 该目录存在于网盘)

目录支持通配符匹配, 所以你也可以这样: 运行命令 cd /我的* 或 cd /我的?? 将工作目录切换为 /我的资源, 简化输入.

将工作目录切换为 /我的资源 成功后, 运行命令 cd .. 切换上级目录, 即将工作目录切换为 /

为什么要这样设计呢, 举个例子,

假设 你要下载 /我的资源 内名为 1.mp4 和 2.mp4 两个文件, 而未切换工作目录, 你需要依次运行以下命令:

d /我的资源/1.mp4
d /我的资源/2.mp4

而切换网盘工作目录之后, 依次运行以下命令:

cd /我的资源
d 1.mp4
d 2.mp4

这样就达到了简化输入的目的

4. 网盘内列出文件和目录 Copy Chapter

cli交互模式下, 运行命令 ls -h (注意空格) 查看帮助

cli交互模式下, 运行命令 ls 来列出当前所在目录的文件和目录

cli交互模式下, 运行命令 ls /我的资源 来列出 /我的资源 内的文件和目录

cli交互模式下, 运行命令 ls .. 来列出当前所在目录的上级目录的文件和目录

5. 下载文件 Copy Chapter

说明: 下载的文件默认保存到 download/ 目录 (文件夹)

cli交互模式下, 运行命令 d -h (注意空格) 查看帮助

cli交互模式下, 运行命令 d /我的资源/1.mp4 来下载位于 /我的资源/1.mp4 的文件 1.mp4 , 该操作等效于运行以下命令:

cd /我的资源
d 1.mp4

现在已经支持目录 (文件夹) 下载, 所以, 运行以下命令, 会下载 /我的资源 内的所有文件 (违规文件除外):

d /我的资源

6. 设置下载最大并发量 Copy Chapter

cli交互模式下, 运行命令 config set -h (注意空格) 查看设置帮助以及可供设置的值

cli交互模式下, 运行命令 config set -max_parallel 2 将下载最大并发量设置为 2

注意：普通用户下载最大并发量的值超过1将导致账号被限速; SVIP同样不宜设置过高, 建议10~20

7. 恢复默认配置 Copy Chapter

cli交互模式下, 运行命令 config reset

8. 退出程序 Copy Chapter

运行命令 quit 或 exit 或 组合键 Ctrl+C 或 组合键 Ctrl+D

已知问题

• 分片上传文件时, 当文件分片数大于1, 网盘端最终计算所得的md5值和本地的不一致, 这可能是百度网盘的bug, 测试把上传的文件下载到本地后，对比md5值是匹配的. 可通过秒传的原理来修复md5值.
• 开启MD5校验下载时可能有 check MD5 不通过, 但文件其实并未出错的情况, 使用--no-check下载或配置中启用no_check即可(3.7版本默认已启用).
• 用户名登录时图片验证码至少要输入两次, 第一次的输入无效
• 登录出现手机/邮箱验证时要输入至少4次图片验证码

TODO

• 转存文件数量绕过单次限制

交流反馈

提交Issue: Issues

Overview (`docs/README.md`) Copy Section

文档目录

百度PCS文档 Copy Chapter

文件API Copy Section

综述

文件API列表

文件API错误码列表

结构化数据API Copy Section

综述

结构化数据API列表

结构化数据API错误码

Overview (`docs/overview.md`) Copy Section

概述

百度开放云平台为广大开发者提供了访问PCS资源的系列接口，目前开放的接口主要分两个部分：

• 文件API:

  主要提供文件上传、下载、拷贝、删除、搜索、断点续传及缩略图等功能。

• 结构化数据API:

  主要提供结构数据存储、查询、删除及同步等功能。

通过对这些API的组合调用，开发者可以实现基本的用户文件操作以及结构数据存储和管理功能，也能够支持用户数据在多种不同终端上的同步，以提供更优质的用户体验。

除了原生的REST（Representational State Transfer，即“表述性状态转移”） API之外，百度开放云平台还提供了多种平台的SDK来帮助开发者缩短开发周期，具体请参考“SDK”部分相关内容。

PCS REST API使用说明 Copy Chapter

开通PCS API权限 Copy Section

PCS所有REST API都必须经过开通权限才能正常使用。申请的方法请参考“开通PCS API权限”部分相关内容。

注意：PCS未提供分享接口，download等接口仅供个人获取数据使用。 access_token不能泄露，否则会直接封禁应用。

API请求方式说明 Copy Section

目前所有的提交类接口仅支持POST方式，查询类接口同时支持POST方式和GET方式。

PCS REST API的所有参数在传入时应当使用：UTF-8编码。

HTTP 请求方式

GET | POST

URL

https://pcs.baidu.com/rest/2.0/pcs/{object_name}?{query_string}

参数说明

HTTP GET和POST方式使用说明

method 及 access token 等参数必须携带在 query_string 中进行传输，请参考各个API的具体说明；
                        
                         携带在 query_string 中的参数的值，必须进行 UrlEncode 编码；
                        
                         携带在 HTTP Body 中的参数，则不需要进行 UrlEncode 编码。
                        
                    
                
            
            
                注
                HTTP URL 长度有限，若参数值长度过长，建议将参数放在 HTTP Body 中进行传输。 |

| HTTP BODY | 不携带HTTP Body | multipart/form-data |
| 注意 | 如果 HTTP Body 和 query_string 存在相同的参数，则以 query_string 中的参数为准。 | |

使用示例

1. GET请求：

   用HTTP GET请求方式发送两个参数：key1=value1和key2=value2。

   https://pcs.baidu.com/rest/2.0/pcs/quota?key1=UrlEncode(value1)&key2=UrlEncode(value2)

2. POST请求：

   分别用两种方式使用POST方式发送三个参数：key1=value1、key2=value2和key3=value3；方式一与方式二效果等同。

方式一：

POST /rest/2.0/pcs/quota?key2=value2&key3=value3 HTTP/1.1

User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/1.2.1.2 libidn/0.5.6
Pragma: no-cache
Accept: */*
Host:pcs.baidu.com
Content-Length:123
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryS0JIa4uHF7yHd8xJ
------WebKitFormBoundaryS0JIa4uHF7yHd8xJ
Content-Disposition: form-data; name="key1"
value1
------WebKitFormBoundaryS0JIa4uHF7yHd8xJ—

方式二：

POST /rest/2.0/pcs/quota HTTP/1.1
User-Agent: curl/7.12.1 (x86_64-redhat-linux-gnu) libcurl/7.12.1 OpenSSL/0.9.7a zlib/1.2.1.2 libidn/0.5.6
Pragma: no-cache
Accept: */*
Host:pcs.baidu.com
Content-Length:123
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryS0JIa4uHF7yHd8xJ
------WebKitFormBoundaryS0JIa4uHF7yHd8xJ
Content-Disposition: form-data; name="key1"

value1
------WebKitFormBoundaryS0JIa4uHF7yHd8xJ
Content-Disposition: form-data; name="key2"

value2
------WebKitFormBoundaryS0JIa4uHF7yHd8xJ
Content-Disposition: form-data; name="key3"

value3
------WebKitFormBoundaryS0JIa4uHF7yHd8xJ--

API响应格式说明 Copy Section

- error_code：错误码；
                
                - error_msg: 错误描述信息；
                
                - request_id: 请求ID。由server生成，用于追查和定位请求日志。 |

Structured Data Apis Overview (`docs/structured_data_apis_overview.md`) Copy Section

结构化数据API说明

结构化数据API简要说明 Copy Chapter

结构化数据API包括table操作API和record操作API。

• Table操作API：

是由开发者在使用结构化数据API开发应用时调用，包括创建、修改、删除、查看表信息及恢复表等接口；

• Record操作API：

即数据操作API，是由最终用户在使用基于PCS结构化数据API开发的应用时触发，第三方应用通过使用用户身份（以Access Token认证）在服务器端对用户数据进行增加、删除、修改、查询等系列操作。

结构化数据基本概念 Copy Chapter

1. 表（table）

结构化数据以表为单位组织用户数据；表名和表中的索引由开发者定义。

2. 表名（tablename）

表的名字。表名可以由字母和下划线组成（a-z，A-Z，0-9，'_'）, 长度为3-63个字符，必须字母开头；同一个应用中，不能重复使用同一表名。

3. 记录（record）

每一条结构化数据就是一个记录，一个表中可有多条记录。

4. 列（column）

结构中的每一个字段就是一列。列名可以由字母和下划线组成（a-z，A-Z，0-9，'_'）, 长度为1-255个字符，必须字母开头。

5. 索引（index）

在表中的某些列上创建索引，可以提高查询速度。一个表中，最多可以定义5个索引，只能定义普通索引。

6. 限额（quota）

同一个表中同一个用户最多多少条数据，现在每个用户最多10000条数据。

结构化数据功能列表 Copy Chapter

使用PCS结构化数据功能，可以轻松的完成应用上结构化数据的存储及同步等功能。

PCS结构化数据具有如下的特性：

• 提供Restful API；

• 数据灵活性大：定义表时，不需要完全确定表中的所有列，可以增加一列或减少一列而无需重新定义表。

• 在数据上动态增减索引：定义表时，无需完全确定所有的索引；

• 数据多端同步：结构化数据提供接口，支持数据多端同步；

• 对数据进行增加、删除、修改及查询；

• 回收站：数据删除后，10天内可以还原；

• 支持应用数据隔离：不同应用的数据可以支持物理隔离；

• 支持超大数据量：

  • 一个应用可以创建5个表；
  • 单个表没有数据总量限制；
  • 单个表中，单个用户的数据量可以达到1万条；
  • 用户数无限制。

结构化数据存储限制 Copy Chapter

（1）全局限制： Copy Section

每个记录的大小限制为1MB （服务器端会把记录做json_encode, 得到的大小为记录大小）；

每个应用最多只能创建5个表；

批量的insert/update/delete/restore每次最多500条；

批量的select每次最多返回10000条记录。

（2）表级别限制（quota）： Copy Section

应用上的用户在表里的条目数限制（创建表的时候，每个表都有一个default_quota，以后用户在该表上都使用此default_quota，单个用户的quota可以通过quota接口设置）。

Record操作API说明 Copy Chapter

（1） insert、update、delete默认都支持批量操作，但是每次批量的record个数不能超过500； Copy Section

（2） 数据操作API对用户需要保持最终一致性，即： Copy Section

insert、update、delete操作不保证返回后即可select 出来，通常延迟小于1s；

update、delete操作不支持条件操作，即where子句的操作，如有需要请先select出来。

字段说明 Copy Chapter

字段定义 Copy Section

PCS结构化数据平台中，表中的字段支持如下类型：

说明：

字段名必须符合以下标准:

可以是a-z、A-Z、0-9、'_'；

长度范围是[1, 255]；

必须字母开头。

默认字段 Copy Section

插入的记录将会有以下默认字段：

File Data Apis Error (`docs/file_data_apis_error.md`) Copy Section

文件数据API错误码

File Data Apis List (`docs/file_data_apis_list.md`) Copy Section

文件API列表

更新通知： Copy Chapter

• 2013.6.20 上传、下载新域名正式上线使用，相关接口“上传单个文件”、“分片上传-文件分片上传”、“下载单个文件”及“下载流式文件”相关接口信息更新

• 2013.3.20 去除API权限申请开通相关说明，开发者可通过“管理中心”自行开启。

• 2013.3.1 新增“回收站功能”，新增“还原单个文件或目录”、“还原多个文件或目录”、“获取回收站文件或目录列表”及“清空回收站”等接口

基本功能 Copy Chapter

空间配额信息 Copy Section

功能

获取当前用户空间配额信息。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/quota

请求参数

返回参数

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/quota?method=info&access_token=1.54be391000a16ee6a21791d4a8ea04fe.86400.1331206383.67272939-188383

响应示例

{
    "quota":15000000000,
    "used":5221166,
    "request_id":4043312634
}

上传单个文件 Copy Section

功能

上传单个文件。
百度PCS服务目前支持最大2G的单个文件上传。
如需支持超大文件（>2G）的断点续传，请参考下面的“分片文件上传”方法。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=upload&path=%2fapps%2falbum%2f1.JPG&access_token=b778fb598c717c0ad7ea8c97c8f3a46f

响应示例

{
　    "path" : "/apps/album/1.jpg",
　    "size" : 372121,
　    "ctime" : 1234567890,
　    "mtime" : 1234567890,
　    "md5" : "cb123afcc12453543ef",
　    "fs_id" : 12345,
    　"request_id":4043312669
}

分片上传—文件分片及上传 Copy Section

功能

百度PCS服务支持每次直接上传最大2G的单个文件。
如需支持上传超大文件（>2G），则可以通过组合调用分片文件上传的upload方法和createsuperfile方法实现：
首先，将超大文件分割为2G以内的单文件，并调用upload将分片文件依次上传；
其次，调用createsuperfile，完成分片文件的重组。
除此之外，如果应用中需要支持断点续传的功能，也可以通过分片上传文件并调用createsuperfile接口的方式实现。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=upload&access_token=1.54bef000f2416ee4a41791d4a8ea04fe.86400.1331206383.67272939-188383&type=tmpfile

响应示例

{
    "md5":"a7619410bca74850f985e488c9a0d51e",
    "request_id":3238563823
}

分片上传—合并分片文件 Copy Section

功能

与分片文件上传的upload方法配合使用，可实现超大文件（>2G）上传，同时也可用于断点续传的场景。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/file?method=createsuperfile&path=%2fapps%2fyunform%2f6ddddd.JPG&access_token=1.9fb09e8cce44c0d000e6787138924a26.86400.1331273905.2600617452-188383

响应示例

{
    "path":"/apps/yunform/6ddddd.JPG",
    "size":6844,
    "ctime":1331197101,
    "mtime":1331197101,
    "md5":"baa7c379639b74e9bf98c807498e1b64",
    "fs_id":1548308694,
    "request_id":4043313276
}

下载单个文件 Copy Section

功能

下载单个文件。
Download接口支持HTTP协议标准range定义，通过指定range的取值可以实现断点下载功能。 例如：
如果在request消息中指定“Range: bytes=0-99”，那么响应消息中会返回该文件的前100个字节的内容；继续指定“Range: bytes=100-199”，那么响应消息中会返回该文件的第二个100字节内容。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

无

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/file?method=download&access_token=3.d9000194f4b5d2da3fe8b6f850ace082.2592000.1348645419.2233553628-248414&path=%2Fapps%2F%E6%B5%8B%E8%AF%95%E5%BA%94%E7%94%A8%2F%2F01.jpg

响应示例

文件内容

创建目录 Copy Section

功能

为当前用户创建一个目录。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=mkdir&access_token=1.54bef000f2416ee4a41791d4a8ea04fe.86400.1331206383.67272939-188383&path=%2Fapps%2Fyunform%2Fmusic

响应示例

{
    "fs_id":1636599174,
    "path":"/apps/yunfom/music",
    "ctime":1331183814,
    "mtime":1331183814,
    "request_id":4043312656
}

获取单个文件/目录的元信息 Copy Section

功能

获取单个文件或目录的元信息。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/file?method=meta&access_token=1.5400f91df2416ee4a41791d4a8ea04fe.86400.1331206383.67272939-188383&path=%2Fapps%2Fyunform%2Fmusic%2Fhello

响应示例

{
    "list": [{
        "fs_id": 3528850315,
        "path": "/apps/yunform/music/hello",
        "ctime": 1331184269,
        "mtime": 1331184269,
        "block_list": ["59ca0efa9f5633cb0371bbc0355478d8"],
        "size": 13,
        "isdir": 1
    }],
    "request_id": 4043312678
}

批量获取文件/目录的元信息 Copy Section

功能

批量获取文件或目录的元信息。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=meta&access_token=1.54b0091ee2416ee4a41791d4a8ea04fe.86400.1331206383.67272939-188383

响应示例

{
    "list": [{
            "fs_id": 3528850315,
            "path": "/apps/album/a/b/c",
            "ctime": 1331184269,
            "mtime": 1331184269,
            "block_list": ["59ca0efa9f5633cb0371bbc0355478d8"],
            "size": 13,
            "isdir": 0
        },
        {
            "fs_id": 3528850320,
            "path": "/apps/album/a/b/d",
            "ctime": 1331184269,
            "mtime": 1331184269,
            "block_list": ["59ca0efa9f5633cb0371bbc0355478d8"],
            "size": 13,
            "isdir": 0
        }
    ],
    "request_id": 4043312678
}

获取目录下的文件列表 Copy Section

功能

获取目录下的文件列表。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/file?method=list&access_token=1.54bef91002416ee4a41791d4a8ea04fe.86400.1331206383.67272939-188383&path=%2Fapps%2Fyunform%2Fhello

响应示例

{
    "list": [{
        "fs_id": 3528850315,
        "path": "/apps/yunform/music/hello",
        "ctime": 1331184269,
        "mtime": 1331184269,
        "block_list": ["59ca0efa9f5633cb0371bbc0355478d8"],
        "size": 13,
        "isdir": 0
    }],
    "request_id": 4043312670
}

移动单个文件/目录 Copy Section

功能

移动单个文件/目录。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

如果move操作执行成功，那么response会返回执行成功的from/to列表。

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=move&from=%2fapps%2f pcstest_oauth%2f test1%2fyyyytestwer.jpg&to=%2fapps%2fpcstest_oauth%2ftest2%2f2.jpg&access_token=b778fb598c717c0ad7ea8c97c8f3a46f

响应示例

{
    "extra": {
        "list": [{
            "to": "/apps/pcstest_oauth/test2/2.jpg",
            "from": "/apps/pcstest_oauth/test1/yyyytestwer.jpg"
        }]
    },
    "request_id": 2298812844
}

批量移动文件/目录 Copy Section

功能

批量移动文件/目录。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

返回参数extra由list数组组成，list数组的两个元素分别是“from”和“to”，代表move操作的源地址和目的地址。

注意

调用move接口时，目标文件的名称如果和源文件不相同，将会在move操作时对文件进行重命名。

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=move&from=%2fapps%2f pcstest_oauth%2f test1%2fyyyytestwer.jpg&to=%2fapps%2fpcstest_oauth%2ftest2%2f2.jpg&access_token=b778fb598c717c0ad7ea8c97c8f3a46f

响应示例

{
    "extra": {
        "list": [{
            "to": "/apps/pcstest_oauth/test2/2.jpg",
            "from": "/apps/pcstest_oauth/test1/yyyytestwer.jpg"
        }]
    },
    "request_id": 2298812844
}

拷贝单个文件/目录 Copy Section

功能

拷贝文件(目录)。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

如果copy操作执行成功，那么response会返回执行成功的from/to列表。

注意

move操作后，源文件被移动至目标地址；copy操作则会保留原文件。

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=copy&from=%2fapps%2fpcstest_oauth%2f test1%2f6.jpg&to=%2fapps%2fpcstest_oauth%2ftest2%2f6.jpg&access_token=b700fb598c717c0ad7ea8c97c8f3a46f

响应示例

{
    "extra": {
        "list": [{
            "to": "/apps/pcstest_oauth/test2/6.jpg",
            "from": "/apps/pcstest_oauth/test1/6.jpg"
        }]
    },
    "request_id": 2298812844
}

批量拷贝文件/目录 Copy Section

功能

批量拷贝文件/目录。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

返回参数extra由list数组组成，list数组的两个元素分别是“from”和“to”，代表copy操作的源地址和目的地址。

注意

执行批量copy操作时，param参数通过HTTP Body传递；
批量执行copy操作时，copy接口一次对请求参数中的每个from/to进行操作；执行失败就会退出，成功就继续，返回执行成功的from/to列表。

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=copy&access_token=b778fb008c717c0ad7ea8c97c8f3a46f

响应示例

{
    "extra": {
        "list": [{
                "to": "/apps/pcstest_oauth/test1/6.jpg",
                "from": "/apps/pcstest_oauth/test2/6.jpg"
            },
            {
                "to": "/apps/pcstest_oauth/test2/89.jpg",
                "from": "/apps/pcstest_oauth/89.jpg"
            }
        ]
    },
    "request_id": 2166619191
}

删除单个文件/目录 Copy Section

功能

删除单个文件/目录。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

无

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=delete&access_token=1.54bef91002416ee4a41791d4a8ea04fe.86400.1331206383.67272939-188383&path=%2Fapps%2Fyunform%2Fmusic

响应示例

{
    "request_id": 4043312866
}

批量删除文件/目录 Copy Section

功能

批量删除文件/目录。
注意：
* 文件/目录删除后默认临时存放在回收站内，删除文件或目录的临时存放不占用用户的空间配额；
* 存放有效期为10天，10天内可还原回原路径下，10天后则永久删除。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

无

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=delete&access_token=1.54bef91002416ee4a41791d400ea04fe.86400.1331206383.67272939-188383

响应示例

{
    "request_id": 4043312865
}

搜索 Copy Section

功能

按文件名搜索文件（不支持查找目录）。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/file?method=search&access_token=1.54bee00df241eee4a41791d4a8ea04fe.86400.1331206383.67272939-188383&path=%2Fapps%2Fyunform%2Fmusic&wd=hello&re=1

响应示例

{
    "list": [{
        "fs_id": 3528850315,
        "path": "/apps/yunform/music/hello",
        "ctime": 1331184269,
        "mtime": 1331184269,
        "block_list": ["59ca0efa9f5633cb0371bbc0355478d8"],
        "size": 13,
        "isdir": 0
    }],
    "request_id": 4043312670
}

高级功能 Copy Chapter

缩略图 Copy Section

功能

获取指定图片文件的缩略图。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/thumbnail

请求参数

返回参数

无

注意

有以下限制条件：
* 原图大小(0, 10M]；
* 原图类型: jpg、jpeg、bmp、gif、png；
* 目标图类型:和原图的类型有关；例如：原图是gif图片，则缩略后也为gif图片。

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/thumbnail?method=generate&path=%2Fapps%2Fpcstest_oauth%2FSunset.jpg&quality=100&width=1600&height=1600

响应示例

缩略图文件内容

增量更新查询 Copy Section

功能

文件增量更新操作查询接口。本接口有数秒延迟，但保证返回结果为最终一致。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

*First time: cursor=null
GET https://pcs.baidu.com/rest/2.0/pcs/file?method=diff&access_token=1.54bef91df2416ee4a41791d4a8ea04fe.86400.1331206383.67272939-188383&cursor=null

*Next every time: cursor={cursor from last response}
GET https://pcs.baidu.com/rest/2.0/pcs/file?method=diff&access_token=1.54bef91df2416ee4a41791d4a8ea04fe.86400.1331206383.67272939-188383&cursor=MxKx6UPi3w2Jt%2B%2BktMKKQpBbnC%2B11aH7Ec9pt%2BfteS%2F%2BknWrp3JIz%2F6fXHccEkZo2kkkSH748hScdRgcA4VCZJuCMQMvNkXAlSmzT5TwqBVc3xwhSxaFkClqbcogAOc8I0k7xtTb9nG6rBJsxNgRFgBV4F695TkrLDHYHRy%2BQ%3D%3D

响应示例

{
    "entries": {
        "\/baiduapp\/browser": {
            "fs_id": 2427025269,
            "path": "\/baiduapp\/browser",
            "size": 0,
            "isdir": 1,
            "md5": "",
            "mtime": 1336631762,
            "ctime": 1336631762
        }
    },
    "has_more": true,
    "reset": true,
    "cursor": "MxKx6UPie/9WzBkwALPrVWQlyxlmK0LgHG8zutwXp8oyC/ngIdGgS3w2Jt++ktMKKQpBbnC+11aH7Ec9pt+fteS/+knWrp3JIz/6fXHccEkZo2kkkSH748hScdRgcA4VCZJuCMQMvNkXAlSmzT5TwqBVc3xwhSxaFkClqbcogAOc8I0k7xtTb9nG6rBJsxNgRFgBV4F695TkrLDHYHRy+Q==",
    "request_id": 3355443548
}

视频转码 Copy Section

功能

对视频文件进行转码，实现实时观看视频功能。 可下载支持HLS/M3U8的[媒体云播放器SDK](http://developer.baidu.com/wiki/index.php?title=docs/cplat/media/sdk)配合使用。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

注意

目前这个接口支持的源文件格式如下：

返回参数

无

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/file?method=streaming&path=%2fapps%2fvideo%2fv1.mov&access_token=b778fb000c717c0ad7ea8c97c8f3a46f&type=MP4_480P

响应示例

直接返回文件内容

获取流式文件列表 Copy Section

功能

以视频、音频、图片及文档四种类型的视图获取所创建应用程序下的文件列表。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/stream

请求参数

返回参数

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/stream?method=list&type=image&start=50&limit=100&access_token=b778fb000c717c0ad7ea8c97c8f3a46f

响应示例

{
    "total": 13,
    "start": 0,
    "limit": 1,
    "list": [{
        "path": "/apps/album/1.jpg",
        "size": 372121,
        "ctime": 1234567890,
        "mtime": 1234567890,
        "md5": "cb123afcc12453543ef",
        "fs_id": 12345,
        "isdir": 0
    }]
}

下载流式文件 Copy Section

功能

为当前用户下载一个流式文件。其参数和返回结果与下载单个文件的相同。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/stream

注意

1. 兼容原有域名pcs.baidu.com；使用新域名d.pcs.baidu.com，则提供更快、更稳定的下载服务。
2. 需注意处理好 302 跳转问题。

请求参数

返回参数

无

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/stream?method=download&access_token=b778fb000c717c0ad7ea8c97c8f3a46f&path=%2fapps%2falbum%2f1.jpg

响应示例

流式文件内容

秒传文件 Copy Section

功能

秒传一个文件。
注意：
* 被秒传文件必须大于256KB（即 256*1024 B）。
* 校验段为文件的前256KB，秒传接口需要提供校验段的MD5。(非强一致接口，上传后请等待1秒后再读取)

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=rapidupload&access_token=b778fb000c717c0ad7ea8c97c8f3a46f&content-length=1542719&content-md5=3edf3d47292280e0182db6750bd176e5&slice-md5=6fce289cfee3e4414788dcd000a3ddc4&path=%2fa%2fb%2fc

响应示例

{
    "path": "/apps/album/1.jpg",
    "size": 372121,
    "ctime": 1234567890,
    "mtime": 1234567890,
    "md5": "cb123afcc12453543ef",
    "fs_id": 12345,
    "isdir": 0,
    "request_id": 12314124
}

添加离线下载任务 Copy Section

功能

添加离线下载任务，实现单个文件离线下载。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/services/cloud_dl

请求参数

返回参数

任务ID号

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/service/cloud_dl?method=add_task&access_token=40001fsdjfdjskaf&source_url=http:\/\/dl_dir.qq.com:80\/qqfile\/qq\/QQ2012\/QQ2012.exe

响应示例

任务ID号成功：
{"task_id":432432432432432,"request_id":3372220525}
任务并发太大：
{"error_code":36013,"error_msg":"too many tasks","request_id":3372220539}

精确查询离线下载任务 Copy Section

功能

根据任务ID号，查询离线下载任务信息及进度信息。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/service/cloud_dl

请求参数

返回参数

无

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/services/cloud_dl?method=query_task&access_token=43000fsdjfdjskaf

Body示例

查询任务信息：
{
“request_id”:12394838223,
“task_info”:
{
    “123456” : {
        "result" : 0, //0查询成功，结果有效，1要查询的task_id不存在
        "source_url":"http://www.example.com/xxx.zip",//下载数据源地址
        "save_path":"http://xxxx/",//下载完成后的存放地址
        "rate_limit":10,
        "timeout": 3600,
        "callback":"http://XXX",
        "status":1 (0下载成功，1下载进行中 2系统错误，3资源不存在，4下载超时，5资源存在但下载失败 6存储空间不足 7目标地址数据已存在 8任务取消)
        "create_time":"UNIX_TIMESTAMP",//任务创建时间
}
“43829483”:
{
"result" : 1, //要查询的task_id不存在
}
}
}
查询进度信息：
{
“request_id”:12394838223,
“task_info”:
{
    “123456” : {
        "result" : 0, //0查询成功，结果有效，1要查询的task_id不存在
        "status": (0下载成功，1下载进行中 2系统错误，3资源不存在，4下载超时，5资源存在但下载失败 6存储空间不足 7任务取消)
        //其余字段，在status为0、1时有效
        "file_size":1024
        "finished_size":512
        "create_time": 123232132,
        "start_time": 43728943,
        "finish_time": 43728948,
    }
“43829483”:
{
"result" : 1, //要查询的task_id不存在
}
}
}

响应示例

任务信息或进度信息

查询离线下载任务列表 Copy Section

功能

查询离线下载任务ID列表及任务信息。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/services/cloud_dl

请求参数

返回参数

任务信息或任务列表

示例

请求示例

查询离线下载任务ID列表
POST https://pcs.baidu.com/rest/2.0/pcs/services/cloud_dl?method=list_task&access_token=43000fsdjfdjskaf&need_task_info=1

响应示例

任务列表
{"task_info":[{"task_id":"26"}],"total":"1","request_id":1283164486}
任务信息
{"task_info":[{"task_id":"26","source_url":"http:\/\/dl_dir.qq.com:80\/qqfile\/qq\/QQ2012\/QQ2012.exe","save_path":"\/apps\/Slideshow\/wu_jing_test0","rate_limit":"100","timeout":"10000","callback":"http:\/\/www.baidu.com","status":"1","create_time":"1347449048"}],"total":"1","request_id":1285732167}

取消离线下载任务 Copy Section

功能

取消离线下载任务。

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/services/cloud_dl

请求参数

返回参数

任务信息或任务列表

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/services/cloud_dl?method=cancel_task&access_token=43000fsdjfdjskaf&task_id=26

响应示例

{
    “request_id”:12394838223,
}

回收站 Copy Section

功能

回收站用于临时存放删除文件，且不占空间配额；但回收站的文件存放具有10天有效期，删除文件默认扔到回收站，10天内可通过回收站找回，逾期永久删除。

回收站功能，目前支持以下几种操作和接口：

* 删除文件到回收站： delete
（目前默认是删除到回收站），API详细说明请参考“删除单个文件或目录”及“批量删除文件或目录”部分
* 查看回收站文件： listrecycle
* 还原回收站文件（单个文件或多个文件）： restore
* 清空回收站：delete

查询回收站文件 Copy Section

功能

获取回收站中的文件及目录列表。

HTTP请求方式

GET

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

获取成功，返回回收站文件或目录列表信息

list数组中的元素说明如下：

获取失败，则返回错误信息

示例

请求示例

GET https://pcs.baidu.com/rest/2.0/pcs/file?method=listrecycle&start=50&limit=100&access_token=111f1118c717111a8111c8f3a46f

响应示例

获取成功: 
{
"list":[
{
"fs_id":1579174,
"path":"\/apps\/CloudDriveDemo\/testfile-10.rar",
"ctime":1361934614,
"mtime":1361934625,
"md5":"1131170ac11cfbec411a5e8d4e111769",
"size":10730431,
"isdir":0
},
{
"fs_id":304521061,
"path":"\/apps\/CloudDriveDemo\/testfile-4.rar",
"ctime":1361934605,
"mtime":1361934625,
"md5":"9552bf5e5abdf962e2de94be243bec7c",
"size":4287611,
"isdir":0
}
],
"request_id":3779302504
}
获取失败: 
{"error_code":110,"error_msg":"Access token invalid or no longer valid","request_id":1444638699}

还原单个文件或目录 Copy Section

功能

还原单个文件或目录（非强一致接口，调用后请sleep 1秒读取）

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

还原成功时，返回以下参数

还原失败，则返回错误信息

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=restore&fs_id=123456&access_token=111f1118c717111a8111c8f3a46f

响应示例

还原成功
{"extra":{"list":[{"fs_id":"1356099017"}]},"request_id":3775323016}
还原失败
{"error_code":31061,"error_msg":"file already exists","request_id":811204199}

批量还原文件或目录 Copy Section

功能

批量还原文件或目录（非强一致接口，调用后请sleep1秒 ）

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

说明：
* 全部还原成功的情况下，返回extra及request_id信息；
* 还原多个文件或目录时，如果还原某个文件或目录失败，则报错并终止还原操作，返回error_code、error_msg、extra及request_id信息；
    * 其中，如果未成功还原任何文件时，返回的extra中的list数组为空；
    * 部分文件或目录还原成功时，则返回的extra中list数组中显示该部分文件的fs_id。

示例

请求示例

POST  https://pcs.baidu.com/rest/2.0/pcs/file?method=restore&access_token=111f1118c717111a8111c8f3a46f.2592000.1364548100.3123371436-248414&param={"list":[{"fs_id":"4059450057"},{"fs_id":"2959141864"}]}

响应示例

全部还原成功
{"extra":{"list":[{"fs_id":"2959141864"}],"request_id":1359873129}
全部还原失败
{"error_code":31061,"error_msg":"file already exists","extra":{"list":[]},"request_id":1342759216}
部分还原成功
{"error_code":31061,"error_msg":"file already exists","extra":{"list":[{"fs_id":"2959141864"}]},"request_id":1359873129}

清空回收站 Copy Section

功能

清空回收站

HTTP请求方式

POST

URL

https://pcs.baidu.com/rest/2.0/pcs/file

请求参数

返回参数

清空成功，返回请求ID

清空失败，则返回错误信息

示例

请求示例

POST https://pcs.baidu.com/rest/2.0/pcs/file?method=delete&type=recycle&access_token=111f1118c717111a8111c8f3a46f

响应示例

清空成功
{"request_id":2307473052}
清空失败
{"error_code":31070,"error_msg":"file delete failed","request_id":12345678}

Structured Data Api List (`docs/structured_data_api_list.md`) Copy Section

结构化数据API列表

更新通知： Copy Chapter

2013.7.2 修改“创建table”接口，请求参数增加“sk”

创建table Copy Chapter

功能 Copy Section

创建一个表，定义索引，其中包括对唯一索引的支持。

注意：

• 一个应用最多创建5个表，一个表上最多创建5个索引；

• 关于表和索引的创建规则，您可以参考“结构化数据表基本概念”；

• 为保证一致性，创建表后，可能需要等待一段时间才能用describe table接口查看到；

• 创建一张表必须带有该表所属app的密匙sk，用于之后的psstoken鉴权使用。

关于“唯一索引”的说明：

• 可以建联合的唯一索引；

• 一个table上唯一索引数量同一般索引限制，5个；

• 唯一索引不支持在表创建后在增加，所以需要在表设计的时候尽量考虑；（如确实需要，可联系我们。）

• insert的时候必须带上唯一索引的所有字段，否则会失败。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/table

请求参数 Copy Section

• 1：表示升序索引

• -1：表示降序索引 |

返回参数

示例 Copy Section

请求示例:

1. 创建一般索引

$ cat > ./artists_create_table <<DELIM
{
"table" : "artists",
"column" :
{
"id" :
{
"description" : "",
"type" : "int",
"required" : true
}
},
"index":
{
"id_index" :
{
"column" : {"id" : 1}
}
}
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/table?method=create&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347&sk=cRgk8uMGX098yMfmttoVYswcv3XKBLGX" -F "param=<artists_create_table"

2. 创建唯一索引

$ cat > ./artists_create_table <<DELIM
{
"table" : "artists",
"column" :
{
"id" :
{
"description" : "",
"type" : "int",
"required" : true
}
},
"index":
{
"id_index" :
{
"column" : {"id" : 1},
"unique" : true
}
}
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/table?method=create&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347&sk=cRgk8uMGX098yMfmttoVYswcv3XKBLGX " -F "param=<artists_create_table"

注意 Copy Section

unique字段为true，表示唯一索引；为false，则表示一般索引；不指定则默认为一般索引。

正确响应示例：HTTP/1.1 200 OK
 
{
"app_id" : 1,
"table" : "artists",
"request_id" : 3728395580
}
出错响应示例：HTTP/1.1 400 Bad Request
 
{
"error_code" : 31472,
"error_msg" : "table already exist",
"request_id" : 9085631045
}

修改table Copy Chapter

功能 Copy Section

修改一个表，添加或者删除索引

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/table

请求参数 Copy Section

返回参数 Copy Section

• 1：表示升序索引；

• -1：表示降序索引。 |

示例 Copy Section

请求示例: $ cat > ./artists_alter_table <<DELIM
{
"table" : "artists",
"add_index" :
{
"direction" :
{
"column" : {"direction" : 1}
}
},
"drop_index":
{
"id_index" :
{
"column" : {"id" : 1}
}
}
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/table?method=alter&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=<artists_alter_table"
 
正确响应示例：HTTP/1.1 200 OK
 
{
"app_id" : 1,
"table" : "artists",
"lastindex" :
{
"direction" :
{
"column" :
{
"direction" : 1
}
}
},
"request_id" : 6402295586
}
出错响应示例：HTTP/1.1 400 Bad Request
 
{
"error_code" : 31409,
"error_msg" : "table not exist",
"request_id" : 9360693908
}

删除table Copy Chapter

功能 Copy Section

删除一个table

注意 Copy Section

如果drop到回收站（默认情况），则drop后该表处于不可访问状态，不能再创建同名的table。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/table

请求参数 Copy Section

返回参数

示例 Copy Section

请求示例: $ cat > ./artists_drop_table <<DELIM
{
"table" : "artists"
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/table?method=drop&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=<artists_drop_table"
正确响应示例：HTTP/1.1 200 OK
 
{
"app_id" : 1,
"table" : "artists",
"request_id" : 3728395580
}
 
</pre>
出错响应示例：<javascript>HTTP/1.1 400 Bad Request
 
{
"error_code" : 31409,
"error_msg" : "table not exist",
"request_id" : 9085631045
}

从回收站恢复table Copy Chapter

功能 Copy Section

恢复一个在回收站中的表。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/table

请求参数 Copy Section

返回参数

示例 Copy Section

请求示例: $ cat > ./artists_restore_table <<DELIM
{
"table" : "artists"
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/table?method=restore&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=<artists_restore_table"
 
正确响应示例：HTTP/1.1 200 OK
{
"app_id" : 1,
"table" : "artists",
"request_id" : 3728395580
}
出错响应示例：HTTP/1.1 400 Bad Request
{
"error_code" : 31474,
"error_msg" : "table not drop, cannot restore",
"request_id" : 9085631045
}

查看table创建信息 Copy Chapter

功能 Copy Section

查看一个表的创建信息。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/table

请求参数 Copy Section

返回参数

示例 Copy Section

请求示例: $ cat > ./artists_describe_table <<DELIM
{
"table" : "artists"
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/table?method=describe&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=<artists_describe_table"
正确响应示例：HTTP/1.1 200 OK
{
"appid" : 1,
"table" : "artists008",
"status" : 0,
"ctime" : 1347417209,
"mtime" : 1347417209,
"cluster" : "cluster0",
"subtablenum" : 1,
"column" :
{
"id" :
{
"description" : "",
"type" : "number",
"required" : true
}
},
"index":
{
"id_index" :
{
"column" : {"id" : 1}
}
},
"quota" : 10000,
"auth_code" : "e3725dd9a7cbd0a5e3eb7928ab922d33",
"request_id" : 2707788940
}
出错响应示例：HTTP/1.1 400 Bad Request
 
{
"error_code" : 31409,
"error_msg" : "table not exist",
"request_id" : 5574355722
}

添加record Copy Chapter

功能 Copy Section

新增record，每次调用都会新增传入的record。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

请求参数 Copy Section

返回参数

示例 Copy Section

请求示例:
cat > ./artists_insert_request <<DELIM
{
"table":"artists",
"records": [
{
"id": 85617,
"name": "刘德华",
"type": "男歌手",
"intro": "香港著名歌手、演员",
"add_time": 1340949289,
"language": ["国语", "粤语"],
"tags": ["香港电影金像奖", "四大天王", "东亚唱片"],
"top_song": {
"id": 3,
"name": "爱你一万年"
}
},
{
"id": 85618,
"name": "凤凰传奇",
"type": "组合",
"intro": "中国大陆具有广泛知名度的男女二人音乐组合",
"add_time": 1340949289,
"language": ["国语"],
"tags": ["月亮之上", "最炫民族风"],
"top_song": {
"id": 5,
"name": "月亮之上"
}
}
]
}
DELIM
 
$ curl -v -X POST "http://pcs.baidu.com/rest/2.0/structure/data?method=insert&access_token=2.b06c3e86610fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=<artists_select1_request"
正确响应示例：HTTP/1.1 200 OK
 
{
"records":[
{
"_key":"f44603de003c57d5-1346066442",
"_mtime":1346066442,
"_ctime":1346066442
},
{
"_key":"1aaef0010c012db7-1346066442",
"_mtime":1346066442,
"_ctime":1346066442
}
],
"request_id":3728395580
}
出错响应示例：HTTP/1.1 400 Bad Request
 
{
"error_code":31430,
"error_msg":"bad record",
"request_id":0
"records": [
{"_key": "7d4febca4a68e763-1344915172"},
]
}

更新record Copy Chapter

功能 Copy Section

根据_key更新record；支持批量更新，但只能更新非回收站的record。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

请求参数 Copy Section

| 参数名称 | 类型 | 是否

必需 | 描述 |
| --- | --- | --- | --- |
| v | string | 否 | 版本号，默认为“1.0”。 |
| method | string | 是 | 固定值：update。 |
| access_token | string | 是 | 用户的access_token，HTTPS调用时必须使用。 |
| table | string | 是 | 要更新的目标表名。 |
| records | json array | 是 | 需要更新的record。 |
| op | string | 否 | * 当值为“merge”时，请求中record不带的column，保持旧值（默认值）；

• 当值为“replace”时，参数中传的record将全量替换整个旧的record。 |

说明：

其中records是一个数组，其数组成员结构如下：

返回参数

示例 Copy Section

请求示例: $ cat > ./artists_update_request <<DELIM
{
"table":"artists",
"records": [
{
"record":
{
"_key":"f44603de003c57d5-1346066442",
"id": 85617,
"name": "刘德华",
"type": "男歌手",
"intro": "香港著名歌手、演员",
"add_time": 1340949289,
"language": ["国语", "粤语"],
"tags": ["香港电影金像奖", "四大天王", "东亚唱片"]
},
"if-match": 1346066442
},
{
"record":
{
"_key":"1aaef0010c012db7-1346066442",
"id": 85618,
"name": "凤凰传奇",
"type": "组合",
"intro": "中国大陆具有广泛知名度的男女二人音乐组合",
"add_time": 1340949289,
"language": ["国语"],
"tags": ["月亮之上", "最炫民族风"]
},
"if-match": 1346066442
}
]
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/data?method=update&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=<artists_update_request"
 
正确响应示例：HTTP/1.1 200 OK
 
{
"records":[
{
"_key":"f44603de003c57d5-1346066442",
"_mtime":1346066823
},
{
"_key":"1aaef0010c012db7-1346066442",
"_mtime":1346066824
}
],
"request_id":9201162933
}
出错响应示例：HTTP/1.1 400 Bad Request
 
{
"error_code":31430,
"error_msg":"bad record",
"request_id":0
"records": [
]
}

删除record Copy Chapter

功能 Copy Section

根据_key，删除record。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

请求参数 Copy Section

• 当值为“recycled”时，将普通record放进回收站；缺省情况为放进回收站。 |

说明： Copy Section

其中records是一个数组，其数组成员结构如下：

返回参数

示例 Copy Section

请求示例: $ cat > ./artists_delete_request <<DELIM
{
"table":"artists",
"records": [
{
"_key": "f44603de003c57d5-1346066442",
"if-match": 1346066823
}
]
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/data?method=delete&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=<artists_delete_request"
 
正确响应示例：HTTP/1.1 200 OK
 
{
"records":[
{
"_key":"f44603de003c57d5-1346066442",
"_mtime":1346066823
}
],
"request_id":9494352006
}
出错响应示例：HTTP/1.1 400 Bad Request
 
{
"error_code":31430,
"error_msg":"bad record",
"request_id":0
"records": [
{"_key": "7d4febca4a68e763-1344915172"},
]
}

查询record Copy Chapter

功能 Copy Section

通过一定条件查询record，只能select非回收站的record。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

请求参数 Copy Section

所支持的查询条件如下表所示：

• 表示0到多个字符，_ 表示一个字符 | "message": {"like": "%windows%"} |
  | 'like_binary' | string | SQL中binary like语法（区分大小写）
• 表示0到多个字符， _ 表示一个字符 | "message": {"like_binary": "%Windows%"} |
  | 'contain' | string | 包含在数组中 | "language": {"contain": "国语"} |
  | 'in' | array | in | "_key": {"in": ["_key1", "_key2"]} |
  | ‘notin’ | array | 不在集合中 | "_key": {"notin": ["_key1", "_key2"]} |

说明：

（1）当“condition”条件为空时，表示获取所有record。

（2）根据key获取一条record，可使用如下condition条件表达：

"_key": {"=": "385d24b3baef3290-1344915172"}

（3）order_by表示支持的排序方式，它是一个数组，数组元素信息如下：

返回参数 (JSON格式)

示例 Copy Section

请求示例:

1. 简单查询

cat > ./artists_select_request <<DELIM
{
"table": "artists",
"condition": {
"and": [
{ "name": { "=": "刘德华" } }
]
},
"order_by" : [
{"add_time" : "desc" },
{"name" : "asc" }
],
"start": 0,
"limit": 10
}
DELIM
 
curl -v -X POST "http://pcs.baidu.com/rest/2.0/structure/data?method=select&access_token=2.85e37d20acd37c3a5ebc9726bd5606eb.31536000.1384932826.1175746697-309847" -F "param=<artists_select_request" 2>/dev/null

2. 组合查询

cat > ./artists_select_request <<DELIM
{
"table": "artists",
"condition": {
"and": [
{ "name": { "=": "刘德华" } },
{ "tags": { "contain": "四大天王" } }
]
},
"projection": ["name", "intro"]
}
DELIM
 
curl -v -X POST "http://pcs.baidu.com/rest/2.0/structure/data?method=select&access_token=2.85e37d20acd37c3a5ebc9726bd5606eb.31536000.1384932826.1175746697-309847" -F "param=<artists_select_request" 2>/dev/null

3. select 支持对嵌套属性的查询

cat > ./artists_select_request <<DELIM
{
"table": "artists",
"condition": {
"and": [
{ "top_song.name": { "=": "爱你一万年" } }
]
},
"projection": ["name", "intro"]
}
DELIM
 
curl -v -X POST "http://pcs.baidu.com/rest/2.0/structure/data?method=select&access_token=2.85e37d20acd37c3a5ebc9726bd5606eb.31536000.1384932826.1175746697-309847" -F "param=<artists_select_request" 2>/dev/null |./json_decode

4. or 条件支持

cat > ./artists_select_request <<DELIM
{
"table": "artists",
"condition": {
"or": [
{ "name": { "=": "刘德华" } },
{ "top_song.name": { "=": "月亮之上" } }
]
},
"projection": ["name", "intro"]
}
DELIM
 
curl -v -X POST "http://pcs.baidu.com/rest/2.0/structure/data?method=select&access_token=2.85e37d20acd37c3a5ebc9726bd5606eb.31536000.1384932826.1175746697-309847" -F "param=<artists_select_request" 2>/dev/null

5. and/or 混合条件支持

cat > ./artists_select_request <<DELIM
{
"table": "artists",
"condition": {
"or": [
{ "name": { "=": "刘德华" } },
{ "and": [
{ "top_song.name": { "=": "月亮之上" } },
{ "tags": { "contain": "月亮之上" } }
]}
]
},
"projection": ["name", "intro"]
}
DELIM
 
curl -v -X POST "http://pcs.baidu.com/rest/2.0/structure/data?method=select&access_token=2.85e37d20acd37c3a5ebc9726bd5606eb.31536000.1384932826.1175746697-309847" -F "param=<artists_select_request" 2>/dev/null
响应示例：{
"table":"artists",
"count": 1,
"start": 0,
"limit": 0,
"records": [
{
"_key": "f44603de003c57d5-1346066442",
"name": "刘德华",
"intro": "香港著名歌手、演员",
},
]
}

record增量更新查询 Copy Chapter

功能 Copy Section

数据更新增量查询接口。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

请求参数 Copy Section

返回参数

• True：本次调用diff接口结果无法一次返回，立刻再调用一次diff接口获取剩余结果；
• False：已返回全部更新，等待一段时间（5分钟）之后再调用该接口查看是否有更新。 |
  | cursor | string | 游标，下次调用diff 接口，需要使用该参数 |

说明：

（1）其中records是一个record数组，标志从上次调用该接口以来的更新操作：

• 对于update后的record，会得到一个最新版的record；
• 对于删除的record，得到的record中_isdelete字段为“1”。

（2）常见“reset=true”的场景如下：

• 服务器端程序升级等，提示客户端重新拉去文件列表等。

（3）注意：

diff接口有一定延迟（约10s），客户端不可假设新增record之后马上就会在diff 接口中获得更新。

示例

请求示例:

当创建了“刘德华”和“凤凰传奇”两个record后，第一次调用diff接口，使用cursor为null作为参数：

 
$ cat > ./artists_diff1_request <<DELIM
{
"table":"artists",
"cursor" : "null",
"projection": ["name", "intro"]
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/data?method=diff&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=<artists_diff1_request"

返回：

{
"table":"artists",
"entries":
[
{
"_key": "f44603de003c57d5-1346066442",
"name": "刘德华",
"intro": "香港著名歌手、演员",
"_ctime":1345786801,
"_mtime":1345786801,
"_isdelete":0
},
{
"_key": "1aaef0010c012db7-1346066442",
"name": "凤凰传奇",
"intro": "中国大陆具有广泛知名度的男女二人音乐组合",
"_ctime":1345787059,
"_isdelete":0,
"_mtime":1345787666
}
],
"cursor":"3861315431477246513534776b33573367765677314d595a6571724c69753574426133356f4f71316239342b5937577037766874316330493447465a346172445776504e45793235552b456f39796f4c6b307a30447a6f4e68774233616130362f63356f67586d66647879736f72686a70757a575a5342582b4c4b506479325431486f3937526333514a4a6d72626d7830574a35456d46705153454c4873614f6a6368743948743575386b45765477376a634e453848457737522f756d714235464d7a374372574b5777675134423231366a6f3431673d3d",
"request_id":4060333081
}

此时如果删除了“刘德华”，再调用diff接口，应该使用刚才的cursor作为参数调用diff接口：

$ cat > ./artists_diff2_request <<DELIM
{
"table":"artists","cursor":"3861315431477246513534776b33573367765677314d595a6571724c69753574426133356f4f71316239342b5937577037766874316330493447465a346172445776504e45793235552b456f39796f4c6b307a30442b6f6b4f585a7672687647426342783858576a524666316470356473754f6a364356674365366f53647979663646356649744747336e50694a44767a7258627a77473078572b327a366c4f674a4c757a76596e3843454b36496b59474153566c4447514c506632704c64494a5a764f337269546d6d454c6869676765367a4866513d3d",
"projection": [ "name", "id" ]
}
DELIM
 
curl -i -X POST
"http://pcs.baidu.com/rest/2.0/structure/data?method=diff&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=artists_diff2_request"

得到的响应如下：

{
"table":"artists",
"entries":
[
{
"id":85617,
"name":"\u5218\u5fb7\u534e",
"_ctime":1346066442,
"_mtime":1346067702,
"_isdelete":1,
"_key":"f44603de003c57d51346066442"
}
],
"has_more":false,
"reset":false,"cursor":"3861315431477246513534776b33573367765677314d595a6571724c69753574426133356f4f71316239342b5937577037766874316330493447465a346172445776504e45793235552b456f39796f4c6b307a304434436368685971496f4e544d446e326a6341505358767251356b79616244597a52745750436d544a327250703956444f7338593752737a4e32735a4d634233372f34416e454e4f3744474c4b4e6d726d64726f774e6b594a4e6553524a716d65743442553375696b354f585738474d376e4f635973507239636c6e5071585141673d3d",
"request_id":1242060313
}

查询record（回收站） Copy Chapter

功能 Copy Section

与select相同，只不过操作对象是回收站中。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

说明 Copy Section

该接口参数与select完全一样, 只不过操作对象是回收站中的records；返回的records中_isdelete为“1”。详细信息，请参考“查询record—select”。

从回收站中恢复record Copy Chapter

功能 Copy Section

从回收站中恢复文件。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

请求参数 Copy Section

说明：

其中records是一个数组，每个数组成员结构如下：

返回参数

示例 Copy Section

请求示例: $ cat > ./artists_restore_request <<DELIM
{
"table":"artists",
"records": [
{"_key": "7d4febca4a68e763-1344915172"},
{"_key": "385d24b3baef3290-1344915172"}
]
}
DELIM
 
$ curl -v -X POST
"http://pcs.baidu.com/rest/2.0/structure/data?method=restore&access_token=2.b06c3e00010fdb879d12345dcd5f8545.2587600.134819999.1175746697-238347" -F "param=<artists_restore_request"
 
正确响应示例：HTTP/1.1 200 OK
{
"records": [
{
"_key":"7d4febca4a68e763-1344915172",
"_mtime":1344927006
},
{
"_key":"385d24b3baef3290-1344915172",
"_mtime":1344927006
},
 
]
}
出错响应示例：HTTP/1.1 400 Bad Request
{
"error_code":31430,
"error_msg":"key not exist",
"request_id":0
"records": [
{'_key': "7d4febca4a68e763-1344915172"},
]
}

按条件更新record Copy Chapter

功能 Copy Section

对符合一定条件的record 执行更新操作。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

请求参数 Copy Section

| 参数名称 | 类型 | 是否

必需 | 描述 |
| --- | --- | --- | --- |
| v | string | 否 | 版本号，默认为“1.0” |
| method | string | 是 | 固定值：update |
| type | string | 是 | 固定值：by-condition。 |
| access_token | string | 是 | 用户的access_token，HTTPS调用时必须使用。 |
| table | string | 是 | 查询的目标表名。 |
| condition | json | 是 | 条件描述, 与select 中的condition一样。 |
| action | json | 是 | 需要对命中的record进行的操作。 |

说明：

action为一个json字典，其格式为：

"action": {                                                                     
    column: {action: value}
}

如:

"action": {                                                                     
    "name": {"=": "LiuDeHua"}
}

其中column 支持嵌套列。

• 所支持的action如下表所示：

返回参数 (JSON格式)

示例 Copy Section

请求示例: cat > ./artists_update_request <<DELIM
{
"table": "artists",
"condition": {
"and": [
{ "name": { "=": "刘德华" } }
]
},
"action": {
"name": {"=": "LiuDeHua"},
"age": { "+=": 1 }
}
}
DELIM
 
curl -v -X POST "http://pcs.baidu.com/rest/2.0/structure/data?method=update&type=by-condition&access_token=2.85e37d20acd37c3a5ebc9726bd5606eb.31536000.1384932826.1175746697-309847" -F "param=<artists_update_request"
响应示例：{
"affected": 1,
"request_id": 4060311005
}

按条件删除record Copy Chapter

功能 Copy Section

对符合一定条件的record 执行删除操作。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

请求参数 Copy Section

| 参数名称 | 类型 | 是否

必需 | 描述 |
| --- | --- | --- | --- |
| v | string | 否 | 版本号，默认为“1.0”。 |
| method | string | 是 | 固定值：delete。 |
| type | string | 是 | 固定值：by-condition。 |
| access_token | string | 是 | 用户的access_token，HTTPS调用时必须使用。 |
| table | string | 是 | 查询的目标表名。 |
| condition | json | 是 | 条件描述，与select 中的condition一样。 |

返回参数 (JSON格式)

示例 Copy Section

请求示例: cat > ./artists_update_request <<DELIM
{
"table": "artists",
"condition": {
"and": [
{ "name": { "=": "LiuDeHua" } }
]
}
}
DELIM
 
curl -v -X POST "http://pcs.baidu.com/rest/2.0/structure/data?method=delete&type=by-condition&access_token=2.85e37d20acd37c3a5ebc9726bd5606eb.31536000.1384932826.1175746697-309847" -F "param=<artists_update_request"
响应示例：{
"affected": 1,
"request_id": 4060311005
}

按条件恢复record Copy Chapter

功能 Copy Section

对回收站中符合一定条件的record 执行restore操作。

HTTP请求方式 Copy Section

POST

URL Copy Section

https://pcs.baidu.com/rest/2.0/structure/data

请求参数 Copy Section

| 参数名称 | 类型 | 是否

必需 | 描述 |
| --- | --- | --- | --- |
| v | string | 否 | 版本号，默认为“1.0”。 |
| method | string | 是 | 固定值：restore。 |
| type | string | 是 | 固定值：by-condition。 |
| access_token | string | 是 | 用户的access_token，HTTPS调用时必须使用。 |
| table | string | 是 | 查询的目标表名。 |
| condition | json | 是 | 条件描述, 与select 中的condition一样。 |

返回参数 (JSON格式)

示例 Copy Section

请求示例: cat > ./artists_update_request <<DELIM
{
"table": "artists",
"condition": {
"and": [
{ "name": { "=": "LiuDeHua" } }
]
}
}
DELIM
curl -v -X POST "http://pcs.baidu.com/rest/2.0/structure/data?method=restore&type=by-condition&access_token=2.85e37d20acd37c3a5ebc9726bd5606eb.31536000.1384932826.1175746697-309847" -F "param=<artists_update_request"
响应示例：{
"affected": 1,
"request_id": 4060311005
}

Structured Data Apis Error (`docs/structured_data_apis_error.md`) Copy Section

结构化数据API错误码

结构化数据API以HTTP提供，因此请求者应首先检查HTTP协议级别的响应状态码。 当请求有错误或执行失败时，HTTP协议的返回响应状态码不为“200”，且在Content-body的JSON格式数据中以error_code给出错误码，并可能以error_msg字段提示错误信息。错误码的详细信息，请参考以下错误码列表。 一般来说, 错误分为客户端错误和服务器端错误：

• 客户端错误：
  返回状态码4xx表示结构化数据平台认为客户端请求有错误，例如：auth失败，参数不对，超出quota等。这些情况，客户端需要先解决参数问题，再向服务器端重新发起请求。

• 服务器端错误：
  返回状态码为5xx，表示结构化数据平台内部发生错误，客户端需要重试。

注意 Copy Chapter

请求成功时，HTTP协议的返回响应状态码为“200”，不会设置error_code和error_msg。

结构化数据API错误码 Copy Chapter