Version: 1.0.0
数据模型 OpenAPI
功能介绍
这里给出了数据模型所有操作的API,以及每个API的参数参考。
接入指引
调用以下接口需要传递 AccessToken,格式如Authorization: Bearer <token>
。Token 获取方式参考:https://docs.cloudbase.net/http-api/basic/access-token
HTTP 状态码
只会出现2xx
状态码。数据模型API的业务错误会在2xx
状态码中通过响应体指示,应当视情况处理。
错误码
以下列出了该系列 API 特定的错误码,完整列表参考:https://docs.cloudbase.net/error-code/service
错误码 | 含义 |
AUTH_FAILURE | 没有权限 |
FAILED_OPERATION | 操作失败 |
OPERATION_TIMEOUT | 操作超时 |
INVALID_PARAMETER | 参数错误 |
INVALID_PARAMETER_VALUE | 参数取值错误 |
MISSING_PARAMETER | 缺少参数错误 |
LIMIT_EXCEEDED | 超过配额限制 |
RESOURCE_NOT_FOUND | 资源不存在 |
RESOURCE_UNAVAILABLE | 资源不可用 |
RESOURCE_INSUFFICIENT | 资源不足 |
RESOURCE_IN_USE | 资源被占用 |
RESOURCE_SOLD_OUT | 资源售罄 |
OPERATION_DENIED | 操作被拒绝 |
UNAUTHORIZED_OPERATION | 未授权操作 |
UNKNOWN_PARAMETER | 未知参数错误 |
UNSUPPORTED_OPERATION | 操作不支持 |
DATA_SOURCE_OP_AUTH_FAILURE | 数据源模型作鉴权失败,请在用户权限模块设置对应角色合理权限 |
FLEXDB_INTERNAL_ERROR | 请求云数据库错误,请检查参数 |
FLEXDB_REQUEST_TIMEOUT | 请求Mongo数据库超时。请优化您的查询,或者添加索引 |
AUTH_FAILURE_TOKEN_FAILURE | token错误 |
NO_SUCH_VERSION | 接口版本不存在 |
REQUEST_LIMIT_EXCEEDED | 请求的次数超过了频率限制 |
FLEXDB_RESOURCE_OVERDUE | 数据库资源到期或者数据库读写次数超过套餐包限制。请升级套餐读写次数,或者等待第二天重置读写次数。如有问题,请在云数据库平台核对资源 |
FLEXDB_READ_LIMIT | 数据库读取次数超过上限,请升级套餐包 |
FLEXDB_WRITE_LIMIT | 数据库写入次数超过上限,请升级套餐包 |
FAILED_OPERATION_CUSTOMIZED_METHODS_ERROR | 云函数错误,用户自定义方法错误 |
DATASOURCE_NOT_EXIST | 数据源不存在,请在控制台数据源检查对应数据源是否存在 |
TABLE_NOT_EXIST | 表不存在 |
FAILED_AGGREGATE | 聚合查询失败 |
Authentication
- HTTP: Bearer Auth
- API Key: APIKey
环境 ID 所对应的 token,使用登录鉴权(v2)获取
Security Scheme Type: | http |
---|---|
HTTP Authorization Scheme: | bearer |
TC3-HMAC-SHA256开头的腾讯云 3.0 版签名,将 Timestamp 和 Token 拼接在签名最后
Security Scheme Type: | apiKey |
---|---|
Header parameter name: | Authorization |