简介

最近更新时间:2026-03-13 02:04:37

我的收藏

概述

云开发(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 开通外网

备份与回档

接口名称 接口功能
CreateBackup 创建手动备份
DeleteBackup 删除手动备份
ModifyBackupConfig 修改自动备份配置信息
DescribeBackupList 查询备份文件列表
DescribeBackupDownloadUrl 查询备份下载地址
RollBackCluster 集群回档

任务与数据库管理

接口名称 接口功能
DescribeTasks 查询任务列表
DescribeClusterDatabaseTables 获取table列表
DescribeClusterDatabases 获取集群数据库列表

SCF 云函数

说明:调用以下云函数接口时,需要传入函数所属命名空间(Namespace)。您可以调用 DescribeEnvs 获取返回值中的 EnvId 字段作为 Namespace 的值。

此外,调用云函数接口时还需传入以下两个固定参数:

  • Role: "TCB_QcsRole"
  • Stamp: "MINI_QCBASE"
接口名称 接口功能
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,从而获取云开发环境相关信息。