databaseCollectionGet

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

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

请求地址

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

请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
env string 云环境ID
limit number 10 获取数量限制
offset number 0 偏移量

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
pager Object 分页信息
collections Array.<Object> 集合信息

errcode 的合法值

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

pager 的结构

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

collections 的结构

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

请求数据示例

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