updateIndex

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

变更数据库索引

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
envstring云环境ID
collection_namestring集合名称
create_indexesArray.<Object>新增索引
drop_indexesArray.<Object>删除索引

create_indexes 的结构

属性类型默认值必填说明
namestring索引名
uniqueboolean是否唯一
keysArray.<Object>索引字段

keys 的结构

属性类型默认值必填说明
namestring字段名
directionstring字段排序

direction 的合法值

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

drop_indexes 的结构

属性类型默认值必填说明
namestring索引名

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息

errcode 的合法值

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

请求数据示例

  1. {
  2. "env": "test2-4a89da",
  3. "collection_name": "counters",
  4. "create_indexes": [
  5. {
  6. "name":"add_index",
  7. "unique": true,
  8. "keys": [
  9. {
  10. "name": "test",
  11. "direction": "2dsphere"
  12. }
  13. ]
  14. }
  15. ],
  16. "drop_indexes": [
  17. {
  18. "name":"del_index"
  19. }
  20. ]
  21. }

返回数据示例

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. }