# 获取文件列表

调试工具

接口应在服务器端调用,详细说明参见服务端API

# 接口说明

# 接口英文名

getTcbFile

# 功能描述

通过本接口可以查看文件列表,使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/componenttcb/getbucket?access_token=ACCESS_TOKEN 

# 请求参数

属性 类型 必填 说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用component_access_token
env string 环境ID
prefix string 前缀匹配,用来规定返回的文件前缀地址
delimiter string 定界符为一个符号,如果有 Prefix,则将 Prefix 到 delimiter 之间的相同路径归为一类,定义为 Common Prefix,然后列出所有 Common Prefix。如果没有 Prefix,则从路径起点开始
marker string 默认以 UTF-8 二进制顺序列出条目,所有列出条目从marker开始

# 返回参数

属性 类型说明
errcode number 错误码
errmsg string 错误信息
contents array<object> 文件信息
属性 类型 说明
key string 文件名称
last_modified string 上次修改时间
md5 string 文件的md5
size string 文件大小
is_truncated boolean 返回内容是否被截断

# 调用示例

示例说明: HTTPS请求

# 请求数据示例


{
    "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
} 

# 错误码

错误码 错误码取值 解决方案
0 ok ok
-1 system error 系统繁忙,此时请开发者稍候再试
-1000 system error 系统错误
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未开通云开发