跳到主要内容
Version: 1.0.0

NoSQL RESTful API

功能介绍​

文档型数据库（NoSQL）的 RESTful HTTP API，提供集合管理、文档 CRUD、聚合查询、事务操作和数据库命令执行等功能。

请求域名​

https://{envId}.api.tcloudbasegateway.com/v1/database/instances/{instance}/databases/{database}/

URL 路径参数说明：

  • envId：环境 ID
  • instance：实例 ID，不能为空。如访问默认实例，则值为 (default)（注意左右括号是值的一部分，需要完整输入）
  • database：数据库名称，不能为空。如访问默认数据库，则值为 (default)（注意左右括号是值的一部分，需要完整输入）

示例：

  • 访问默认实例的默认数据库：/v1/database/instances/(default)/databases/(default)/
  • 访问实例 test_instance 的默认数据库：/v1/database/instances/test_instance/databases/(default)/
  • 访问实例 test_instance 的数据库 mydb：/v1/database/instances/test_instance/databases/mydb/

EJSON 格式​

请求体支持 Relaxed EJSON 和 Strict EJSON 格式，响应体强制为 Strict EJSON 格式。

EJSON (Extended JSON) 是 MongoDB 的扩展 JSON 格式，支持标准 JSON 不支持的数据类型：

  • ObjectId：{"$oid": "507f1f77bcf86cd799439011"}
  • Date：{"$date": {"$numberLong": "1736929200000"}}
  • Int：{"$numberInt": "12345"}
  • Long：{"$numberLong": "9223372036854775807"}
  • Decimal128：{"$numberDecimal": "123.456"}
  • Binary：{"$binary": {"base64": "...", "subType": "00"}}
  • RegExp：{"$regex": "pattern", "$options": "i"}

接入指引​

调用以下接口需要传递 AccessToken，格式如 Authorization: Bearer <token>。Token 获取方式参考：https://docs.cloudbase.net/http-api/basic/access-token

错误码与 HTTP 状态码​

错误码HTTP 状态码说明
INVALID_PARAM400参数无效或缺失
DATABASE_PERMISSION_DENIED401数据库权限被拒绝
DATABASE_INVALID_OPERRATOR403不支持的操作
DATABASE_COLLECTION_NOT_EXIST404集合不存在
DOCUMENT_NOT_FOUND404文档不存在（仅单文档操作）
DATABASE_COLLECTION_ALREADY_EXIST409集合已存在
DATABASE_DUPLICATE_WRITE409唯一索引冲突
EXCEED_REQUEST_LIMIT422请求配额超限
EXCEED_CONCURRENT_REQUEST_LIMIT422并发连接数超限
DATABASE_REQUEST_FAILED500数据库请求失败
SYS_ERR500系统内部错误
DATABASE_TRANSACTION_CONFLICT503事务冲突
DATABASE_TRANSACTION_FAIL503事务执行失败
DATABASE_TIMEOUT504数据库操作超时