服务端 API/云文档/云空间/文档版本/获取文档版本列表
# 获取文档版本列表

获取文档所有版本。

## 请求

基本 |  
---|---
HTTP URL | https://open.larksuite.com/open-apis/drive/v1/files/:file_token/versions
HTTP Method | GET
接口频率限制 | [1000 次/分钟、50 次/秒](https://open.larksuite.com/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 查看、创建、删除文档版本(drive:drive:version)<br>查看文档版本(drive:drive:version:readonly)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请<br>获取用户 user ID(contact:user.employee_id:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 路径参数

名称 | 类型 | 描述
---|---|---
file_token | string | 源文档token，如何获取文档Token可以参考[如何获取云文档相关token](https://open.larksuite.com/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#08bb5df6)<br>**示例值**："doxbcyvqZlSc9WlHvQMlSJwUrsb"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
page_size | int | 是 | 分页大小<br>**示例值**：20<br>**数据校验规则**：<br>- 最大值：`100`
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**：1665739388
obj_type | string | 是 | 原文档类型<br>**示例值**：docx<br>**可选值有**：<br>- docx：新版文档<br>- sheet：电子表格
user_id_type | string | 否 | 用户 ID 类型<br>**示例值**：open_id<br>**可选值有**：<br>- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)<br>- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)<br>- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)<br>**默认值**：`open_id`<br>**当值为 `user_id`，字段权限要求**：<br>获取用户 user ID(contact:user.employee_id:readonly)

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | version\[\] | 版本文档列表
name | string | 版本文档标题
version | string | 版本文档版本号
parent_token | string | 创建版本的文档Token，如何获取文档Token可以参考[如何获取云文档相关token](https://open.larksuite.com/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#08bb5df6)
owner_id | string | 版本文档所有者id，user_id
creator_id | string | 版本文档创建者id， user_id
create_time | string | 版本文档创建时间
update_time | string | 版本文档更新时间
status | string | 版本文档状态<br>**可选值有**：<br>- 0：正常状态<br>- 1：删除状态<br>- 2：回收站状态
obj_type | string | 版本文档类型<br>**可选值有**：<br>- docx：新版文档<br>- sheet：电子表格
parent_type | string | 源文档类型<br>**可选值有**：<br>- docx：新版文档<br>- sheet：电子表格
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
has_more | boolean | 是否还有更多项

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "name": "文档标题",
                "version": "version1",
                "parent_token": "doxbcyvqZlSc9WlHvQMlSJwUrsb",
                "owner_id": "694699009591869450",
                "creator_id": "694699009591869451",
                "create_time": "1660708537",
                "update_time": "1660708537",
                "status": "0",
                "obj_type": "docx",
                "parent_type": "docx"
            }
        ],
        "page_token": "1665739380",
        "has_more": true
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
403 | 1068400 | Has no permission, please apply the file permission of reading or edition. | 无阅读/编辑权限，请申请源文档的阅读/编辑权限。
400 | 1068401 | Review no pass, the title has illegal content. | 标题审核不通过，含非法内容，请重新命名。
404 | 1068404 | Parent file does not exist, please check the file status. | 源文档不存在，请检查文档是否已删除。
400 | 1068410 | Params error, param [file_token] is wrong. | `file_token`请求参数错误，请检查参数。
400 | 1068411 | Params error, param [obj_type] is wrong. | `obj_type`请求参数错误，请检查参数。
400 | 1068425 | Request failed, please contact the engineer-https://applink.larksuite.com/TLJsX982. | 请求失败，请联系业务方oncall。
400 | 1068412 | Params error, param [version_id] is wrong. | `version_id`请求参数错误，请检查参数。