Data Model OpenAPI
Function Introduction
This document provides APIs for all operations of the data model, along with parameter references for each API.
Integration Guide
To call the following APIs, you need to pass an AccessToken in the format Authorization: Bearer <token>. For token acquisition methods, please refer to: https://docs.cloudbase.net/http-api/basic/access-token
HTTP Status Codes
Only 2xx status codes will appear. Business errors of the data model API will be indicated in the response body with 2xx status codes and should be handled according to the situation.
Error Codes
The following lists the specific error codes for this API series. For a complete list, please refer to: https://docs.cloudbase.net/error-code/service
| Error Code | Meaning |
| AUTH_FAILURE | No permission |
| FAILED_OPERATION | Operation failed |
| OPERATION_TIMEOUT | Operation timeout |
| INVALID_PARAMETER | Invalid parameter |
| INVALID_PARAMETER_VALUE | Invalid parameter value |
| MISSING_PARAMETER | Missing parameter error |
| LIMIT_EXCEEDED | Exceeded quota limit |
| RESOURCE_NOT_FOUND | Resource does not exist |
| RESOURCE_UNAVAILABLE | Resource unavailable |
| RESOURCE_INSUFFICIENT | Insufficient resources |
| RESOURCE_IN_USE | Resource in use |
| RESOURCE_SOLD_OUT | Resource sold out |
| OPERATION_DENIED | Operation denied |
| UNAUTHORIZED_OPERATION | Unauthorized operation |
| UNKNOWN_PARAMETER | Unknown parameter error |
| UNSUPPORTED_OPERATION | Unsupported operation |
| DATA_SOURCE_OP_AUTH_FAILURE | Data source model authentication failed. Please set reasonable permissions for corresponding roles in the user permissions module |
| FLEXDB_INTERNAL_ERROR | Cloud database request error. Please check parameters |
| FLEXDB_REQUEST_TIMEOUT | Request to MongoDB database timed out. Please optimize your query or add indexes |
| AUTH_FAILURE_TOKEN_FAILURE | Token error |
| NO_SUCH_VERSION | API version does not exist |
| REQUEST_LIMIT_EXCEEDED | Number of requests exceeded frequency limit |
| FLEXDB_RESOURCE_OVERDUE | Database resource expired or database read/write count exceeded package limit. Please upgrade the package read/write count or wait for the next day's reset. If there are issues, please verify resources on the cloud database platform |
| FLEXDB_READ_LIMIT | Database read count exceeded upper limit. Please upgrade the package |
| FLEXDB_WRITE_LIMIT | Database write count exceeded upper limit. Please upgrade the package |
| FAILED_OPERATION_CUSTOMIZED_METHODS_ERROR | Cloud function error. User-defined method error |
| DATASOURCE_NOT_EXIST | Data source does not exist. Please check if the corresponding data source exists in the console data source |
| TABLE_NOT_EXIST | Table does not exist |
| FAILED_AGGREGATE | Aggregation query failed |
Authentication
- HTTP: Bearer Auth
- API Key: APIKey
Token corresponding to the Environment ID, obtained via Login Auth (v2)
| Security Scheme Type: | http |
|---|---|
| HTTP Authorization Scheme: | bearer |
Tencent Cloud 3.0 signature starting with TC3-HMAC-SHA256, appending Timestamp and Token
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | Authorization |