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

    • # 更新数据库索引

    调试工具

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

    # 接口说明

    # 接口英文名

    updateDatabaseIndex

    # 功能描述

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

    # 调用方式

    # HTTPS 调用

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

    # 第三方调用

    • 调用方式以及出入参和HTTPS相同，仅是调用的token不同

    • 该接口所属的权限集id为：49、64

    • 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

    # 请求参数

    属性 类型 必填说明
    access_token string 是 接口调用凭证，该参数为 URL 参数，非 Body 参数。使用authorizer_access_token
    env string 是 云环境ID
    collection_name string 是 集合名称
    create_indexes array<object> 是 新增索引
    属性 类型 必填 说明
    name string 是 索引名
    unique boolean 是 是否唯一
    keys array<object> 是 索引字段
    属性 类型 必填 说明
    name string 是 字段名
    direction string 是 字段排序
    drop_indexes array<object> 是 删除索引
    属性 类型 必填 说明
    name string 是 索引名
    unique boolean 是 是否唯一
    keys array<object> 是 索引字段
    属性 类型 必填 说明
    name string 是 字段名
    direction string 是 字段排序

    # 返回参数

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

    # 调用示例

    示例说明: HTTPS请求

    # 请求数据示例

    
{
  "env": "test2-4a89da",
  "collection_name": "counters",
  "create_indexes": [
    {
      "name":"add_index",
      "unique": true,
      "keys": [
        {
          "name": "test",
          "direction": "2dsphere"
        }
        ]
    }
    ],
  "drop_indexes": [
    {
      "name":"del_index"
    }
    ]
}

    # 返回数据示例

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

    # 错误码

    错误码 错误码取值 解决方案
    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未开通云开发