# 获取集合信息

调试工具

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

# 接口说明

# 接口英文名

getDatabaseCollection

# 功能描述

通过本接口可以获取特定云环境下集合信息。使用过程中如遇到问题，可在开放平台服务商专区发帖交流。

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/tcb/databasecollectionget?access_token=ACCESS_TOKEN

# 第三方调用

调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：49、64
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用authorizer_access_token
env	string	是	云环境ID
limit	number	否	获取数量限制
offset	number	否	偏移量

# 返回参数

属性

类型

说明

errcode

number

错误码

errmsg

string

错误信息

collections

array<object>

集合信息

属性	类型	说明
name	string	集合名
count	number	表中文档数量
size	number	表的大小（即表中文档总大小），单位：字节
index_count	number	索引数量
index_size	number	索引占用大小，单位：字节

pager

object

分页信息

属性	类型	说明
Offset	number	偏移
Limit	number	单次查询限制
Total	number	符合查询条件的记录总数

# 调用示例

示例说明: HTTPS请求

# 请求数据示例


{
  "env":"test2-4a89da",
  "limit": 10,
  "offset": 0
}

# 返回数据示例


{
  "errcode": 0,
  "errmsg": "ok",
  "collections": [
      {
          "name": "geo",
          "count": 13,
          "size": 2469,
          "index_count": 1,
          "index_size": 36864
      },
      {
          "name": "test_collection",
          "count": 1,
          "size": 67,
          "index_count": 1,
          "index_size": 16384
      }
  ],
  "pager": {
      "Offset": 0,
      "Limit": 10,
      "Total": 2
  }
}

# 错误码

错误码	错误码取值	解决方案
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
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未开通云开发