{ "name": "cdwdoris", "display_name": "腾讯云数据仓库 TCHouse-D", "description": "腾讯云数据仓库 TCHouse-D（Tencent Cloud House-D，TCHouse-D）基于业内领先的 OLAP 数据库 Apache Doris 内核构建，兼容 MySQL 协议，融合云上大数据生态，提供丰富的集群管控能力及完善的巡检告警体系，为客户提供简单易用、轻松运维的云上全托管服务，助力客户快速进行实时 OLAP 数据分析。", "domain": "database", "api_version": "2021-12-28", "endpoint": "cdwdoris.tencentcloudapi.com", "actions": [ { "name": "ActionAlterUser", "description": "新增和修改用户接口", "status": "online", "parameters": [ { "name": "UserInfo", "type": "object", "required": true, "description": "用户信息", "example": "cdwch-xxxx", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例id", "example": "cdwch-xxxx" }, { "name": "UserName", "type": "string", "required": true, "description": "用户名", "example": "username1" }, { "name": "PassWord", "type": "string", "required": true, "description": "base64加密后的密码", "example": "pwd1" }, { "name": "WhiteHost", "type": "string", "required": false, "description": "用户链接来自的 IP地址", "example": "10.0.2.123" }, { "name": "OldWhiteHost", "type": "string", "required": false, "description": "修改前用户链接来自的 IP", "example": "10.0.2.1" }, { "name": "Describe", "type": "string", "required": false, "description": "描述", "example": "\"this is user desc\"" }, { "name": "OldPwd", "type": "string", "required": false, "description": "旧密码", "example": "pwd—***" }, { "name": "CamUin", "type": "string", "required": false, "description": "绑定的子用户uin", "example": "123124123" }, { "name": "CamRangerGroupIds", "type": "array", "required": false, "description": "ranger group id列表", "example": "1", "item_type": "integer" }, { "name": "ComputeGroupType", "type": "integer", "required": false, "description": "0: 灵活场景 1: 固定场景", "example": "0" } ] }, { "name": "ApiType", "type": "string", "required": true, "description": "api接口类型", "example": "AddSystemUser" }, { "name": "UserPrivilege", "type": "integer", "required": false, "description": "用户权限类型 0:普通用户 1:管理员", "example": "1" }, { "name": "ComputeGroups", "type": "array", "required": false, "description": "计算组列表", "example": "[\"cp1\"]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": false, "description": "集群ID", "example": "cdwdoris-xxx" } ], "required": [ "UserInfo", "ApiType" ] }, { "name": "CancelBackupJob", "description": "取消对应的备份实例任务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-nep182pz" }, { "name": "BackUpJobId", "type": "integer", "required": false, "description": "需要取消的备份实例id", "example": "1321" } ], "required": [ "InstanceId" ] }, { "name": "CheckCoolDownWorkingVariableConfigCorrect", "description": "查询冷热分层生效变量和配置是否正确", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "集群id", "example": "cdwdoris-asdff1x" } ], "required": [] }, { "name": "CreateBackUpSchedule", "description": "创建或者修改备份策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "\"cdwch-xxx\"" }, { "name": "OperationType", "type": "string", "required": true, "description": "操作类型 create(创建) update(编辑修改)", "example": "\"create\"" }, { "name": "ScheduleId", "type": "integer", "required": false, "description": "编辑时需要传", "example": "17624" }, { "name": "BackUpTables", "type": "array", "required": false, "description": "备份表列表", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库", "example": "db_name" }, { "name": "Table", "type": "string", "required": true, "description": "表", "example": "test123" }, { "name": "TotalBytes", "type": "integer", "required": true, "description": "表总字节数", "example": "23124" }, { "name": "SingleReplicaBytes", "type": "string", "required": false, "description": "表单个副本的大小", "example": "1458" }, { "name": "BackupStatus", "type": "integer", "required": false, "description": "备份状态", "example": "2" }, { "name": "BackupErrorMsg", "type": "string", "required": false, "description": "备份的错误信息", "example": "error" }, { "name": "IsOpenCoolDown", "type": "boolean", "required": false, "description": "该库表是否绑定降冷策略", "example": "true" } ] }, { "name": "BackupTimeType", "type": "integer", "required": false, "description": "0为周期备份。1时是立即备份。3时是定时备份。", "example": "1" }, { "name": "ScheduleName", "type": "string", "required": false, "description": "调度任务名", "example": "表1备份" }, { "name": "ScheduleInfo", "type": "object", "required": false, "description": "调度信息", "example": "无", "children": [ { "name": "EffectivePeriod", "type": "string", "required": false, "description": "生效周期", "example": "2023-09-07 00:00:00~2023-09-21 00:00:00\t" }, { "name": "ScheduleType", "type": "string", "required": false, "description": "调度类型，不传该参数时为立即执行： Day-天 Week-周 Month-月 Quarter-季度 Year-年 Once-单次", "example": "Day" }, { "name": "ScheduleData", "type": "string", "required": false, "description": "执行调度的日期。调度类型为周和月时以英文逗号分隔；调度类型为单次时，该值是个日期", "example": "3,4,5" }, { "name": "ScheduleHour", "type": "integer", "required": false, "description": "执行时间：时", "example": "11" }, { "name": "ScheduleMin", "type": "integer", "required": false, "description": "执行时间：分", "example": "30" }, { "name": "BackupScope", "type": "string", "required": false, "description": "备份粒度： All-全量 Database-按库 Table-按表", "example": "All" }, { "name": "BackupDatabase", "type": "string", "required": false, "description": "备份库：如果是按库备份，则需要该字段，库之间用英文逗号分割", "example": "demo1,demo2" } ] }, { "name": "UpdateStatus", "type": "integer", "required": false, "description": "更新任务状态： 3-暂停, 2-删除, 1-启动", "example": "1" }, { "name": "CosBucket", "type": "string", "required": false, "description": "当前任务的cos桶信息", "example": "carson-test-1301087413" }, { "name": "SnapshotRemainPolicy", "type": "object", "required": false, "description": "快照保留策略", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": false, "description": "0-不主动删除；1-超过指定时间周期自动删除；2-保留指定数据快照", "example": "1" }, { "name": "RemainDays", "type": "integer", "required": false, "description": "保留快照的时间", "example": "7" }, { "name": "RemainLatestNum", "type": "integer", "required": false, "description": "保留最新快照的数量", "example": "10" } ] }, { "name": "DataRemoteRegion", "type": "string", "required": false, "description": "备份数据所在地域，当前地域应该为空", "example": "ap-chongqing" }, { "name": "BucketType", "type": "string", "required": false, "description": "托管桶类型：standard-标准，maz-多可用区", "example": "maz" }, { "name": "EnableSecurityLock", "type": "integer", "required": false, "description": "是否开启安全锁：0-未开启，1-开启", "example": "1" }, { "name": "GracePeriod", "type": "integer", "required": false, "description": "宽限期（天数）", "example": "10" } ], "required": [ "InstanceId", "OperationType" ] }, { "name": "CreateCoolDownPolicy", "description": "创建冷热分层策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "集群id", "example": "cdwdoris-xx1xa4x" }, { "name": "PolicyName", "type": "string", "required": false, "description": "策略名称", "example": "policy_name" }, { "name": "CoolDownTtl", "type": "string", "required": false, "description": "cooldown_ttl", "example": "134" }, { "name": "CoolDownDatetime", "type": "string", "required": false, "description": "cooldown_datetime", "example": "2024-12-04" } ], "required": [] }, { "name": "CreateInstanceNew", "description": "通过API创建集群", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-5" }, { "name": "FeSpec", "type": "object", "required": true, "description": "FE规格", "example": "S_4_16_H", "children": [ { "name": "SpecName", "type": "string", "required": true, "description": "规格名字", "example": "S_4_16_H" }, { "name": "Count", "type": "integer", "required": true, "description": "数量", "example": "3" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "云盘大小", "example": "300" } ] }, { "name": "BeSpec", "type": "object", "required": true, "description": "BE规格", "example": "S_4_16_H", "children": [ { "name": "SpecName", "type": "string", "required": true, "description": "规格名字", "example": "S_4_16_H" }, { "name": "Count", "type": "integer", "required": true, "description": "数量", "example": "3" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "云盘大小", "example": "300" } ] }, { "name": "HaFlag", "type": "boolean", "required": true, "description": "是否高可用", "example": "true" }, { "name": "UserVPCId", "type": "string", "required": true, "description": "用户VPCID", "example": "vpc-xadsfx" }, { "name": "UserSubnetId", "type": "string", "required": true, "description": "用户子网ID", "example": "subnet-xasdf3" }, { "name": "ProductVersion", "type": "string", "required": true, "description": "产品版本号", "example": "2.1" }, { "name": "ChargeProperties", "type": "object", "required": true, "description": "付费类型", "example": "chargeProperties", "children": [ { "name": "ChargeType", "type": "string", "required": false, "description": "计费类型，“PREPAID” 预付费，“POSTPAID_BY_HOUR” 后付费", "example": "POSTPAY" }, { "name": "RenewFlag", "type": "integer", "required": false, "description": "是否自动续费，1表示自动续费开启", "example": "0" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "计费时间长度", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "计费时间单位，“m”表示月等", "example": "h" } ] }, { "name": "InstanceName", "type": "string", "required": true, "description": "实例名字", "example": "prod_doris" }, { "name": "DorisUserPwd", "type": "string", "required": true, "description": "数据库密码", "example": "xafd#sfs31" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "tags", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签的键", "example": "标签一" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签的值", "example": "内容一" } ] }, { "name": "HaType", "type": "integer", "required": false, "description": "高可用类型： 0：非高可用（只有1个FE，FeSpec.CreateInstanceSpec.Count=1）， 1：读高可用（至少需部署3个FE，FeSpec.CreateInstanceSpec.Count\u003e=3，且为奇数）， 2：读写高可用（至少需部署5个FE，FeSpec.CreateInstanceSpec.Count\u003e=5，且为奇数）。", "example": "0" }, { "name": "CaseSensitive", "type": "integer", "required": false, "description": "表名大小写是否敏感，0：敏感；1：不敏感，以小写进行比较；2：不敏感，表名改为以小写存储", "example": "2" }, { "name": "EnableMultiZones", "type": "boolean", "required": false, "description": "是否开启多可用区", "example": "true" }, { "name": "UserMultiZoneInfoArr", "type": "array", "required": false, "description": "开启多可用区后，用户的所有可用区和子网信息", "example": "networkInfo", "item_type": "object", "children": [ { "name": "Zone", "type": "string", "required": false, "description": "可用区", "example": "ap-guangzhou-1" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网id", "example": "subnet-xxxxxxx" }, { "name": "SubnetIpNum", "type": "integer", "required": false, "description": "当前子网可用ip数", "example": "20" } ] }, { "name": "IsSSC", "type": "boolean", "required": false, "description": "是否存算分离", "example": "false" }, { "name": "SSCCU", "type": "integer", "required": false, "description": "CU数", "example": "64" }, { "name": "CacheDataDiskSize", "type": "integer", "required": false, "description": "缓存盘大小", "example": "200" } ], "required": [ "Zone", "FeSpec", "BeSpec", "HaFlag", "UserVPCId", "UserSubnetId", "ProductVersion", "ChargeProperties", "InstanceName", "DorisUserPwd" ] }, { "name": "CreateWorkloadGroup", "description": "创建资源组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-xxx" }, { "name": "WorkloadGroup", "type": "object", "required": false, "description": "资源组配置", "example": "无", "children": [ { "name": "WorkloadGroupName", "type": "string", "required": false, "description": "资源组名称", "example": "test1" }, { "name": "CpuShare", "type": "integer", "required": false, "description": "CPU权重", "example": "10" }, { "name": "MemoryLimit", "type": "integer", "required": false, "description": "内存限制，所有资源组的内存限制值之和应该小于等于100", "example": "20" }, { "name": "EnableMemoryOverCommit", "type": "boolean", "required": false, "description": "是否允许超配分配", "example": "false" }, { "name": "CpuHardLimit", "type": "string", "required": false, "description": "cpu硬限制", "example": "30%" } ] } ], "required": [ "InstanceId" ] }, { "name": "DeleteBackUpData", "description": "删除备份数据", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "\"cdwch-xxx\"" }, { "name": "BackUpJobId", "type": "integer", "required": false, "description": "任务id", "example": "1428" }, { "name": "IsDeleteAll", "type": "boolean", "required": false, "description": "是否删除所有实例", "example": "true" }, { "name": "IsRecover", "type": "boolean", "required": false, "description": "true代表恢复删除隔离中的job 默认false就是删除", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "DeleteWorkloadGroup", "description": "删除资源组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-xxx" }, { "name": "WorkloadGroupName", "type": "string", "required": false, "description": "需要删除的资源组名称", "example": "name" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAreaRegion", "description": "集群列表页上显示地域信息及各个地域的集群总数", "status": "online", "parameters": [ { "name": "IsInternationalSite", "type": "boolean", "required": false, "description": "是否是国际站", "example": "true" } ], "required": [] }, { "name": "DescribeBackUpJob", "description": "查询备份实例列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "\"cdwch-xxx\"" }, { "name": "ApplicationType", "type": "integer", "required": false, "description": "任务类型： 0-不限制，或使用TypeFilters过滤； 1-备份恢复（包括周期备份和一次性备份）； 2-数据迁移（包括跨集群迁移和cos迁移）", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小", "example": "12" }, { "name": "PageNum", "type": "integer", "required": false, "description": "页号", "example": "10" }, { "name": "BeginTime", "type": "string", "required": false, "description": "开始时间", "example": "\"2021-02-12\"" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "\"2021-02-12\"" }, { "name": "JobIdFiltersStr", "type": "string", "required": false, "description": "jobid的string类型", "example": "str" }, { "name": "EncryptionFilters", "type": "array", "required": false, "description": "0-未加密；1-已加密", "example": "[0]", "item_type": "integer" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackUpJobDetail", "description": "查询备份任务详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "\"cdwch-xxx\"" }, { "name": "BackUpJobId", "type": "integer", "required": true, "description": "任务id", "example": "12" } ], "required": [ "InstanceId", "BackUpJobId" ] }, { "name": "DescribeBackUpSchedules", "description": "获取备份、迁移的调度任务信息", "status": "online", "parameters": [ { "name": "ApplicationType", "type": "integer", "required": false, "description": "任务类型 0-不限制，或使用TypeFilters过滤； 1-备份恢复（包括周期备份和一次性备份）； 2-数据迁移（包括跨集群迁移和cos迁移）", "example": "1" }, { "name": "EncryptionFilters", "type": "array", "required": false, "description": "0-未加密；1-已加密", "example": "[1]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeBackUpTables", "description": "获取可备份表信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "\"cdwch-xxx\"" }, { "name": "BackupType", "type": "integer", "required": false, "description": "0为默认。1时是对远端的doris进行备份，不周期，一次性。2时为cos恢复，一次性", "example": "1" }, { "name": "DorisSourceInfo", "type": "object", "required": false, "description": "远端doris集群的连接信息", "example": "{ }", "children": [ { "name": "Host", "type": "string", "required": false, "description": "doris集群的fe的ip", "example": "127.0.0.1" }, { "name": "Port", "type": "integer", "required": false, "description": "doris集群的fe的端口号", "example": "9030" }, { "name": "User", "type": "string", "required": false, "description": "doris集群的账号", "example": "root" }, { "name": "Password", "type": "string", "required": false, "description": "base64编码的doris集群对应用户的密码", "example": "dasd***asdas" } ] }, { "name": "CosSourceInfo", "type": "object", "required": false, "description": "cos信息", "example": "{ }", "children": [ { "name": "SecretId", "type": "string", "required": false, "description": "cos认证中的Id", "example": "ak_id" }, { "name": "SecretKey", "type": "string", "required": false, "description": "cos认证中的key", "example": "ak_sk" }, { "name": "CosPath", "type": "string", "required": false, "description": "cos认证中的路径", "example": "http://test.ap-guangzhou.co," } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackUpTaskDetail", "description": "查询备份任务进度详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "\"cdwch-xxx\"" }, { "name": "BackUpJobId", "type": "integer", "required": true, "description": "任务id", "example": "12" } ], "required": [ "InstanceId", "BackUpJobId" ] }, { "name": "DescribeClusterConfigs", "description": "获取集群的最新的几个配置文件（config.xml、metrika.xml、user.xml）的内容，显示给用户", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID", "example": "cdwch-f625kxu6" }, { "name": "ConfigType", "type": "integer", "required": false, "description": "0 公有云查询；1青鹅查询，青鹅查询显示所有需要展示的", "example": "1" }, { "name": "FileName", "type": "string", "required": false, "description": "模糊搜索关键字文件", "example": "Keytab" }, { "name": "ClusterConfigType", "type": "integer", "required": false, "description": "0集群维度 1节点维度 2启动脚本 3计算组维度", "example": "0" }, { "name": "IPAddress", "type": "string", "required": false, "description": "eth0的ip地址", "example": "127.0.0.1" }, { "name": "ComputeGroupId", "type": "string", "required": false, "description": "计算组id", "example": "tchd-f625kxu6-123ac" } ], "required": [ "InstanceId" ] }, { "name": "DescribeClusterConfigsHistory", "description": "获取集群配置文件修改历史", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id名称", "example": "cdwch-xxxx" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页参数，第一页为0，第二页为10", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页参数，分页步长，默认为10", "example": "20" }, { "name": "StartTime", "type": "string", "required": true, "description": "配置修改历史的时间范围开始", "example": "2021-06-02 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "配置修改历史的时间范围结束", "example": "2021-06-02 00:00:00" }, { "name": "ConfigFileNames", "type": "array", "required": false, "description": "需要查询的配置文件名称数组，如果为空则查询全部历史记录。目前支持的配置文件名称有： apache_hdfs_broker.conf、be.conf、fe.conf、core-site.xml、hdfs-site.xml、odbcinst.ini", "example": "[\"be.conf\", \"fe.conf\"]", "item_type": "string" }, { "name": "ComputeGroupIds", "type": "array", "required": false, "description": "需要查询的计算组列表", "example": "[\"tchd-2ydhbjw5-xasd\"]", "item_type": "string" } ], "required": [ "InstanceId", "Offset", "Limit", "StartTime", "EndTime" ] }, { "name": "DescribeCoolDownBackends", "description": "查询冷热分层backend节点信息列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "集群id", "example": "cdwdoris-xxx" } ], "required": [] }, { "name": "DescribeCoolDownPolicies", "description": "查询冷热分层策略列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "集群id", "example": "cdwdoris-xxx" } ], "required": [] }, { "name": "DescribeCoolDownTableData", "description": "查询冷热分层Table数据", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "集群id", "example": "cdwdoris-xxx" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名称", "example": "name" } ], "required": [] }, { "name": "DescribeDatabaseAuditDownload", "description": "下载数据库审计日志", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cdwdoris-akxtck1n" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2025-01-03 12:23:23\t" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2025-01-04 12:23:23\t" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页", "example": "1" }, { "name": "PageNum", "type": "integer", "required": true, "description": "分页", "example": "10" }, { "name": "OrderType", "type": "string", "required": false, "description": "排序参数", "example": "DESC/ASC" }, { "name": "User", "type": "string", "required": false, "description": "用户", "example": "user1" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库", "example": "db1" }, { "name": "SqlType", "type": "string", "required": false, "description": "sql类型", "example": "type" }, { "name": "Sql", "type": "string", "required": false, "description": "sql语句", "example": "sql" }, { "name": "Users", "type": "array", "required": false, "description": "用户多选", "example": "[\"user1\"]", "item_type": "string" }, { "name": "DbNames", "type": "array", "required": false, "description": "数据库多选", "example": "[\"db1\"]", "item_type": "string" }, { "name": "SqlTypes", "type": "array", "required": false, "description": "sql类型多选", "example": "[\"type1\"]", "item_type": "string" }, { "name": "Catalogs", "type": "array", "required": false, "description": "catalog名称（多选）", "example": "[\"catalog1\"]", "item_type": "string" }, { "name": "IsQuery", "type": "array", "required": false, "description": "是否是查询", "example": "[true]", "item_type": "boolean" }, { "name": "ComputeGroups", "type": "array", "required": false, "description": "计算组列表", "example": "[\"cg1\",\"cg2\"]", "item_type": "string" } ], "required": [ "InstanceId", "StartTime", "EndTime", "PageSize", "PageNum" ] }, { "name": "DescribeDatabaseAuditRecords", "description": "获取数据库审计记录", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cdwdoris-axafax1" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2025-01-03 12:23:23" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2025-01-04 12:23:23" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页", "example": "10" }, { "name": "PageNum", "type": "integer", "required": true, "description": "分页", "example": "1" }, { "name": "OrderType", "type": "string", "required": false, "description": "排序参数", "example": "DESC/ASC" }, { "name": "User", "type": "string", "required": false, "description": "用户", "example": "user1" }, { "name": "DbName", "type": "string", "required": false, "description": "数据库", "example": "db1" }, { "name": "SqlType", "type": "string", "required": false, "description": "sql类型", "example": "type" }, { "name": "Sql", "type": "string", "required": false, "description": "sql语句", "example": "sql" }, { "name": "Users", "type": "array", "required": false, "description": "用户（多选）", "example": "[\"user1\"]", "item_type": "string" }, { "name": "DbNames", "type": "array", "required": false, "description": "数据库（多选）", "example": "[\"db1\"]", "item_type": "string" }, { "name": "SqlTypes", "type": "array", "required": false, "description": "sql类型（多选）", "example": "[\"type\"]", "item_type": "string" }, { "name": "Catalogs", "type": "array", "required": false, "description": "catalog名称（多选）", "example": "[\"catalog]", "item_type": "string" }, { "name": "IsQuery", "type": "array", "required": false, "description": "是否是查询", "example": "[true]", "item_type": "boolean" }, { "name": "ComputeGroups", "type": "array", "required": false, "description": "计算组列表", "example": "[\"cg1\",\"cg2\"]", "item_type": "string" } ], "required": [ "InstanceId", "StartTime", "EndTime", "PageSize", "PageNum" ] }, { "name": "DescribeInstance", "description": "根据集群ID查询某个集群的具体信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID", "example": "cdwch-12345678" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceNodes", "description": "获取集群节点信息列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID", "example": "cdwch-12345678" }, { "name": "NodeRole", "type": "string", "required": false, "description": "集群角色类型，默认为 \"data\"数据节点", "example": "DATA" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数，第一页为0，第二页为10", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，分页步长，默认为10", "example": "100" }, { "name": "DisplayPolicy", "type": "string", "required": false, "description": "展现策略，All时显示所有", "example": "All" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceNodesInfo", "description": "获取BE/FE节点角色", "status": "online", "parameters": [ { "name": "InstanceID", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-xxx" } ], "required": [ "InstanceID" ] }, { "name": "DescribeInstanceNodesRole", "description": "获取集群节点角色", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "\"cdwdoris-xxx\"" }, { "name": "IpFilter", "type": "string", "required": false, "description": "过滤ip", "example": "\"127.0.0.1\"" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceOperations", "description": "在集群详情页面，拉取该集群的操作", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "cdwch-xxxx" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数，偏移量，从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，每页数目，默认为10", "example": "10" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间", "example": "str" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间", "example": "str" }, { "name": "ComputeGroupId", "type": "string", "required": false, "description": "计算组ID", "example": "cg-1" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceState", "description": "集群详情页中显示集群状态、流程进度等", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例名称", "example": "cdwdoris-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceUsedSubnets", "description": "获取集群已使用子网信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-thdngnmi" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstances", "description": "获取集群列表", "status": "online", "parameters": [ { "name": "SearchInstanceId", "type": "string", "required": false, "description": "搜索的集群id名称", "example": "cdwch-xxxx" }, { "name": "SearchInstanceName", "type": "string", "required": false, "description": "搜索的集群name", "example": "name" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数，第一页为0，第二页为10", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，分页步长，默认为10", "example": "20" }, { "name": "SearchTags", "type": "array", "required": false, "description": "搜索标签列表，没匹配到则不过滤集群列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签的键", "example": "标签一" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签的值", "example": "标签值一" }, { "name": "AllValue", "type": "integer", "required": false, "description": "1表示只输入标签的键，没有输入值；非1则表示输入键时且输入值", "example": "1" } ] }, { "name": "InstanceType", "type": "integer", "required": false, "description": "0 : 存算一体,1：存算分离,2:ALL", "example": "1" } ], "required": [] }, { "name": "DescribeInstancesHealthState", "description": "集群健康检查", "status": "online", "parameters": [ { "name": "Input", "type": "string", "required": false, "description": "为空：代表当前appId下所有集群或者某个集群Id", "example": "str" } ], "required": [] }, { "name": "DescribeRestoreTaskDetail", "description": "查询恢复任务进度详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "\"cdwch-xxx\"" }, { "name": "BackUpJobId", "type": "integer", "required": true, "description": "任务id", "example": "12" } ], "required": [ "InstanceId", "BackUpJobId" ] }, { "name": "DescribeSlowQueryRecords", "description": "获取慢查询列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cdwdoris-64h6w432" }, { "name": "QueryDurationMs", "type": "integer", "required": true, "description": "慢查询时间", "example": "100" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2025-01-02 12:35:24" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2025-01-02 18:35:24" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页", "example": "1" }, { "name": "PageNum", "type": "integer", "required": true, "description": "分页", "example": "1" }, { "name": "DurationMs", "type": "string", "required": false, "description": "排序参数", "example": "ASC" }, { "name": "DbName", "type": "array", "required": false, "description": "数据库名称", "example": "[\"xx\",\"xxx\"]", "item_type": "string" }, { "name": "IsQuery", "type": "integer", "required": false, "description": "是否是查询，0：否， 1：是", "example": "1" }, { "name": "CatalogName", "type": "array", "required": false, "description": "catalog名称", "example": "[\"xx\",\"xxx\"]", "item_type": "string" }, { "name": "Sql", "type": "string", "required": false, "description": "sql名", "example": "select * from xxx" }, { "name": "ReadRows", "type": "string", "required": false, "description": "ReadRows排序字段", "example": "ASC" }, { "name": "ResultBytes", "type": "string", "required": false, "description": "ResultBytes排序字段", "example": "ASC" }, { "name": "MemoryUsage", "type": "string", "required": false, "description": "MemoryUsage排序字段", "example": "ASC" }, { "name": "SortField", "type": "string", "required": false, "description": "排序字段", "example": "MemoryUsage" }, { "name": "SortOrder", "type": "string", "required": false, "description": "排序方式", "example": "ASC" }, { "name": "UserName", "type": "string", "required": false, "description": "user", "example": "user1" }, { "name": "ComputeGroups", "type": "array", "required": false, "description": "计算组列表", "example": "[\"cg1\",\"cg2\"]", "item_type": "string" } ], "required": [ "InstanceId", "QueryDurationMs", "StartTime", "EndTime", "PageSize", "PageNum" ] }, { "name": "DescribeSlowQueryRecordsDownload", "description": "下载慢查询文件", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cdwdoris-3lnbut32" }, { "name": "QueryDurationMs", "type": "integer", "required": true, "description": "慢查询时间", "example": "287" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2025-01-02 12:35:24\t" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2025-01-02 14:35:24\t" }, { "name": "DurationMs", "type": "string", "required": false, "description": "排序参数", "example": "ASC" }, { "name": "Sql", "type": "string", "required": false, "description": "查询sql", "example": "select * from test" }, { "name": "ReadRows", "type": "string", "required": false, "description": "排序参数", "example": "ASC" }, { "name": "ResultBytes", "type": "string", "required": false, "description": "排序参数", "example": "ASC" }, { "name": "MemoryUsage", "type": "string", "required": false, "description": "排序参数", "example": "ASC" }, { "name": "IsQuery", "type": "integer", "required": false, "description": "IsQuery条件", "example": "1" }, { "name": "DbName", "type": "array", "required": false, "description": "数据库名称", "example": "[\"xx\",\"xxx\"]", "item_type": "string" }, { "name": "CatalogName", "type": "array", "required": false, "description": "catalog名称", "example": "[\"xx\",\"xxx\"]", "item_type": "string" }, { "name": "SortField", "type": "string", "required": false, "description": "排序字段", "example": "MemoryUsage" }, { "name": "SortOrder", "type": "string", "required": false, "description": "排序方式", "example": "ASC" }, { "name": "UserName", "type": "string", "required": false, "description": "user", "example": "user1" }, { "name": "ComputeGroups", "type": "array", "required": false, "description": "计算组列表", "example": "[\"cg1\",\"cg2\"]", "item_type": "string" } ], "required": [ "InstanceId", "QueryDurationMs", "StartTime", "EndTime" ] }, { "name": "DescribeSpec", "description": "拉取集群节点规格列表", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "地域信息，例如\"ap-guangzhou-1\"", "example": "ap-guangzhou-1" }, { "name": "PayMode", "type": "string", "required": false, "description": "计费类型，PREPAID 包年包月，POSTPAID_BY_HOUR 按量计费", "example": "PREPAID" }, { "name": "Zones", "type": "array", "required": false, "description": "多可用区", "example": "[\"ap-guangzhou-1\",\"ap-guangzhou-2\"]", "item_type": "string" }, { "name": "SpecName", "type": "string", "required": false, "description": "机型名称", "example": "S_4_16_H" }, { "name": "IsSSC", "type": "boolean", "required": false, "description": "是否存算分离", "example": "false" } ], "required": [ "Zone" ] }, { "name": "DescribeSqlApis", "description": "针对驱动sql命令查询集群接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "cdwdoris-qliqegj3" }, { "name": "ApiType", "type": "string", "required": true, "description": "GetUsers：获取用户列表； GetDatabases：获取数据库列表； GetTables：获取数据库表列表； GetUserPrivilegesV2：获取用户下的权限，粒度到表级别； DeleteUser：删除用户； GetCatalog：获取Catalog列表；", "example": "GetClusters" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名称", "example": "user1" }, { "name": "WhiteHost", "type": "string", "required": false, "description": "用户链接来自的 IP", "example": "10.0.0.2" }, { "name": "Catalog", "type": "string", "required": false, "description": "catalog名称", "example": "interal" }, { "name": "Catalogs", "type": "array", "required": false, "description": "catalog集合", "example": "[\"c1\"]", "item_type": "string" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "数据库名", "example": "db_demo" }, { "name": "TableName", "type": "string", "required": false, "description": "表名", "example": "table_add_table1" }, { "name": "UserNames", "type": "array", "required": false, "description": "用户名列表", "example": "[ ]", "item_type": "string" } ], "required": [ "InstanceId", "ApiType" ] }, { "name": "DescribeTableList", "description": "获取指定数据源和库下的表列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源ID，建表所用的TCHouse-D资源ID。", "example": "cdwdoris-bjizjxxx" }, { "name": "DbName", "type": "string", "required": true, "description": "需要获取表列表的库", "example": "demo" }, { "name": "UserName", "type": "string", "required": false, "description": "使用该用户进行操作，该用户需要有对应的权限。如果该TCHouse-D集群使用CAM用户注册内核账户，则不需要填写", "example": "user" }, { "name": "PassWord", "type": "string", "required": false, "description": "用户对应的密码。如果该TCHouse-D集群使用CAM用户注册内核账户，则不需要填写", "example": "***" }, { "name": "CatalogName", "type": "string", "required": false, "description": "查询库所在的数据源，不填则默认为内部数据源（internal）。", "example": "internal" } ], "required": [ "InstanceId", "DbName" ] }, { "name": "DescribeUserBindWorkloadGroup", "description": "获取当前集群各用户绑定的资源信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "集群id", "example": "cdwdoris-xxx" } ], "required": [] }, { "name": "DescribeWorkloadGroup", "description": "获取资源组信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DestroyInstance", "description": "销毁集群", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "cdwdoris-qliqegj3" } ], "required": [ "InstanceId" ] }, { "name": "ModifyClusterConfigs", "description": "在集群配置页面修改集群配置文件接口，xml模式", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID，例如cdwch-xxxx", "example": "cdwch-xxxx" }, { "name": "ModifyConfContext", "type": "array", "required": true, "description": "配置文件修改信息", "example": "无", "item_type": "object", "children": [ { "name": "FileName", "type": "string", "required": true, "description": "配置文件名称", "example": "config.xml" }, { "name": "NewConfValue", "type": "string", "required": true, "description": "配置文件新内容，base64编码", "example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K" }, { "name": "OldConfValue", "type": "string", "required": false, "description": "配置文件旧内容，base64编码", "example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K" }, { "name": "FilePath", "type": "string", "required": false, "description": "文件路径", "example": "/use/local/server/" } ] }, { "name": "Remark", "type": "string", "required": false, "description": "修改原因", "example": "为了性能提升" } ], "required": [ "InstanceId", "ModifyConfContext" ] }, { "name": "ModifyCoolDownPolicy", "description": "修改冷热分层策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "集群id", "example": "cdwdoris-qliqegj3" }, { "name": "PolicyName", "type": "string", "required": false, "description": "策略名称", "example": "coolDown-1cf23" }, { "name": "CoolDownTtl", "type": "string", "required": false, "description": "cooldown_ttl", "example": "86400" }, { "name": "CoolDownDatetime", "type": "string", "required": false, "description": "cooldown_datetime", "example": "2025-01-15 18:01:22" } ], "required": [] }, { "name": "ModifyInstance", "description": "修改集群名称", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "cdwch-12345678" }, { "name": "InstanceName", "type": "string", "required": true, "description": "新修改的实例名称", "example": "cdwch-test" } ], "required": [ "InstanceId", "InstanceName" ] }, { "name": "ModifyInstanceKeyValConfigs", "description": "KV模式修改配置接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cdwdoris-qliqegj3" }, { "name": "FileName", "type": "string", "required": true, "description": "文件名称", "example": "filename" }, { "name": "AddItems", "type": "array", "required": false, "description": "新增配置列表", "example": "无", "item_type": "object", "children": [ { "name": "ConfKey", "type": "string", "required": true, "description": "key", "example": "conf_key" }, { "name": "ConfValue", "type": "string", "required": true, "description": "value", "example": "conf_value" } ] }, { "name": "UpdateItems", "type": "array", "required": false, "description": "更新配置列表", "example": "无", "item_type": "object", "children": [ { "name": "ConfKey", "type": "string", "required": true, "description": "key", "example": "conf_key" }, { "name": "ConfValue", "type": "string", "required": true, "description": "value", "example": "conf_value" } ] }, { "name": "DelItems", "type": "array", "required": false, "description": "删除配置列表", "example": "无", "item_type": "object", "children": [ { "name": "ConfKey", "type": "string", "required": true, "description": "key", "example": "conf_key" }, { "name": "ConfValue", "type": "string", "required": true, "description": "value", "example": "conf_value" } ] }, { "name": "Message", "type": "string", "required": false, "description": "备注（50字以内）", "example": "add config" }, { "name": "HotUpdateItems", "type": "array", "required": false, "description": "热更新列表", "example": "无", "item_type": "object", "children": [ { "name": "ConfKey", "type": "string", "required": true, "description": "key", "example": "conf_key" }, { "name": "ConfValue", "type": "string", "required": true, "description": "value", "example": "conf_value" } ] }, { "name": "DeleteItems", "type": "object", "required": false, "description": "删除配置列表", "example": "无", "children": [ { "name": "ConfKey", "type": "string", "required": true, "description": "key", "example": "conf_key" }, { "name": "ConfValue", "type": "string", "required": true, "description": "value", "example": "conf_value" } ] }, { "name": "IPAddress", "type": "string", "required": false, "description": "ip地址", "example": "10.0.0.1" } ], "required": [ "InstanceId", "FileName" ] }, { "name": "ModifyNodeStatus", "description": "修改节点状态", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID，例如cdwch-xxxx", "example": "cdwch-xxxx" }, { "name": "NodeInfos", "type": "array", "required": true, "description": "节点信息", "example": "无", "item_type": "object", "children": [ { "name": "NodeName", "type": "string", "required": false, "description": "节点名称", "example": "\"BE\"" }, { "name": "Status", "type": "integer", "required": false, "description": "节点状态", "example": "1" }, { "name": "Ip", "type": "string", "required": false, "description": "节点ip", "example": "\"192.168.0.1\"" }, { "name": "NodeRole", "type": "string", "required": false, "description": "节点角色", "example": "\"CORE”" }, { "name": "ComponentName", "type": "string", "required": false, "description": "组件名", "example": "\"FE\"" }, { "name": "LastRestartTime", "type": "string", "required": false, "description": "上一次重启时间", "example": "\"2021-02-12\"" }, { "name": "Id", "type": "string", "required": false, "description": "id", "example": "id" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区", "example": "ap-guangzhou-3" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间", "example": "2024-12-16 12:23:13" }, { "name": "ComputeGroupId", "type": "string", "required": false, "description": "计算组id", "example": "cg-123" }, { "name": "RIp", "type": "string", "required": false, "description": "rip", "example": "1.2.3.4" }, { "name": "VirtualZone", "type": "string", "required": false, "description": "虚拟可用区", "example": "virtual-ap-chongqing-1-1" }, { "name": "HasFDB", "type": "boolean", "required": false, "description": "是否有fdb", "example": "true" } ] }, { "name": "OperationCode", "type": "string", "required": true, "description": "节点操作", "example": "start, restart, stop" }, { "name": "RestartTimeOut", "type": "string", "required": false, "description": "超时时间（秒）", "example": "3600" } ], "required": [ "InstanceId", "NodeInfos", "OperationCode" ] }, { "name": "ModifySecurityGroups", "description": "更改安全组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "\"cdwch-xxx\"" }, { "name": "OldSecurityGroupIds", "type": "array", "required": false, "description": "修改前的安全组信息", "example": "[\"sg-i0nd0qya\",\"sg-i0ndasd\"]", "item_type": "string" }, { "name": "ModifySecurityGroupIds", "type": "array", "required": false, "description": "修改后的安全组信息", "example": "[\"sg-i0nd0cza\",\"sg-iqadasd\"]", "item_type": "string" } ], "required": [ "InstanceId" ] }, { "name": "ModifyUserBindWorkloadGroup", "description": "修改用户绑定的资源组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-xxx" }, { "name": "BindUsers", "type": "array", "required": false, "description": "需要绑定资源组的用户信息，如果一个账户拥有多个主机信息，需要将这些信息都传入", "example": "无", "item_type": "object", "children": [ { "name": "UserName", "type": "string", "required": false, "description": "用户名", "example": "user_a" }, { "name": "Host", "type": "string", "required": false, "description": "主机信息", "example": "%" } ] }, { "name": "OldWorkloadGroupName", "type": "string", "required": false, "description": "修改前绑定的资源组名称", "example": "normal" }, { "name": "NewWorkloadGroupName", "type": "string", "required": false, "description": "修改后绑定的资源组名称", "example": "g1" } ], "required": [ "InstanceId" ] }, { "name": "ModifyUserPrivilegesV3", "description": "修改用户权限,支持catalog，全部db，部分db表三种权限设置类别", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-xxx" }, { "name": "UserName", "type": "string", "required": true, "description": "用户名", "example": "user" }, { "name": "UserPrivileges", "type": "object", "required": true, "description": "用户权限", "example": "无", "children": [ { "name": "IsSetGlobalCatalog", "type": "boolean", "required": false, "description": "是否设置catalog权限", "example": "true" } ] }, { "name": "WhiteHost", "type": "string", "required": false, "description": "用户链接来自的 IP", "example": "10.0.0.2" }, { "name": "UpdateType", "type": "integer", "required": false, "description": "更新类型，默认0，1为更新绑定计算组，2为更新默认计算组", "example": "0" }, { "name": "UpdateComputeGroups", "type": "array", "required": false, "description": "需绑定计算组列表", "example": "[\"cp1\"]", "item_type": "string" }, { "name": "DefaultComputeGroup", "type": "string", "required": false, "description": "默认计算组", "example": "tchd-ekwold58-gdviogwc" }, { "name": "ComputeGroupType", "type": "integer", "required": false, "description": "0: 灵活场景 1: 固定场景", "example": "1" } ], "required": [ "InstanceId", "UserName", "UserPrivileges" ] }, { "name": "ModifyWorkloadGroup", "description": "修改资源组信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-xxx\t" }, { "name": "WorkloadGroup", "type": "object", "required": false, "description": "修改的资源组信息", "example": "无", "children": [ { "name": "WorkloadGroupName", "type": "string", "required": false, "description": "资源组名称", "example": "test1" }, { "name": "CpuShare", "type": "integer", "required": false, "description": "CPU权重", "example": "10" }, { "name": "MemoryLimit", "type": "integer", "required": false, "description": "内存限制，所有资源组的内存限制值之和应该小于等于100", "example": "20" }, { "name": "EnableMemoryOverCommit", "type": "boolean", "required": false, "description": "是否允许超配分配", "example": "false" }, { "name": "CpuHardLimit", "type": "string", "required": false, "description": "cpu硬限制", "example": "30%" } ] } ], "required": [ "InstanceId" ] }, { "name": "ModifyWorkloadGroupStatus", "description": "开启或关闭资源组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "cdwdoris-xxx" }, { "name": "OperationType", "type": "string", "required": false, "description": "是否开启资源组：open-开启、close-关闭", "example": "open" } ], "required": [ "InstanceId" ] }, { "name": "OpenCoolDown", "description": "开始启用冷热分层", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "集群id", "example": "cdwdoris-qliqegj3" } ], "required": [] }, { "name": "OpenCoolDownPolicy", "description": "开通、描述降冷策略接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例id", "example": "instance-12345" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "db名称", "example": "testdb" }, { "name": "TableName", "type": "string", "required": false, "description": "table名称", "example": "testtable" }, { "name": "OperationType", "type": "string", "required": false, "description": "操作类型", "example": "open_cool_down" }, { "name": "BatchOpenCoolDownTables", "type": "string", "required": false, "description": "逗号分隔需要带上db的名字 db1.tb1,db1.tb2,db2.tb1", "example": "testdb.testtable1,testdb.testtable2,anotherdb.anotherTable" }, { "name": "PolicyName", "type": "string", "required": false, "description": "绑定的时候用策略名称", "example": "cool_down_policy_01" }, { "name": "BatchOpenCoolDownPartitions", "type": "string", "required": false, "description": "逗号分隔 p1,p2,p3", "example": "p1,p2,p3,p4" } ], "required": [] }, { "name": "RecoverBackUpJob", "description": "备份恢复", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "\"cdwch-xxx\"" }, { "name": "BackUpJobId", "type": "integer", "required": true, "description": "任务id", "example": "36613" }, { "name": "ReplicationNum", "type": "integer", "required": false, "description": "恢复出来的新表副本数", "example": "3" }, { "name": "ReserveSourceConfig", "type": "integer", "required": false, "description": "恢复是否保持源表中的配置，1时表示保留源表中的配置", "example": "1" }, { "name": "RecoverScope", "type": "string", "required": false, "description": "恢复粒度：All全量、Database按库、Table按表", "example": "All" }, { "name": "RecoverDatabase", "type": "string", "required": false, "description": "恢复库：如果是按库备份，则需要该字段，库之间用\",\"分割", "example": "db1" }, { "name": "ReserveStoragePolicy", "type": "integer", "required": false, "description": "1:恢复后，不保留降冷策略，数据变为热数据； 2:恢复后，沿用备份表的降冷策略； 0:默认值，该版本没有这个配置（2.1版本2.1.8之前；2.0版本2.0.16之前）", "example": "2" } ], "required": [ "InstanceId", "BackUpJobId" ] }, { "name": "ReduceInstance", "description": "集群缩容", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "cdwdoris-xqewrqx" }, { "name": "DelHosts", "type": "array", "required": true, "description": "节点列表", "example": "[\"10.0.1.12\"]", "item_type": "string" }, { "name": "Type", "type": "string", "required": true, "description": "角色（MATER/CORE），MASTER 对应 FE，CORE对应BE", "example": "\"MASTER\"" }, { "name": "HaType", "type": "integer", "required": true, "description": "缩容后集群高可用类型：0：非高可用，1：读高可用，2：读写高可用。", "example": "1" }, { "name": "CheckAuth", "type": "boolean", "required": false, "description": "前端鉴权使用", "example": "false" } ], "required": [ "InstanceId", "DelHosts", "Type", "HaType" ] }, { "name": "ResizeDisk", "description": "扩容云盘", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "doris-abcd1234" }, { "name": "Type", "type": "string", "required": true, "description": "角色（MATER/CORE），MASTER 对应 FE，CORE对应BE", "example": "BE" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "云盘大小", "example": "200" } ], "required": [ "InstanceId", "Type", "DiskSize" ] }, { "name": "RestartClusterForConfigs", "description": "重启集群让配置文件生效", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID，例如cdwch-xxxx", "example": "cdwch-xxxx" }, { "name": "ConfigName", "type": "string", "required": true, "description": "配置文件名称", "example": "fe.config" }, { "name": "OperationType", "type": "string", "required": false, "description": "grace_restart为优雅滚动重启不填默认立刻重启", "example": "grace_restart" } ], "required": [ "InstanceId", "ConfigName" ] }, { "name": "RestartClusterForNode", "description": "集群滚动重启", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID，例如cdwch-xxxx", "example": "cdwch-xxxx" }, { "name": "ConfigName", "type": "string", "required": true, "description": "配置文件名称", "example": "FE/BE/BROKER" }, { "name": "BatchSize", "type": "integer", "required": false, "description": "每次重启的批次", "example": "1" }, { "name": "NodeList", "type": "array", "required": false, "description": "重启节点", "example": "[ip1,ip2]", "item_type": "string" }, { "name": "RollingRestart", "type": "boolean", "required": false, "description": "false表示非滚动重启，true表示滚动重启", "example": "true" } ], "required": [ "InstanceId", "ConfigName" ] }, { "name": "ScaleOutInstance", "description": "水平扩容节点", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "ins-abc123def" }, { "name": "Type", "type": "string", "required": true, "description": "角色（MATER/CORE），MASTER 对应 FE，CORE对应BE", "example": "FE" }, { "name": "NodeCount", "type": "integer", "required": true, "description": "节点数量", "example": "3" }, { "name": "HaType", "type": "integer", "required": false, "description": "扩容后集群高可用类型：0：非高可用，1：读高可用，2：读写高可用。", "example": "0" }, { "name": "CheckAuth", "type": "boolean", "required": false, "description": "前端鉴权使用", "example": "false" } ], "required": [ "InstanceId", "Type", "NodeCount" ] }, { "name": "ScaleUpInstance", "description": "计算资源垂直变配", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "doris-1234" }, { "name": "SpecName", "type": "string", "required": true, "description": "节点规格", "example": "S_4_16_S" }, { "name": "Type", "type": "string", "required": true, "description": "角色（MASTER/CORE），MASTER 对应 FE，CORE对应BE", "example": "BE" }, { "name": "CheckAuth", "type": "boolean", "required": false, "description": "前端鉴权使用，后端API调用传false，传true不会执行变配", "example": "false" }, { "name": "RollingRestart", "type": "boolean", "required": false, "description": "是否滚动重启", "example": "false" } ], "required": [ "InstanceId", "SpecName", "Type" ] }, { "name": "UpdateCoolDown", "description": "更新集群冷热分层信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "集群id", "example": "cdwdoris-xxx" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否启用 0：不启用 1：启用", "example": "1" }, { "name": "Bucket", "type": "string", "required": false, "description": "用户存放冷热分层数据Cos桶地址", "example": "bucket6331" } ], "required": [] } ] }