# 数据库索引管理

调试诊断

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

接口英文名：dbindexManage

该接口用于创建索引和删除索引

# 1. 调用方式

# HTTPS 调用

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

# 云调用

• 本接口不支持云调用

# 第三方调用

• 本接口仅支持第三方平台使用 component_access_token 自己调用。

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# Body.indexes(Array) Object Payload

索引信息

# Body.indexes(Array).keysObject Payload

keys信息。create时填写，delete无需填写

# 3. 返回参数

# 返回体 Response Payload

# 4. 枚举信息

# Body.action Enum

操作类型

# Body.indexes(Array).keys.direction Enum

字段排序

# 5. 注意事项

本接口无特殊注意事项

# 6. 代码示例

# 5.1 创建索引

请求示例

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

返回示例

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

# 5.2 删除索引

请求示例

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

返回示例

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

# 7. 错误码

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

# 8. 适用范围

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