Data Model OpenAPI
Feature Overview
This section lists all Data Model operation APIs along with the parameter reference for each API.
Access Guide
To call the following APIs, you need to pass an AccessToken in the format Authorization: Bearer <token>. For how to obtain the Access token, refer to the documentation.
HTTP Status Codes
Only 2xx status codes will be returned. Business errors of the Data Model API are indicated in the response body of 2xx responses and should be handled accordingly.
Error Codes
The following table lists the error codes specific to this series of APIs. For the complete list, refer to the documentation.
| Error Code | Description |
| AUTH_FAILURE | No permission |
| FAILED_OPERATION | Operation failed |
| OPERATION_TIMEOUT | Operation timed out |
| INVALID_PARAMETER | Invalid parameter |
| INVALID_PARAMETER_VALUE | Invalid parameter value |
| MISSING_PARAMETER | Missing parameter |
| LIMIT_EXCEEDED | Quota limit exceeded |
| RESOURCE_NOT_FOUND | Resource not found |
| RESOURCE_UNAVAILABLE | Resource unavailable |
| RESOURCE_INSUFFICIENT | Insufficient resource |
| RESOURCE_IN_USE | Resource is in use |
| RESOURCE_SOLD_OUT | Resource sold out |
| OPERATION_DENIED | Operation denied |
| UNAUTHORIZED_OPERATION | Unauthorized operation |
| UNKNOWN_PARAMETER | Unknown parameter |
| UNSUPPORTED_OPERATION | Operation not supported |
| DATA_SOURCE_OP_AUTH_FAILURE | Data source model authentication failed. Please configure proper role permissions in the User Permission module |
| FLEXDB_INTERNAL_ERROR | Cloud Database request error. Please check the parameters |
| FLEXDB_REQUEST_TIMEOUT | Request to the document database timed out. Please optimize your query or add indexes |
| AUTH_FAILURE_TOKEN_FAILURE | Token error |
| NO_SUCH_VERSION | The API version does not exist |
| REQUEST_LIMIT_EXCEEDED | The request exceeded the rate limit |
| FLEXDB_RESOURCE_OVERDUE | The database resource has expired or the database read/write count has exceeded the plan limit. Please upgrade the plan's read/write quota, or wait until the next day for the quota to reset. If you have any questions, please verify the resource on the Cloud Database platform |
| FLEXDB_READ_LIMIT | The database read count has reached the limit. Please upgrade the plan |
| FLEXDB_WRITE_LIMIT | The database write count has reached the limit. Please upgrade the plan |
| FAILED_OPERATION_CUSTOMIZED_METHODS_ERROR | Cloud Function error, user-defined method error |
| DATASOURCE_NOT_EXIST | Data source does not exist. Please verify the data source in the console |
| TABLE_NOT_EXIST | Table does not exist |
| FAILED_AGGREGATE | Aggregate query failed |
Authentication
- HTTP: Bearer Auth
- API Key: APIKey
Token corresponding to the environment ID, obtained through login authentication (v2)
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Tencent Cloud TC3-HMAC-SHA256 signature with Timestamp and Token appended to the end
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |