# 数据库集合管理

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

# 接口说明

# 接口英文名

dbcollectionManage

# 功能描述

数据库集合管理

# 调用方式

# HTTPS 调用


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

# 数据库查询集合

# 请求参数

属性	类型	默认值	必填	说明
access_token	string		是	第三方接口调用令牌component_access_token
action	string		是	填"get"
env	string		是	环境ID
limit	number	20	否	返回数据长度
offset	number	0	否	数据偏移量

# 返回值

返回的 JSON 数据包

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

# 数据库增加集合

# 请求参数

属性	类型	必填	说明
access_token	string	是	第三方接口调用令牌component_access_token
action	string	是	填"add"
env	string	是	环境ID
collection_name	string	是	集合名称

# 返回值

返回的 JSON 数据包

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息

# 数据库删除集合

# 请求参数

属性	类型	必填	说明
access_token	string	是	第三方接口调用令牌component_access_token
action	string	是	填"del"
env	string	是	环境ID
collection_name	string	是	集合名称

# 返回值

返回的 JSON 数据包

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息

# 调用示例

示例说明: 数据库增加集合

# 请求数据示例


{
    "env": "dev-3gewtf9c10f60c76",
    "collection_name": "testcollection"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
}

示例说明: 数据库查询集合

# 请求数据示例


{
    "env": "test-env1"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
    "collections": [
        {
            "name": "testcollection",
            "count": 0,
            "size": 0,
            "index_count": 2,
            "index_size": 8192
        }
    ],
    "total": 1
}

示例说明: 数据库删除集合

# 请求数据示例


{
    "env": "dev-3gewtf9c10f60c76",
    "collection_name": "testcollection"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
}

# 错误码

错误码	错误码取值	解决方案
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 的数据包为空。post请求body参数不能为空。
47001	data format error	解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。
85088	no qbase privilege	该APP未开通云开发