databaseCollectionGet

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

获取特定云环境下集合信息

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
envstring是云环境ID
limitnumber10否获取数量限制
offsetnumber0否偏移量

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
pagerObject分页信息
collectionsArray.<Object>集合信息

errcode 的合法值

值说明最低版本
0请求成功
-1系统错误
-1000系统错误
40014AccessToken 不合法
40097请求参数错误
40101缺少必填参数
41001缺少AccessToken
42001AccessToken过期
43002HTTP METHOD 错误
44002POST BODY 为空
47001POST BODY 格式错误
85088该APP未开通云开发
其他错误码云开发错误码

pager 的结构

属性类型说明
Offsetnumber偏移
Limitnumber单次查询限制
Totalnumber符合查询条件的记录总数

collections 的结构

属性类型说明
namestring集合名
countnumber表中文档数量
sizenumber表的大小（即表中文档总大小），单位：字节
index_countnumber索引数量
index_sizenumber索引占用大小，单位：字节

请求数据示例

  1. {
  2.   "env":"test2-4a89da",
  3.   "limit": 10,
  4.   "offset": 0
  5. }

返回数据示例

  1. {
  2.   "errcode": 0,
  3.   "errmsg": "ok",
  4.   "collections": [
  5.       {
  6.           "name": "geo",
  7.           "count": 13,
  8.           "size": 2469,
  9.           "index_count": 1,
  10.           "index_size": 36864
  11.       },
  12.       {
  13.           "name": "test_collection",
  14.           "count": 1,
  15.           "size": 67,
  16.           "index_count": 1,
  17.           "index_size": 16384
  18.       }
  19.   ],
  20.   "pager": {
  21.       "Offset": 0,
  22.       "Limit": 10,
  23.       "Total": 2
  24.   }
  25. }