数据库创建索引

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

请求地址

POST https://api.weixin.qq.com/componenttcb/dbindex?access_token=ACCESS_TOKEN&action=create

请求参数

属性 类型 默认值 必填 说明
access_token string 第三方接口调用令牌component_access_token
action string create
env string 环境ID
collection_name string 集合名称
indexes Array.<Object> 索引信息

indexes 的结构

属性 类型 默认值 必填 说明
name string 索引名称
keys Array.<Object> keys信息

keys 的结构

属性 类型 默认值 必填 说明
name string 字段名
direction string 字段排序

direction 的合法值

说明 最低版本
"1" 升序
"-1" 降序
"2dsphere" 地理位置

返回值

Object

返回的 JSON 数据包

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

errcode 的合法值

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

请求数据示例

{
  "env": "mmtest-5g7z68c153d7ff4b",
  "collection_name": "test",
  "indexes": [
    {
      "name":"due_index",
      "keys": [
        {
          "name": "due",
          "direction": "1"
        }
        ]
    }
    ]
}

返回数据示例

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