CloudBase Cloud API (CloudAPI) Reference

This page is automatically generated daily from the official Tencent Cloud documentation by a scheduled task (script: scripts/generate-api-reference.mjs). Do not edit manually.

• Data sources: API Overview · Dependent Product API Guide
• All APIs are Tencent Cloud API 3.0 management-plane APIs, callable via official SDKs in any language; they can also be called through the CloudBase MCP callCloudApi tool or API Explorer
• Last synced: 2026-09-07

API Overview

Environment APIs

API Name	Description	Rate Limit (req/s)
DescribeEnvs	List environments	100
DestroyEnv	Destroy environment	20
CheckTcbService	Check if TCB service is enabled	20
CreateBillDeal	Create billing order	20
DescribeBillingInfo	Get billing information	50
DescribeEnvAccountCircle	Query environment current billing cycle	20
DescribeBaasPackageList	Get plan packages	20
DescribeStaticStore	Query static hosting resource info	20
CreateStaticStore	Create static hosting resources	200
DescribeSafeRule	Query database security rules	20
DescribeAuthDomains	List authorized domains	20
CreateAuthDomain	Add authorized domain	20
ModifyEnv	Update environment info	50
CreateHostingDomain	Create hosting domain	20
DestroyStaticStore	Destroy static hosting resources	20
DescribeEnvLimit	Query environment count limit	20
DescribeHostingDomainTask	Query static hosting domain task status	20
DescribeQuotaData	Query environment quota usage	2000
BindStorageSource	Bind external storage source to cloud storage	20
ModifyStorageSource	Update cloud storage external data source	20
UnbindStorageSource	Unbind external cloud storage source	20
CreateEnvResource	Create environment-related resources	20
AllocateEnv	Allocate environment from pool	3000
ReleaseEnv	Release environment allocated from pool	1000
AssumeRoleForAllocatedEnv	Request role temporary credentials for pooled environment	1000

User Permission APIs

API Name	Description	Rate Limit (req/s)
DeleteUsers	Delete TCB users	20
CreateUser	Create TCB user	20
DescribeUserList	List TCB users	20
ModifyUser	Update TCB user	20
DescribeResourcePermission	Query resource permissions	20
ModifyResourcePermission	Modify resource permissions	20

CloudBase Run APIs

API Name	Description	Rate Limit (req/s)
DescribeCloudBaseRunServerVersion	Query CloudBase Run service version details	1000
DescribeCloudBaseBuildService	Get CloudBase Run code upload and download URLs	20

Billing APIs

API Name	Description	Rate Limit (req/s)
CreateEnv	Create environment	20
ModifyEnvPlan	Update CloudBase environment plan	20
RenewEnv	Renew CloudBase environment	20
DescribeCreditsUsage	Get credits usage	20
DescribeCreditsUsageDetail	Get credits usage details	20
DescribeEnvPlans	Query environment plan info	20

Other APIs

API Name	Description	Rate Limit (req/s)
DescribeGatewayVersions	Query gateway version info	20
ModifyClsTopic	Modify log topic	20
DescribeCurveData	Query environment monitoring curves	100
DeleteAuthDomain	Delete authorized domain	20
DescribeCloudBaseRunBuildLog	Query build logs	20

Service Operation APIs

API Name	Description	Rate Limit (req/s)
ModifySafeRule	Set database security rules	-

Document Database APIs

API Name	Description	Rate Limit (req/s)
ModifyDatabaseACL	Modify document database permissions	50
DescribeDatabaseACL	Get document database permissions	50
CreateTable	Create document database collection	20
DeleteTable	Delete document database collection	20
DescribeTable	Query document database collection info	20
DescribeTables	Query all document database collection info	20
ListTables	List document database collections	20
UpdateTable	Modify document database collection index info	20
RunCommands	Execute document database commands	1000

Cloud App APIs

