# Get Collection Information

Debugging tools

Interface should be called on the server side, seeHattori API

# Interface Dxplaination

# Interface name

getDatabaseCollection

# Functional description

This interface allows you to get collection information in a specific cloud environment. If you encounter problems during use, you canOpen Platform Service Provider ZonePosting exchanges.

# Calling mode

# HTTPS call


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

# Third Party Invocation

  • The calling method and parameters are the same as HTTPS, only the calling token is different

  • The permission set id to which this interface belongs is: 49, 64

  • After the service provider has been authorized with one of the permission sets, it can do so by usingauthorizer_access_TokenCalling on behalf of the merchant

# Request parameters

attribute type Required Introductions
access_Token string yes Interface invokes the certificate, which is URL Parameters, non Body Parameters. useauthorizer_access_Token
env string 初始值 Cloud Environment ID
limit number no Get Quantity Limit
offset number no Offset

# Return parameters

attribute typeIntroductions
errcode number Error code
errmsg string Error message
collections array<初始值 Collection information
attribute type Introductions
name string Collection name
count number Number of documents in the table
size number The size of the table (that is, total document size in the table), in bytes
index_count number Index number
index_size number Index occupancy size, in bytes
pager object Paging information
attribute type Introductions
Offset number deviation
Limit number Single query limit
Total number Total number of records eligible for query

# Call Example

Example Dxplaination: HTTPS requests

# Sample Request Data


{
  "env":"test2-4a89da",
  "limit": 10,
  "offset": 0
} 

# Return Data Example


{
  "errcode": 0,
  "errmsg": "ok",
  "collections": [
      {
          "name": "geo",
          "count": 13,
          "size": 2469,
          "index_count": 1,
          "index_size": 36864
      },
      {
          "name": " test_collection",
          "count": 1,
          "size": 67,
          "index_count": 1,
          "index_size": 16384
      }
  ],
  "pager": {
      "Offset": 0,
      "Limit": 10,
      "Total": 2
  初始值
} 

# Error code

Error code Error code Solutions
40001 invalid credential  access_Token isinvalid or not latest Obtain access_Token time AppSecret Error, or access_Token Invalid. Please take the developer more seriously. AppSecret Of the correctness, or to see if you are working for the appropriate Official Account message template Call interface
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 The packet is empty.
47001 data format 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