CAM 概述
产品功能
应用场景
基本概念
使用限制
用户类型
| CAM中产品名 | CAM中简称 | 控制台访问 | 按标签授权 | 授权粒度 | IP限制 |
|---|---|---|---|---|---|
| 腾讯云数据仓库 TCHouse-C | cdwch | 支持 | 支持 | 资源级 | 部分支持 |
Note：
云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。
- 服务级：定义对服务的整体是否拥有访问权限，分为允许对服务拥有全部操作权限或者拒绝对服务拥有全部操作权限。服务级授权粒度的云产品，不支持对具体的接口进行授权。
- 操作级：定义对服务的特定接口（API）是否拥有访问权限，例如：授权某账号对云服务器服务进行只读操作。
- 资源级：定义对特定资源是否有访问权限，这是最细的授权粒度，例如：授权某账号仅读写操作某台云服务器实例。能支持资源级接口授权的产品，则会被认定为资源级授权粒度。
接口授权粒度分为资源级和操作级两个级别：
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| ActionAlterCkUser | 新增、修改集群用户接口 | 操作级 | * | 支持 |
| ActionCreateCos | 修改集群配置-新增cos | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ActionCreateInstanceGrayTask | 执行灰度任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ActionDmsAuthority | dms鉴权认证 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| AddNewDictionary | 添加新的外部字典 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| AddSparkJob | 新增spark job接口 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| AlterCNUser | 新增、修改用户接口 | 操作级 | * | 支持 |
| ApplyConfigFileToNode | 应用配置文件到集群节点 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 不支持 |
| AttachChProxy | 配置chproxy | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| AttachCosConfig | 挂载COS配置 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| AuthorizedCNSql | 授权sql工作区(CN) | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CancelCNCreateInstance | 云原生取消集群创建流程 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CancelHostTransferJob | 取消数据节点迁移任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CancelHostTransferJobTable | 取消某个表的数据节点迁移任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CancelReShardingJob | 取消重分布任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CancelReShardingJobTable | 取消某个表的重分布任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CancelRestartTip | 取消重启提示 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ClosePublicCloudClb | 删除访问集群的公网IP | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ConfirmTransferJobStopWrite | 确认迁移数据原始集群停写 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| CreateBackUpSchedule | 创建或者修改备份策略 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| CreateCNAutoScalePlan | 新增、修改自动扩缩容计划 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CreateCNElasticPlan | 新增、修改分时弹性执行计划 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| CreateCNExtraStorage | 为云原生集群增加一种存储 | 操作级 | * | 支持 |
| CreateCNInstance | 创建自研数仓云原生集群 | 操作级 | * | 支持 |
| CreateCNRegularPlan | 新增、修改定时启停执行计划 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CreateCNVirtualCluster | 创建云原生vcluster | 操作级 | * | 支持 |
| CreateEsLog | 修改集群配置-新增es日志 | 资源级 | qcs::cdwch:${region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| CreateHostTransferJob | 创建数据节点迁移任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CreateInstance | 创建实例 | 操作级 | * | 支持 |
| CreateInstanceGrayVersion | 创建灰度版本 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CreateInstanceNew | 创建实例 | 操作级 | * | 支持 |
| CreateMCPInstance | 创建实例对应mcp server | 操作级 | * | 支持 |
| CreateMigrationJob | 创建数据节点迁移任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CreatePrivateLinkForCKNode | clickhouse节点创建直连私有链接 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 不支持 |
| CreatePublicCloudClb | 创建公网IP访问集群 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| CreateReShardingJob | 创建数据重分布任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteBackUpData | 删除备份数据 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DeleteBackUpDataForce | 强制删除所有备份数据 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteCNAutoScalePlan | 删除自动扩缩容计划 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteCNElasticPlan | 删除分时弹性执行计划 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteCNRegularPlan | 删除启停执行计划 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteCNUserConfig | 弹性删除用户配置 | 资源级 | qcs::cdwch:${Region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteCNVirtualCluster | 删除云原生虚拟集群 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteDictionary | 删除外部字典 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteHostTransferJob | 删除数据节点迁移任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteInstanceGrayVersion | 删除灰度版本 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteReShardingJob | 删除重分布任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DeleteTransferJob | 删除迁移流程 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DeleteUserConfig | 删除用户配置 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DestroyInstance | 销毁集群api | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DestroyRunProcess | 取消集群创建流程 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceID} | 支持 |
| DisableLogService | 关闭日志服务 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| ExchangeHostTransferJobTable | 切换某个表，以使用数据迁移后的表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ExchangeReShardingJobTable | 切换某个表，以使用重分布后的表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ExecuteCNSql | SQL工作区SQL执行接口(CN) | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ExecuteDmsSql | 执行dms命令（查询和执行一起） | 操作级 | * | 支持 |
| FinishTransferJob | 完成迁移流程 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| FitClsLog | 适配cls日志 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| HandleEventTask | 处理事件任务 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| KillCNQueries | CN终止查询 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| KillQueries | 终止查询 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyCNCkUserPrivileges | 弹性CK添加或修改用户授权 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyCNConfigs | 修改云原生集群配置文件接口 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyCNInstance | 云原生修改实例信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| ModifyCNKeyValConfigs | KV模式修改自研数仓配置接口 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyCNUserConfig | 创建、修改弹性ck用户配置 | 资源级 | qcs::cdwch:${Region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyClusterConfigs | 在集群配置页面修改集群配置文件接口，xml模式 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| ModifyConfigMode | 修改集群配置文件修改模式 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyCosMoveFactor | 修改冷热分层系数 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyDefaultPassword | 修改默认账户密码 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyDictionary | 修改外部字典 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyEventRulesConfig | 修改事件规则的配置 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| ModifyEventTaskReadInfo | 修改事件任务的已读信息 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| ModifyHostTransferJob | 修改数据节点迁移任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyHostTransferJobParameter | 修改数据节点迁移任务参数 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyImpalaUserPrivileges | 新增、修改impala账号权限 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyInstance | 修改集群实例信息 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | 支持 |
| ModifyInstanceConfigs | 修改集群配置接口 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | 支持 |
| ModifyInstanceDetails | 修改实例配置Details | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyInstanceGrayVersion | 修改灰度版本内容 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyInstanceKeyValConfigs | KV模式修改配置接口 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/$InstanceId | 支持 |
| ModifyInstanceKeyValueConfigs | 修改键值对形式的集群配置文件内容 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 不支持 |
| ModifyMigrationJob | 修改迁移任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyMonitorInfo | 修改监视器信息 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyReShardingJob | 修改数据重分布任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyReShardingJobParameter | 修改重分布任务参数 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifySecurityGroups | 更改安全组 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyTransferJob | 编辑迁移任务 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| ModifyUserConfig | 创建、修改ck用户配置 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyUserNewPrivilege | 新增、修改集群账号cluster权限（新版） | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyUserNodesIP | 修改用户节点IP | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| ModifyUserPrivilege | 新增、修改ck账号cluster权限 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ModifyZookeeperRestartSchedule | 配置zk重启策略 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| OpenBackUp | 开启或者关闭策略 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| OperateCNClusterStatus | 手动启停virtual cluster | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| RebootInstances | 重启服务器 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| RecoverBackUpJob | 备份恢复 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| RemoveHostTransferJobOriginTable | 删除数据迁移表的原有数据文件 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| RemoveReShardingJobOriginTable | 删除重分布表的原有数据文件 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ResizeDisk | 扩容磁盘容量 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| RestartCNInstance | 重启集群 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| RestartClusterForConfigs | 重启集群让配置文件生效 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| RestartInstance | 重启实例 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| RetainReShardingJobOriginTable | 保留重分布表的原有数据文件 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| RetryTransferJobFailedTask | 重试迁移失败的任务 | 资源级 | qcs::cdwch::uin/:cdwchInstance/${InstanceId} | 支持 |
| ScaleCNExtraStorage | 通过接口扩缩容云原生集群的存储 | 操作级 | * | 支持 |
| ScaleCNInstance | 通过接口弹性伸缩云原生集群 | 操作级 | * | 支持 |
| ScaleCNOutUpInstance | 通过接口弹性伸缩云原生集群(openapi) | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ScaleOutInstance | 水平调整实例节点 | 资源级 | qcs::cdwch:${Region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ScaleUpInstance | 垂直扩缩容节点规格 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| StartHostTransferJob | 启动数据节点迁移任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| StartReShardingJob | 启动重分布任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| StartTransferJobDataCheck | 开始迁移数据校验 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| StartTransferJobIncrementTransfer | 开始迁移数据增量迁移 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| StartTransferJobPartitionFix | 开始迁移数据失败分片修复 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| StartTransferJobPreCheck | 开始迁移数据预检查 | 资源级 | qcs::cdwch::uin/:cdwchInstance/${InstanceId} | 支持 |
| StartTransferJobSchemaCollect | 开始迁移数据表结构采集 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| StartTransferJobStockTransfer | 开始迁移数据存量迁移 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| StopTransferJob | 停止迁移流程 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| SyncMaterialViewData | 同步物化视图的数据 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | 支持 |
| SyncMaterialViewPartition | 同步物化视图的分区数据 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | 支持 |
| SyncMaterialViewPatition | 同步物化视图的分区数据 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | 不支持 |
| TerminateCNInstance | 云原生退还实例 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| TerminateInstance | 退还实例 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | 支持 |
| TerminateMCPInstance | 销毁mcp实例 | 操作级 | * | 支持 |
| TryContinueHostTransferJobTable | 重新继续出错被暂停的数据迁移的表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| TryContinueReShardingJobTable | 重新继续出错被暂停的表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| UpdateSparkJob | 修改spark job接口 | 操作级 | * | 支持 |
| UpgradeInstanceAdvanceFeature | 更新集群高级特性 | 操作级 | * | 不支持 |
| UpgradeZkVersion | ZK版本升级 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| ValidateLocalUser | 校验用户是否是内部用户 | 操作级 | * | 支持 |
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| ActionDmsDescribe | dms查询类接口 | 操作级 | * | 支持 |
| CheckDictionarySourceConnection | 判断字典外部源的连通性 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeAdvanceFeature | 查询高性能特性 | 操作级 | * | 不支持 |
| DescribeAvailableRegion | 获取所有的可用地域和区 | 操作级 | * | 支持 |
| DescribeBackUpJob | 查询备份任务列表 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeBackUpJobDetail | 查询备份任务详情 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeBackUpSchedule | 查询备份策略信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeBackUpTables | 获取可备份表信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeBucketLifecycle | 查看桶的生命周期 | 操作级 | * | 支持 |
| DescribeCNCkSql | 查询ck信息 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCNCosSpec | 弹性CK获取cos规格 | 操作级 | * | 支持 |
| DescribeCNDmsSqlHistory | 查询dms执行记录(CN) | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCNGoodsDetail | 生成计费相关接口的GoodsDetail结构 | 操作级 | * | 支持 |
| DescribeCNInstance | 描述云原生实例信息 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCNInstances | 获取集群实例列表 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/* | 支持 |
| DescribeCNRegionZone | 获取大地域信息等 | 操作级 | * | 支持 |
| DescribeCNRunningQuery | CN正在运行的查询 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCNSlowQueryRecords | CN慢查询 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCNSlowQueryTrend | CN慢查询趋势 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCNSpec | 云原生获取集群规格 | 操作级 | * | 支持 |
| DescribeCosConfig | COS配置列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeDataCapacity | 获取集群磁盘最大使用量 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 不支持 |
| DescribeDictionarySourceDatabases | 获取字典外部源的db列表 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeDictionarySourceTables | 获取字典外部源的表列表 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeEventRules | 获取事件规则 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeEventTasks | 获取产生的事件任务 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeGoodsDetail | 生成GoodsDetail，生成计费相关接口的GoodsDetail结构 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/* | 支持 |
| DescribeHostTransferJob | 查询数据节点迁移任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeImpalaSql | 通过sql查询Impala集群信息 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstance | 获取实例详情 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$cdwchInstanceId | 支持 |
| DescribeInstanceClusters | 集群vcluster列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstanceConfigFiles | 查看集群配置文件列表 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 不支持 |
| DescribeInstanceConfigs | 获取参数列表 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | 支持 |
| DescribeInstanceCountProxy | 查询用户集群数 | 操作级 | * | 支持 |
| DescribeInstanceGrayVersion | 描述灰度版本详情 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstanceKeyValConfigs | 在集群详情页面获取所有参数列表 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstanceKeyValueConfigs | 查询键值对形式的集群配置文件内容 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 不支持 |
| DescribeInstanceMonitorPort | 查询监控IP端口 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstanceNodeParam | 查询节点参数配置 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 不支持 |
| DescribeInstanceNodes | 获取集群节点列表 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$cdwchinstanceId | 支持 |
| DescribeInstanceOperations | 拉取集群操作列表 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | 支持 |
| DescribeInstanceShards | 获取实例shard信息列表 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstanceState | 获取集群实例状态 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | 支持 |
| DescribeInstanceZk | 描述实例zk集群信息 | 资源级 | qcs::cdwch::uin/${uin}:cdwchInstance/$cdwchInstanceId | 支持 |
| DescribeInstances | 获取集群实例列表 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/* | 支持 |
| DescribeInstancesNew | 获取实例简单信息列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/* | 支持 |
| DescribeInstancesV2 | 获取实例列表，供cvm侧使用 | 操作级 | * | 支持 |
| DescribeMaterialView | 查询物化视图同步情况 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | 支持 |
| DescribeMaterialViewSchedule | 查询物化视图同步计划列表 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | 支持 |
| DescribeMetricData | 获取监控图表数据 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$cdwchInstanceId | 支持 |
| DescribeMetricMeta | 获取实例监控元数据 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$cdwchInstanceId | 支持 |
| DescribeMrMetricFiles | 查询监控指标文件列表 | 操作级 | * | 支持 |
| DescribeOverviewData | 获取监控总览数据 | 资源级 | qcs::cdwch:$region:$account:cdwchInstance/$cdwchInstanceId | 支持 |
| DescribePricePageRegionInfo | 定价页地域信息 | 操作级 | * | 支持 |
| DescribePricePageSpec | 定价页规格查询 | 操作级 | * | 支持 |
| DescribeReShardingJob | 查询重分布任务 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeReShardingTables | 查询可以进行数据重分布的表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeRunningQuery | dms正在运行的查询 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeSlowQueryRecords | 慢查询 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeSlowQueryTrend | 慢查询趋势 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | 支持 |
| DescribeSpec | 获取集群规格 | 操作级 | * | 支持 |
| DescribeTableDistribution | 表管理-查询表数据分布 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeTableSchema | 建表SQL | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeTransferJobDatabaseSchema | 获取迁移流程的表数据采集结果 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeTransferJobDetail | 获取迁移任务的详细信息 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeTransferJobList | 获取集群迁移任务列表 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeTransferJobPreCheckResult | 获取迁移流程的预检查结果 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeTransferJobTransferResult | 获取迁移流程的迁移结果 | 资源级 | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeUnreadEventTasks | 获取当前用户未读事件列表 | 操作级 | * | 支持 |
| DescribeZookeeperRestartSchedule | 展示zk重启定时任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| QueryPrice | 查询价格openapi | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${ResourceID} | 支持 |
| SearchClsLog | 查询CLS日志 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| DescribeAreaRegion | 获取各地域列表 | 操作级 | * | 支持 |
| DescribeBillingParams | 获取计费参数 | 操作级 | * | 支持 |
| DescribeCNAreaRegion | 弹性ck获取各地域列表 | 操作级 | * | 支持 |
| DescribeCNInstanceConfigHistories | 云原生获取集群配置文件修改历史 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCNInstanceConfigs | 获取云原生集群配置文件内容 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceID} | 支持 |
| DescribeCNInstanceKeyValConfigs | 在集群详情页面获取所有参数key-val列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCNInstanceOperations | 云原生拉取集群操作列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCNSql | dms查询类接口(CN) | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCkMetas | 表列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeCkSqlApis | 查询集群用户、集群表，数据库等相关信息 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeClusterConfigsHistory | 获取集群配置文件修改历史 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
| DescribeDictionaries | 查询cdwch外部字典列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeDictionaryNameList | 获取集群所有的字典名称 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeDictionarySourceTableInfo | 获取字典外部源的表信息 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeDmsSqlHistory | 查询dms执行记录 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeHostTransferJobTables | 查询数据节点迁移任务表列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeHostTransferJobs | 查询数据节点迁移任务列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeHostTransferTables | 查询可以进行数据节点迁移的表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstanceForMonitor | 云监控调用查询实例信息 | 操作级 | * | 支持 |
| DescribeInstanceGrayPacketVersions | 查询灰度二进制包版本列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstanceGrayVersions | 查询灰度版本列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstanceNodesForBarad | 获取实例节点信息列表forbarad | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeInstanceScaleOutTableResults | 获取扩容操作时的表创建结果 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeMigrationInstances | 获取实例列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeMigrationTables | 查询可以进行数据节点迁移的表名 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeMonitorSpec | 获取监控规格 | 操作级 | * | 支持 |
| DescribeProductDiscount | 获取产品折扣信息 | 操作级 | * | 支持 |
| DescribeReShardingJobTables | 查询重分布任务表列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeReShardingJobs | 查询重分布任务列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeReShardingTablePartitions | 查询可以进行数据重分布的表的partition列表 | 资源级 | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | 支持 |
| DescribeRegionZone | 获取地域及可用区列表 | 操作级 | * | 支持 |
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| UpgradeVersion | 内核版本升级 | 资源级 | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | 支持 |
文档反馈