API Name	Description	Rate Limit (req/s)
DescribeCloudAppCosInfo	Get CloudApp COS info	20
CreateCloudApp	Create CloudApp	20
DeleteCloudApp	Delete CloudApp service	20
DeleteCloudAppVersion	Delete CloudApp service version	20
DescribeCloudAppInfo	Query CloudApp service info	20
DescribeCloudAppList	List CloudApp services	20
DescribeCloudAppVersion	Query CloudApp service version info	20
DescribeCloudAppVersionList	List CloudApp service versions	20

CloudBase Access APIs

API Name	Description	Rate Limit (req/s)
CreateHTTPServiceRoute	Create HTTP service route	20
VerifyHTTPServiceRoute	Verify HTTP service route	20
DeleteHTTPServiceRoute	Delete HTTP service route	20
DescribeHTTPServiceRoute	Query HTTP service route info	20
ModifyHTTPServiceRoute	Modify HTTP service route	20

TCB APIs

API Name	Description	Rate Limit (req/s)
ModifyEnvExtra	Modify environment extra configuration	20

AI Model APIs

API Name	Description	Rate Limit (req/s)
CreateAIModel	Create AI model	20
DeleteAIModel	Delete AI model	20
DescribeAIModels	List AI models	20
DescribeManagedAIModelList	List managed AI models	20
UpdateAIModel	Update AI model	20

Cloud Server APIs

API Name	Description	Rate Limit (req/s)
CreateVmInstance	Create VM instance	20
DeleteVmInstance	Destroy VM instance	20
DescribeVmInstances	List VM instances in environment	20
DescribeVmSpec	Get VM specifications	20
InquireVmPrice	Query VM pricing	20

Log Search APIs

API Name	Description	Rate Limit (req/s)
BindCls	Bind custom CLS log topic	20
SearchClsLog	Search CLS logs	20

SQL Database APIs

API Name	Description	Rate Limit (req/s)
CreateMySQL	Enable MySQL	20
DescribePGUserMigration	View single PG migration details for environment	20
ListPGUserMigrations	List applied PG migrations for environment	20
PreviewPGUserMigrations	Preview SQL migration execution plan (dry run)	20
PushPGUserMigrations	Batch apply migrations	20
RepairPGUserMigrationHistory	Repair migration history	20
DescribeCreateMySQLResult	Query MySQL creation result	20
DescribeMySQLClusterDetail	Query MySQL cluster info	20
DescribeMySQLTaskStatus	Query MySQL destruction result	20
DestroyMySQL	Destroy MySQL	20
RunSql	Execute MySQL statement	100
ExecutePGSql	Execute SQL query on PostgreSQL	20
ModifyPGInstanceSpec	Modify PG dedicated instance spec	20

Login Configuration APIs

API Name	Description	Rate Limit (req/s)
CreateCustomLoginKey	Generate custom login key	20
DescribeClient	Query app client details	20
ModifyLoginConfig	Modify login policy	20
DescribeLoginConfig	Get login policy	20
ModifyClient	Modify app client	20
GetProviders	List third-party auth providers	20
ModifyProvider	Modify third-party auth provider	20
DeleteProvider	Delete third-party auth provider	20
AddProvider	Add third-party auth provider	20
CreateApiKey	Create CloudBase API Key	20
DeleteApiKey	Delete CloudBase API Key	20
DescribeApiKeyList	List CloudBase API Keys	20

Note:

The rate limits above are per API + access region + sub-account. For more details on rate limiting, see: API Rate Limit Guide

Dependent Product API Guide

Overview

CloudBase (Tencent CloudBase, TCB) is a cloud-native integrated development environment and tool platform provided by Tencent Cloud. It offers developers a highly available, auto-scaling serverless backend service including compute, storage, and hosting capabilities. It can be used for cloud-integrated development of various client applications (Mini Programs, Official Accounts, Web apps, etc.), helping developers build and manage backend services and cloud resources in one place, avoiding the complexity of server setup and operations so they can focus on business logic.

