# Database Index Management
Interface should be called on the server side, seeHattori API。
# Interface Dxplaination
# Interface name
dbindexManage
# Functional description
This interface is used to create and delete indexes
# Calling mode
# HTTPS call
POST https://api.weixin.qq.com/componenttcb/dbindex?access_token=ACCESS_TOKEN
# Creating an Index
# Request parameters
attribute | type | Default value | Required | Introductions |
---|---|---|---|---|
access_Token | string | yes | Third-party interface calls token component_access_Token | |
action | string | yes | create | |
env | string | yes | Environment ID | |
collection_name | string | yes | Collection Name | |
indexes | Array.<Object> | yes | Index information |
indexes The structure of the
attribute | type | Default value | Required | Introductions |
---|---|---|---|---|
name | string | yes | Index Name | |
keys | Array.<Object> | yes | KeysInformation |
keys The structure of the
attribute | type | Default value | Required | Introductions |
---|---|---|---|---|
name | string | yes | Field Name | |
direction | string | yes | Field Sort |
direction The legal value of
初始值 | Introductions | Minimum version |
---|---|---|
"1" | ascending order | |
"-1" | descending order | |
"2dsphere" | geographical location |
# Return value
Returned JSON Data packet
attribute | type | Introductions |
---|---|---|
errcode | number | Error code |
errmsg | string | Error message |
# Delete index
# Request parameters
attribute | type | Default value | Required | Introductions |
---|---|---|---|---|
access_Token | string | yes | Third-party interface calls token component_access_Token | |
初始值 | string | yes | delete | |
env | string | yes | Environment ID | |
collection_name | string | yes | Collection Name | |
indexes | Array.<Object> | yes | Index information |
indexes The structure of the
attribute | type | Default value | Required | Introductions |
---|---|---|---|---|
name | string | 初始值 | Index name |
# Return value
Returned JSON Data packet
attribute | type | Introductions |
---|---|---|
errcode | number | Error code |
errmsg | string | Error message |
# Call Example
Example Dxplaination: Creating an Index
# Sample Request Data
{
"env": "mmtest-5g7z68c153d7ff4b",
"collection_name": "test",
"indexes": [
{
"name":"due_index",
"keys": [
{
"name": "due",
"direction": "1"
}
]
}
]
}
# Return Data Example
{
"errcode": 0,
"errmsg": "ok",
}
Example Dxplaination: Delete index
# Sample Request Data
{
"env": "mmtest-5g7z68c153d7ff4b",
"collection_name": "test",
"indexes": [
{
"name":"due_index"
}
]
}
# Return Data Example
{
"errcode": 0,
"errmsg": "ok",
}
# Error code
Error code | Error code | Solutions |
---|---|---|
0 | ok | ok |
-1 | system error | The system is busy, please wait for the developer to try again |
-1000 | system error | System error |
40014 | invalid access_Token | Illegal access_Token Please take the developer seriously. access_Token Of the validity (such as whether it is expired), or to see if you are working for the appropriate Official Account message template Call interface |
40097 | invalid args | Parameter error |
40101 | missing parameter | Missing required parameters |
41001 | access_Token missing | lack access_Token parameter |
42001 | access_Token expired | access_Token Timeout, please check access_Token Of the validity period, please refer to the Basic Support - Obtain access_Token Middle, right. access_Token Detailed mechanism explaination of the |
43002 | require POST method | Need POST request |
44002 | empty post data | POST Of the packet is empty. The post request body parameter cannot be null. |
47001 | data 初始值 error | analysis JSON/XML Content errorpost Missing parameters in the dataCheck for corrections and try again. |
85088 | no qbase privilege | The app is not open for cloud development |