跳到主要内容

CloudBase 云 API(CloudAPI)清单

  • 数据源:API 概览 · 依赖产品接口指引
  • 所有接口均为腾讯云 API 3.0 管控面接口,支持各语言官方 SDK 调用;也可通过 CloudBase MCP 的 callCloudApi 工具或 API Explorer 直接调用
  • 最近同步:2026-09-13

API 概览​

云开发接入相关接口​

接口名称接口功能频率限制(次/秒)
VerifyHTTPServiceRoute校验HTTP访问服务路由20
DeleteHTTPServiceRoute删除HTTP访问服务路由20
DescribeHTTPServiceRoute查询HTTP访问服务路由信息20
ModifyHTTPServiceRoute修改HTTP访问服务路由20
PurgeHTTPServiceCache清除HTTP服务域名缓存20
DescribeHTTPServiceCachePurgeTask查询HTTP访问服务缓存清除任务20

环境相关接口​

接口名称接口功能频率限制(次/秒)
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
ModifyEnvExtra修改环境额外配置20

用户权限相关接口​

接口名称接口功能频率限制(次/秒)
DeleteUsers删除 CloudBase 用户20
CreateUser创建 CloudBase 用户20
DescribeUserList查询 CloudBase 用户列表20
ModifyUser更新 CloudBase 用户20
DescribeResourcePermission查询资源基础权限20
ModifyResourcePermission修改资源基础权限20

HTTP网关相关接口​

接口名称接口功能频率限制(次/秒)
CreateHTTPServiceRoute创建HTTP访问服务路由20

云托管相关接口​

接口名称接口功能频率限制(次/秒)
DescribeCloudBaseRunServerVersion查询云托管服务版本的详情1000
DescribeCloudBaseBuildService获取云托管代码上传和下载url20

计费相关接口​

接口名称接口功能频率限制(次/秒)
CreateEnv创建环境20
ModifyEnvPlan更新云开发环境套餐20
RenewEnv续费云开发环境20
DescribeCreditsUsage获取资源点用量20
DescribeCreditsUsageDetail获取资源点用量明细20
DescribeEnvPlans查询环境套餐信息20

其他接口​

接口名称接口功能频率限制(次/秒)
DescribeGatewayVersions查询网关版本信息20
ModifyClsTopic修改日志主题20
DescribeCurveData查询环境监控曲线100
DeleteAuthDomain删除合法域名20
DescribeCloudBaseRunBuildLog查询构建日志20

文档型云数据库相关接口​

接口名称接口功能频率限制(次/秒)
ModifyDatabaseACL修改文档型数据库权限50
DescribeDatabaseACL获取文档型数据库权限50
CreateTable创建文档型数据库表20
DeleteTable删除文档型数据库表20
DescribeTable查询文档型数据库表信息20
DescribeTables查询文档型数据库所有表信息20
ListTables查询文档型数据库所有表20
UpdateTable修改文档型数据库表索引信息20
RunCommands执行文档型数据库命令1000
ModifySafeRule设置数据库安全规则-

静态托管相关接口​

接口名称接口功能频率限制(次/秒)
DescribeCloudAppCosInfo获取云应用cos信息20
CreateCloudApp创建云应用20
DeleteCloudApp删除云应用服务20
DeleteCloudAppVersion删除云应用服务版本20
DescribeCloudAppInfo查询云应用服务信息20
DescribeCloudAppList查询云应用服务列表20
DescribeCloudAppVersion查询云应用服务版本信息20
DescribeCloudAppVersionList查询云应用服务版本列表20

AI模型相关接口​

接口名称接口功能频率限制(次/秒)
CreateAIModel创建AI模型20
DeleteAIModel删除AI模型20
DescribeAIModels查询AI模型列表20
DescribeManagedAIModelList查询托管类型AI模型列表20
UpdateAIModel更新AI模型20

CloudBase 相关接口​

接口名称接口功能频率限制(次/秒)
UpdateFunctionCode更新云函数代码20

搜索日志相关接口​

接口名称接口功能频率限制(次/秒)
BindCls绑定用户自定义CLS日志主题20
SearchClsLog搜索CLS日志20

SQL型云数据库相关接口​

接口名称接口功能频率限制(次/秒)
CreateMySQL开通 MySql20
DescribePGUserMigration查看指定环境单条 migration 详情20
ListPGUserMigrations查询目标环境已应用的 Migration20
PreviewPGUserMigrations预览SQL migrations 在远端的执行计划,不实际执行 SQL20
PushPGUserMigrations批量应用 Migrations20
RepairPGUserMigrationHistory修复Migration History20
DescribeCreateMySQLResult开通 MySql 结果查询20
DescribeMySQLClusterDetail查询Mysql集群信息20
DescribeMySQLTaskStatus销毁Mysql结果查询20
DestroyMySQL销毁MySql20
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 Key20
DeleteApiKey删除云开发平台的API Key20
DescribeApiKeyList查询云开发平台的API Key列表20

云函数相关接口​

接口名称接口功能频率限制(次/秒)
CreateFunction创建云函数20
DeleteFunction删除云函数20
UpdateFunctionConfiguration更新函数配置20
ListFunctions获取函数列表20
GetFunction获取云函数详情20
DownloadFunction获取云函数地址并下载20

注意:

以上给出的接口频率限制维度为API + 接入地域 + 子账号,有关限频更多说明参考:API 频率限制说明

依赖产品接口指引​

概述​

云开发(Tencent CloudBase)是腾讯云提供的云原生一体化开发环境和工具平台,为开发者提供高可用、自动弹性扩缩的后端云服务,包含计算、存储、托管等 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 角色:

    1. 前往 CAM 角色控制台 创建角色;
    2. 角色载体选择腾讯云产品服务;
    3. 服务授权对象勾选 SCF(云函数) 和 CLS(日志服务);
    4. 关联策略 QcloudCLSFullAccess;
    5. 记录角色名称(例如 SCF_CLSFullAccess),并将其作为 Role 参数的值传入。
接口名称接口功能
CreateFunction创建函数
UpdateFunctionCode更新函数代码
ListFunctions获取函数列表
Invoke运行函数
GetFunction获取函数详细信息
GetFunctionAddress获取函数代码下载地址
CreateTrigger设置函数触发方式
DeleteTrigger删除触发器
CopyFunction复制函数
UpdateFunctionConfiguration更新函数配置
DeleteFunction删除函数

COS 对象操作​

说明:调用文件操作接口时,需根据上传目标获取对应的存储信息:

Node SDK接口名称接口功能
uploadFile上传对象
GetObject下载对象
DeleteObject删除对象
DeleteMultipleObjects批量删除对象
PutObjectCopy移动/复制对象
Select检索对象内容

API 快速入门​

您可以使用 API Explorer 工具在线调用 API。
本文以 获取环境列表 为例,通过 API Explorer 工具调用 API 接口的步骤如下:

  1. 进入 API Explorer 工具页面。更多 API Explorer 工具使用信息,请参见 使用 API Explorer。
  2. 调用 DescribeEnvs,从而获取云开发环境相关信息。