The CloudBase APIs described in this section are all API 3.0/API 2.0 interfaces. You can call these APIs to operate CloudBase, for example to get user permissions or list CloudBase projects. For all supported APIs, see API Overview.

CloudBase Dependent Resource API Guide

MySQL Database

Note: When calling the following MySQL APIs, you need to pass the database cluster ID (ClusterId). You can call DescribeMySQLClusterDetail and use the DbClusterId field from the response as the value for ClusterId.

Account Management

API Name	Description
CreateAccounts	Create user accounts
DeleteAccounts	Delete user accounts
DescribeAccountAllGrantPrivileges	Query all grantable privileges for an account
DescribeAccountPrivileges	Query existing privileges for an account
DescribeAccounts	List database accounts
ModifyAccountDescription	Modify database account description
ModifyAccountHost	Modify account host
ModifyAccountParams	Modify account parameters
ModifyAccountPrivileges	Modify account database/table privileges
ResetAccountPassword	Reset database account password

Network Management

API Name	Description
CloseWan	Disable public network access
OpenWan	Enable public network access

Serverless Cluster Management

API Name	Description
ResumeServerless	Resume serverless cluster

Backup and Rollback

API Name	Description
CreateBackup	Create manual backup
DeleteBackup	Delete manual backup
ModifyBackupConfig	Modify auto-backup configuration
DescribeBackupList	List backup files
DescribeBackupDownloadUrl	Get backup download URL
RollBackCluster	Cluster rollback

Task and Database Management

API Name	Description
DescribeTasks	List tasks
DescribeClusterDatabaseTables	Get table list
DescribeClusterDatabases	Get cluster database list

SCF Cloud Functions

Additionally, when calling cloud function APIs you need to pass these two parameters:

• Stamp: Fixed value "MINI_QCBASE"

• Role: Cloud function execution role name.

  ⚠️ Security note: If you are a regular user (single-environment account), you can directly use the default role TCB_QcsRole with no extra configuration.

  If you are a platform customer managing multiple tenants via environment isolation, using TCB_QcsRole poses a cross-environment privilege escalation risk. It is recommended to create an independent custom CAM role for each environment:

  1. Go to the CAM Role Console to create a role;
  2. Select Tencent Cloud Product Service as the role entity;
  3. Check SCF (Cloud Functions) and CLS (Log Service) as the authorized services;
  4. Attach the policy QcloudCLSFullAccess;
  5. Note the role name (e.g. SCF_CLSFullAccess) and pass it as the Role parameter value.

API Name	Description
CreateFunction	Create function
UpdateFunctionCode	Update function code
ListFunctions	List functions
Invoke	Invoke function
GetFunction	Get function details
GetFunctionAddress	Get function code download URL
CreateTrigger	Create function trigger
DeleteTrigger	Delete trigger
CopyFunction	Copy function
UpdateFunctionConfiguration	Update function configuration
DeleteFunction	Delete function

COS Object Operations

Note: When calling file operation APIs, you need to obtain the corresponding storage information based on the upload target:

• Upload to static hosting: Call DescribeEnvs and use the StaticStorages field from the response (StaticStorageInfo structure) for static resource info.
• Upload to cloud storage: Call DescribeEnvs and use the StorageInfo field from the response (StorageInfo structure) for cloud storage info.

Node SDK API Name	Description
uploadFile	Upload object
GetObject	Download object
DeleteObject	Delete object
DeleteMultipleObjects	Batch delete objects
PutObjectCopy	Move/copy object
Select	Select object content

API Quick Start

You can use the API Explorer tool to call APIs online. This example uses List Environments to demonstrate calling an API via API Explorer:

1. Go to the API Explorer tool page. For more information about API Explorer, see Using API Explorer.
2. Call DescribeEnvs to retrieve CloudBase environment information.