tencent cloud

腾讯云数据仓库 TCHouse-D

产品简介
产品概述
基本概念
集群架构
产品优势
应用场景
购买指南
计费概述
续费说明
到期与欠费说明
退费说明
配置变更计费说明
快速入门
通过控制台使用腾讯云数据仓库 TCHouse-D
通过客户端使用腾讯云数据仓库 TCHouse-D
操作指南
集群操作
监控和告警配置
账户权限管理
数据管理
查询管理
配置管理
节点管理
日志分析
SQL 工作区
开启资源隔离
开发指南
数据表设计
数据导入
数据导出
基础功能
查询优化
生态扩展功能
API 文档
History
Introduction
API Category
Making API Requests
Cluster Operation APIs
Database and Table APIs
Cluster Information Viewing APIs
Hot-Cold Data Layering APIs
Database and Operation Audit APIs
User and Permission APIs
Resource Group Management APIs
Data Types
Error Codes
云上生态
为子账号授予 CAM 策略
查询加速腾讯云 DLC
实践教程
基本功能使用
高级特性使用
资源规格选型及调优建议
命名规范及库表限制
表设计与数据导入
查询调优
建议规避的用法
通过 JDBC 方式公网访问 TCHouse-D
性能测试
TPC-H 性能测试
SSB 性能测试
TPC-DS 性能测试
常见问题
常见操作问题
常见报错
联系我们
词汇表
产品协议
服务等级协议
隐私政策
数据处理和安全协议

API Category

聚焦模式
字号
最后更新时间: 2025-10-30 21:32:00

Cluster Operation APIs

API Name Feature Frequency Limit (maximum requests per second)
ModifyClusterConfigs Modifies the cluster configuration file 20
ModifyInstanceKeyValConfigs Modifies the BE or FE configuration 20
ModifyNodeStatus Changes the node status 20
RestartClusterForConfigs Restarts the cluster to make the configuration file take effect 20
RestartClusterForNode Rolling restart of the cluster 20
CreateInstanceNew Creates clusters 20
DestroyInstance Terminates clusters 20
ModifySecurityGroups Edits security groups 20
ReduceInstance Scales in clusters 20
ResizeDisk Expands cloud disks 20
ScaleOutInstance Scales out horizontally 20
ScaleUpInstance Scales up/down computing resources 20
DescribeClusterConfigsHistory Obtains the modification history of cluster configuration files 20
ModifyInstance Modifies the cluster's name 20
DescribeCreateTablesDDL Obtains the table creation DDL 20
DescribeInstanceOperationHistory Queries operation logs of the Doris cluster 20

Database and Table APIs

API Name Feature Frequency Limit (maximum requests per second)
CopyTableDatas Copies tables 20
CreateDatabase Creates databases 20
CreateTable Creates tables 20
DeleteTable Deletes the specified table in the specified database 20
DescribeDatabase Obtains database information 20
DescribeTable Obtains the table information 20
DescribeTableList Obtains the list of tables 20
ExecuteParametrizedQuery SQL query statement with parameters 20
ExecuteSelectQuery Executes SQL query 20
QueryTableData Queries table data 20
InsertDatasToTable Inserts data 20
UpdateTableSchema Modifies table attributes 20
UpdateDatabase Updates the database 20

Cluster Information Viewing APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeClusterConfigs Obtains the cluster configuration file 20
DescribeAreaRegion Obtains the list of regions 20
DescribeInstancesHealthState Checks cluster health 20
DescribeSpec Obtains cluster specifications 20
DescribeInstance Accesses cluster description information 20
DescribeInstanceState Gets cluster status 20
DescribeInstances Gets the list of clusters 20
DescribeInstanceNodesInfo Gets BE and FE node roles 20
DescribeInstanceUsedSubnets Obtains the information of subnets used by the cluster 20
DescribeSqlApis Queries cluster information through SQL 20
DescribeInstanceNodes Gets the list of cluster node information 20
DescribeInstanceNodesRole Obtains cluster node roles 20

Backup Recovery and Cross-Cluster Migration APIs

API Name Feature Frequency Limit (maximum requests per second)
CancelBackupJob Cancels backup instances 20
CreateBackUpSchedule Creates or modifies backup policies 20
DeleteBackUpData Deletes a backup instance 20
DescribeBackUpJob Queries the list of backup instances 20
DescribeBackUpJobDetail Queries backup task details 20
DescribeBackUpTables Obtains the information of the table available for backup 20
DescribeBackUpTaskDetail Queries the progress details of backup tasks 20
DescribeRestoreTaskDetail Queries the progress details of the recovery task 20
DescribeBackUpSchedules Obtains backup and migration tasks 20
RecoverBackUpJob Recovers the data that has been backed up 20

Hot-Cold Data Layering APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateCoolDownPolicy Creates a hot/cold data layering policy 20
ModifyCoolDownPolicy Modifies hot/cold data layering policy 20
OpenCoolDown Enables hot/cold data layering 20
OpenCoolDownPolicy Enables the hot/cold data layering policy 20
UpdateCoolDown Updates the hot/cold data layering information on a cluster 20
CheckCoolDownWorkingVariableConfigCorrect Checks whether variables and configurations for hot/cold data layering are correct 20
DescribeCoolDownBackends Queries the list of backend nodes supporting hot/cold data layering 20
DescribeCoolDownPolicies Queries the list of hot/cold data layering policies 20
DescribeCoolDownTableData Queries the layered hot and cold data in a table 20

Database and Operation Audit APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeInstanceOperations Obtains cluster operation audit records 20
DescribeDatabaseAuditDownload Downloads database audit logs 20
DescribeDatabaseAuditRecords Gets database audit records 20
DescribeSlowQueryRecords Gets the slow log list 20
DescribeSlowQueryRecordsDownload Downloads slow log files 20
DescribeQueryAnalyse Queries and analyzes 20

User and Permission APIs

API Name Feature Frequency Limit (maximum requests per second)
ActionAlterUser Adds and modifies a user 20
ModifyUserPrivilegesV3 Modifies permissions 20
DescribeUserPolicy Describes user permissions 20
ModifyDatabaseTableAccess Modifies database and table permissions 20

Resource Group Management APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeUserBindWorkloadGroup Obtains the resource group information bound to the user 20
CreateWorkloadGroup Creates resource groups 20
DeleteWorkloadGroup Deletes resource groups 20
DescribeWorkloadGroup Obtains the resource group information 20
ModifyWorkloadGroup Modifies resource group information 20
ModifyUserBindWorkloadGroup Modifies the resource group bound to the user 20
ModifyWorkloadGroupStatus Enables or disables resource groups 20

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