开放平台
取消
开放平台
中文
EN
取消
  • 第三方平台 API

    • # 数据库聚合

    调试诊断

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

    接口英文名：dbAggregate

    通过本接口可以数据库聚合，使用过程中如遇到问题，可在开放平台服务商专区发帖交流。

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填说明
    access_tokenstring是接口调用凭证，可使用 component_access_token

    # 请求体 Request Payload

    参数名类型必填说明
    envstring是云环境ID
    querystring是数据库操作语句

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    dataarray记录数组

    # 4. 注意事项

    • 数据库操作语句说明：数据库操作语句语法与数据库 API相同， 聚合操作参考聚合文档

    # 5. 代码示例

    请求示例

    {
  "env": "test2-4a89da",
  "query": "db.collection(\"test_collection\").aggregate().match({tags:\"cloud\"}).limit(10).end()"
}

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    "{\"_id\":\"f77e039f-f1cf-4aa8-bd59-16cbaa91e6ea\",\"location\":{\"type\":\"Point\",\"coordinates\":[{\"$numberDouble\":\"113.0\"},{\"$numberDouble\":\"23.0\"}]},\"done\":false,\"description\":\"learn cloud database\",\"due\":\"2019-09-09\",\"tags\":[\"cloud\",\"database\"]}",
    "{\"_id\":\"6bb88938-49ea-42b6-a6f5-ce408970cfc6\",\"due\":\"2019-09-09\",\"tags\":[\"cloud\",\"database\"],\"location\":{\"type\":\"Point\",\"coordinates\":[{\"$numberDouble\":\"113.0\"},{\"$numberDouble\":\"23.0\"}]},\"done\":false,\"description\":\"学习 cloud database\"}",
    "{\"_id\":\"51f4f67e-a6a1-4c3e-a50f-827380b8da86\",\"description\":\"学习 cloud database\",\"due\":\"2019-09-09\",\"tags\":[\"cloud\",\"database\"],\"location\":{\"coordinates\":[{\"$numberDouble\":\"113.0\"},{\"$numberDouble\":\"23.0\"}],\"type\":\"Point\"},\"done\":false}",
    "{\"_id\":\"ee1d69da-b7ec-4e7a-bc1f-2fae31da4ce0\",\"tags\":[\"cloud\",\"database\"],\"location\":{\"type\":\"Point\",\"coordinates\":[{\"$numberDouble\":\"113.0\"},{\"$numberDouble\":\"23.0\"}]},\"done\":false,\"description\":\"学习 cloud database\",\"due\":\"2019-09-09\"}"
  ]
}

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述解决方案
    -1000system error系统错误
    -1system error系统繁忙，此时请开发者稍候再试
    0okok
    40014invalid access_token不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口
    40097invalid args参数错误
    40101missing parameter缺少必填参数
    41001access_token missing缺少 access_token 参数
    42001access_token expiredaccess_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明
    43002require POST method需要 POST 请求
    44002empty post dataPOST 的数据包为空
    47001data format error解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。
    85088no qbase privilege该APP未开通云开发

    # 7. 适用范围

    本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。