# 获取文件列表
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：getTcbFile
通过本接口可以查看文件列表，使用过程中如遇到问题，可在开放平台服务商专区发帖交流。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/componenttcb/getbucket?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口仅支持第三方平台使用 component_access_token 自己调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，可使用 component_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| env | string | 是 | 环境ID |
| prefix | string | 否 | 前缀匹配，用来规定返回的文件前缀地址 |
| delimiter | string | 否 | 定界符为一个符号，如果有 Prefix，则将 Prefix 到 delimiter 之间的相同路径归为一类，定义为 Common Prefix，然后列出所有 Common Prefix。如果没有 Prefix，则从路径起点开始 |
| marker | string | 否 | 默认以 UTF-8 二进制顺序列出条目，所有列出条目从marker开始 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| contents | objarray | 文件信息 |
| is_truncated | boolean | 返回内容是否被截断 |
# Res.contents(Array) Object Payload
文件信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| key | string | 文件名称 |
| last_modified | string | 上次修改时间 |
| md5 | string | 文件的md5 |
| size | string | 文件大小 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"env": "test-env1"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"contents": [
{
"key": "Dockerfile",
"last_modified": "2020-12-04T08:56:59.000Z",
"md5": "6f58c139dc7aaefe41e3b40a8cb8f219-1",
"size": "554"
},
{
"key": "test_export",
"last_modified": "2020-12-04T09:35:56.000Z",
"md5": "e1ab5133bf151a78c466a90fa3a38a6e-1",
"size": "400"
}
],
"is_truncated": false
}
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1000 | system error | 系统错误 |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 0 | ok | ok |
| 40014 | invalid access_token | 不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口 |
| 40097 | invalid args | 参数错误 |
| 40101 | missing parameter | 缺少必填参数 |
| 41001 | access_token missing | 缺少 access_token 参数 |
| 42001 | access_token expired | access_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明 |
| 43002 | require POST method | 需要 POST 请求 |
| 44002 | empty post data | POST 的数据包为空 |
| 47001 | data format error | 解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。 |
| 85088 | no qbase privilege | 该APP未开通云开发 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。