CloudBase 云 API（CloudAPI）清单
本页面由定时任务每日自动从腾讯云官方文档同步生成（脚本：
scripts/generate-api-reference.mjs），请勿手工编辑。
- 数据源：API 概览 · 依赖产品接口指引
- 所有接口均为腾讯云 API 3.0 管控面接口，支持各语言官方 SDK 调用；也可通过 CloudBase MCP 的
callCloudApi工具或 API Explorer 直接调用- 最近同步：2026-09-07
API 概览
环境相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeEnvs | 获取环境列表 | 100 |
| DestroyEnv | 销毁环境 | 20 |
| CheckTcbService | 检查是否开通Tcb服务 | 20 |
| CreateBillDeal | 创建计费订单 | 20 |
| DescribeBillingInfo | 获取计费相关信息 | 50 |
| DescribeEnvAccountCircle | 查询环境当前计费周期 | 20 |
| DescribeBaasPackageList | 获取新套餐 | 20 |
| DescribeStaticStore | 查看静态托管资源信息 | 20 |
| CreateStaticStore | 创建静态托管资源 | 200 |
| DescribeSafeRule | 查询数据库安全规则 | 20 |
| DescribeAuthDomains | 获取安全域名列表 | 20 |
| CreateAuthDomain | 增加安全域名 | 20 |
| ModifyEnv | 更新环境信息 | 50 |
| CreateHostingDomain | 创建托管域名 | 20 |
| DestroyStaticStore | 销毁静态托管资源 | 20 |
| DescribeEnvLimit | 查询环境个数上限接口 | 20 |
| DescribeHostingDomainTask | 查询静态托管域名任务状态 | 20 |
| DescribeQuotaData | 查询环境的配额使用量 | 2000 |
| BindStorageSource | 云存储绑定外部存储源 | 20 |
| ModifyStorageSource | 更新云存储外部数据源 | 20 |
| UnbindStorageSource | 解绑云存储外部云存储源 | 20 |
| CreateEnvResource | 创建环境相关资源 | 20 |
| AllocateEnv | 从环境池分配环境 | 3000 |
| ReleaseEnv | 释放从环境池里分配的环境 | 1000 |
| AssumeRoleForAllocatedEnv | 为环境池里的环境申请角色临时凭证 | 1000 |
用户权限相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DeleteUsers | 删除tcb用户 | 20 |
| CreateUser | 创建tcb用户 | 20 |
| DescribeUserList | 查询tcb用户列表 | 20 |
| ModifyUser | 更新tcb用户 | 20 |
| DescribeResourcePermission | 查询资源基础权限 | 20 |
| ModifyResourcePermission | 修改资源基础权限 | 20 |
云托管相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeCloudBaseRunServerVersion | 查询云托管服务版本的详情 | 1000 |
| DescribeCloudBaseBuildService | 获取云托管代码上传和下载url | 20 |
计费相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| CreateEnv | 创建环境 | 20 |
| ModifyEnvPlan | 更新云开发环境套餐 | 20 |
| RenewEnv | 续费云开发环境 | 20 |
| DescribeCreditsUsage | 获取资源点用量 | 20 |
| DescribeCreditsUsageDetail | 获取资源点用量明细 | 20 |
| DescribeEnvPlans | 查询环境套餐信息 | 20 |
其他接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeGatewayVersions | 查询网关版本信息 | 20 |
| ModifyClsTopic | 修改日志主题 | 20 |
| DescribeCurveData | 查询环境监控曲线 | 100 |
| DeleteAuthDomain | 删除合法域名 | 20 |
| DescribeCloudBaseRunBuildLog | 查询构建日志 | 20 |
服务操作相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| ModifySafeRule | 设置数据库安全规则 | - |
文档型云数据库相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| ModifyDatabaseACL | 修改文档型数据库权限 | 50 |
| DescribeDatabaseACL | 获取文档型数据库权限 | 50 |
| CreateTable | 创建文档型数据库表 | 20 |
| DeleteTable | 删除文档型数据库表 | 20 |
| DescribeTable | 查询文档型数据库表信息 | 20 |
| DescribeTables | 查询文档型数据库所有表信息 | 20 |
| ListTables | 查询文档型数据库所有表 | 20 |
| UpdateTable | 修改文档型数据库表索引信息 | 20 |
| RunCommands | 执行文档型数据库命令 | 1000 |
云项目相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeCloudAppCosInfo | 获取云应用cos信息 | 20 |
| CreateCloudApp | 创建云应用 | 20 |
| DeleteCloudApp | 删除云应用服务 | 20 |
| DeleteCloudAppVersion | 删除云应用服务版本 | 20 |
| DescribeCloudAppInfo | 查询云应用服务信息 | 20 |
| DescribeCloudAppList | 查询云应用服务列表 | 20 |
| DescribeCloudAppVersion | 查询云应用服务版本信息 | 20 |
| DescribeCloudAppVersionList | 查询云应用服务版本列表 | 20 |
云开发接入相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| CreateHTTPServiceRoute | 创建HTTP访问服务路由 | 20 |
| VerifyHTTPServiceRoute | 校验HTTP访问服务路由 | 20 |
| DeleteHTTPServiceRoute | 删除HTTP访问服务路由 | 20 |
| DescribeHTTPServiceRoute | 查询HTTP访问服务路由信息 | 20 |
| ModifyHTTPServiceRoute | 修改HTTP访问服务路由 | 20 |
tcb相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| ModifyEnvExtra | 修改环境额外配置 | 20 |
AI模型相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| CreateAIModel | 创建AI模型 | 20 |
| DeleteAIModel | 删除AI模型 | 20 |
| DescribeAIModels | 查询AI模型列表 | 20 |
| DescribeManagedAIModelList | 查询托管类型AI模型列表 | 20 |
| UpdateAIModel | 更新AI模型 | 20 |
云服务器相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| CreateVmInstance | 创建服务器实例 | 20 |
| DeleteVmInstance | 销毁服务器实例 | 20 |
| DescribeVmInstances | 查询环境下的服务器实例 | 20 |
| DescribeVmSpec | 获取VM规格 | 20 |
| InquireVmPrice | 查询云服务器价格 | 20 |
搜索日志相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| BindCls | 绑定用户自定义CLS日志主题 | 20 |
| SearchClsLog | 搜索CLS日志 | 20 |
SQL型云数据库相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| CreateMySQL | 开通 MySql | 20 |
| DescribePGUserMigration | 查看指定环境单条 migration 详情 | 20 |
| ListPGUserMigrations | 查询目标环境已应用的 Migration | 20 |
| PreviewPGUserMigrations | 预览SQL migrations 在远端的执行计划，不实际执行 SQL | 20 |
| PushPGUserMigrations | 批量应用 Migrations | 20 |
| RepairPGUserMigrationHistory | 修复Migration History | 20 |
| DescribeCreateMySQLResult | 开通 MySql 结果查询 | 20 |
| DescribeMySQLClusterDetail | 查询Mysql集群信息 | 20 |
| DescribeMySQLTaskStatus | 销毁Mysql结果查询 | 20 |
| DestroyMySQL | 销毁MySql | 20 |
| RunSql | 执行MySQL语句 | 100 |
| ExecutePGSql | 在PostgreSQL数据库上执行SQL查询 | 20 |
| ModifyPGInstanceSpec | 修改 PG 独享实例规格 | 20 |
登录配置相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| CreateCustomLoginKey | 自定义登录密钥生成 | 20 |
| DescribeClient | 查询应用客户端详情 | 20 |
| ModifyLoginConfig | 修改登录策略 | 20 |
| DescribeLoginConfig | 获取登录策略 | 20 |
| ModifyClient | 修改应用客户端 | 20 |
| GetProviders | 获取三方认证源列表 | 20 |
| ModifyProvider | 修改第三方认证源 | 20 |
| DeleteProvider | 删除第三方认证源 | 20 |
| AddProvider | 添加第三方认证源 | 20 |
| CreateApiKey | 创建云开发平台的API Key | 20 |
| DeleteApiKey | 删除云开发平台的API Key | 20 |
| DescribeApiKeyList | 查询云开发平台的API Key列表 | 20 |
注意：
以上给出的接口频率限制维度为
API + 接入地域 + 子账号，有关限频更多说明参考：API 频率限制说明
依赖产品接口指引
概述
云开发（Tencent CloudBase，TCB）是腾讯云提供的云原生一体化开发环境和工具平台，为开发者提供高可用、自动弹性扩缩的后端云服务，包含计算、存储、托管等 Serverless 化能力，可用于云端一体化开发多种端应用（小程序、公众号、Web 应用等），帮助开发者统一构建和管理后端服务和云资源，避免了应用开发过程中繁琐的服务器搭建及运维，开发者可以专注于业务逻辑的实现，开发门槛更低，效率更高。
本章节介绍的云开发 API 接口均为 API 3.0/API 2.0 等接口。
您可以调用 API 对云开发进行操作，例如获取用户权限，获取云开发项目列表等。
云开发支持的所有接口信息，请参见 API 概览。
云开发依赖资源接口指引
MySQL 数据库
说明：调用以下 MySQL 接口时，需要传入数据库集群 ID（
ClusterId）。您可以调用 DescribeMySQLClusterDetail 获取返回值中的DbClusterId字段作为ClusterId的值。
账号管理
| 接口名称 | 接口功能 |
|---|---|
| CreateAccounts | 创建用户账号 |
| DeleteAccounts | 删除用户账号 |
| DescribeAccountAllGrantPrivileges | 查询账号所有可授予权限 |
| DescribeAccountPrivileges | 查询账号已有权限 |
| DescribeAccounts | 查询数据库账号列表 |
| ModifyAccountDescription | 修改数据库账号描述信息 |
| ModifyAccountHost | 修改账号主机 |
| ModifyAccountParams | 修改账号配置 |
| ModifyAccountPrivileges | 修改账号库表权限 |
| ResetAccountPassword | 修改数据库账号密码 |
网络管理
| 接口名称 | 接口功能 |
|---|---|
| CloseWan | 关闭外网 |
| OpenWan | 开通外网 |
serverless集群管理
| 接口名称 | 接口功能 |
|---|---|
| ResumeServerless | 恢复serverless集群 |
备份与回档
| 接口名称 | 接口功能 |
|---|---|
| CreateBackup | 创建手动备份 |
| DeleteBackup | 删除手动备份 |
| ModifyBackupConfig | 修改自动备份配置信息 |
| DescribeBackupList | 查询备份文件列表 |
| DescribeBackupDownloadUrl | 查询备份下载地址 |
| RollBackCluster | 集群回档 |
任务与数据库管理
| 接口名称 | 接口功能 |
|---|---|
| DescribeTasks | 查询任务列表 |
| DescribeClusterDatabaseTables | 获取table列表 |
| DescribeClusterDatabases | 获取集群数据库列表 |
SCF 云函数
此外，调用云函数接口时还需传入以下两个参数：
Stamp：固定值
"MINI_QCBASE"Role：云函数执行角色名称。
⚠️ 安全提示：若您是普通用户（单环境账户），可直接传入默认角色
TCB_QcsRole，无需额外配置。若您是平台客户，通过环境划分管理多个小租户时，使用
TCB_QcsRole存在跨环境越权风险，建议为每个环境创建独立的自定义 CAM 角色：
- 前往 CAM 角色控制台 创建角色；
- 角色载体选择腾讯云产品服务；
- 服务授权对象勾选 SCF（云函数） 和 CLS（日志服务）；
- 关联策略
QcloudCLSFullAccess；- 记录角色名称（例如
SCF_CLSFullAccess），并将其作为Role参数的值传入。
| 接口名称 | 接口功能 |
|---|---|
| CreateFunction | 创建函数 |
| UpdateFunctionCode | 更新函数代码 |
| ListFunctions | 获取函数列表 |
| Invoke | 运行函数 |
| GetFunction | 获取函数详细信息 |
| GetFunctionAddress | 获取函数代码下载地址 |
| CreateTrigger | 设置函数触发方式 |
| DeleteTrigger | 删除触发器 |
| CopyFunction | 复制函数 |
| UpdateFunctionConfiguration | 更新函数配置 |
| DeleteFunction | 删除函数 |
COS 对象操作
说明：调用文件操作接口时，需根据上传目标获取对应的存储信息：
- 上传到静态托管：调用 DescribeEnvs 获取返回值中的
StaticStorages字段（StaticStorageInfo 结构），从中获取静态资源相关信息。- 上传到云存储：调用 DescribeEnvs 获取返回值中的
StorageInfo字段（StorageInfo 结构），从中获取云存储相关信息。
| Node SDK接口名称 | 接口功能 |
|---|---|
| uploadFile | 上传对象 |
| GetObject | 下载对象 |
| DeleteObject | 删除对象 |
| DeleteMultipleObjects | 批量删除对象 |
| PutObjectCopy | 移动/复制对象 |
| Select | 检索对象内容 |
API 快速入门
您可以使用 API Explorer 工具在线调用 API。
本文以 获取环境列表 为例，通过 API Explorer 工具调用 API 接口的步骤如下：
- 进入 API Explorer 工具页面。更多 API Explorer 工具使用信息，请参见 使用 API Explorer。
- 调用 DescribeEnvs，从而获取云开发环境相关信息。