Data Model OpenAPI
Feature Introduction
This document provides the APIs for all operations of the data model, along with parameter references for each API.
Access Guide
To call the following interfaces, you need to pass an AccessToken in the format Authorization: Bearer <token>. For token acquisition methods, refer to: https://docs.cloudbase.net/http-api/basic/access-token
HTTP Status Code
Only 2xx status codes will be returned. Business errors for the data model API are indicated in the response body under 2xx status codes and should be handled accordingly.
Error Codes
The following lists the error codes specific to this series of APIs. For the complete list, refer to: https://docs.cloudbase.net/error-code/service
| Error Code | Meaning |
| AUTH_FAILURE | Permission Denied |
| FAILED_OPERATION | Operation Failed |
| OPERATION_TIMEOUT | Operation Timeout |
| INVALID_PARAMETER | Parameter Error |
| INVALID_PARAMETER_VALUE | Parameter Value Error |
| MISSING_PARAMETER | Missing Parameter Error |
| LIMIT_EXCEEDED | Quota Limit Exceeded |
| RESOURCE_NOT_FOUND | Resource Not Found |
| RESOURCE_UNAVAILABLE | Resource Unavailable |
| RESOURCE_INSUFFICIENT | Resource Insufficient |
| RESOURCE_IN_USE | Resource Occupied |
| RESOURCE_SOLD_OUT | Resource Sold Out |
| OPERATION_DENIED | Operation Denied |
| UNAUTHORIZED_OPERATION | Unauthorized Operation |
| UNKNOWN_PARAMETER | Unknown Parameter Error |
| UNSUPPORTED_OPERATION | Operation Not Supported |
| DATA_SOURCE_OP_AUTH_FAILURE | Authentication failed for the data source model. Please configure appropriate permissions for the corresponding role in the User Permissions module. |
| FLEXDB_INTERNAL_ERROR | Cloud database request error, please check the parameters. |
| FLEXDB_REQUEST_TIMEOUT | Request to Mongo database timed out. Please optimize your query or add an index. |
| AUTH_FAILURE_TOKEN_FAILURE | token Error |
| NO_SUCH_VERSION | Interface Version Not Found |
| REQUEST_LIMIT_EXCEEDED | The number of requests exceeds the frequency limit |
| FLEXDB_RESOURCE_OVERDUE | Database resources have expired or the number of read/write operations has exceeded the plan limit. Please upgrade your plan's read/write capacity or wait until the next day for the operation count to reset. If issues persist, verify your resources on the cloud database platform. |
| FLEXDB_READ_LIMIT | Database read operations have exceeded the limit. Please upgrade your plan. |
| FLEXDB_WRITE_LIMIT | Database write operations have exceeded the limit. Please upgrade your plan. |
| FAILED_OPERATION_CUSTOMIZED_METHODS_ERROR | Cloud Function Error, User-Defined Method Error |
| DATASOURCE_NOT_EXIST | The data source does not exist. Please check if the corresponding data source exists in the console. |
| TABLE_NOT_EXIST | Table Not Found |
| FAILED_AGGREGATE | Aggregate Query Failed |
Authentication
- HTTP: Bearer Auth
- API Key: APIKey
The token corresponding to the environment ID, obtained using login authentication (v2).
| Security Scheme Type: | http |
|---|---|
| HTTP Authorization Scheme: | bearer |
The Tencent Cloud version 3.0 signature starting with TC3-HMAC-SHA256 appends Timestamp and Token to the end of the signature.
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | Authorization |