基本信息
| CAM中产品名 | CAM中简称 | 控制台访问 | 按标签授权 | 授权粒度 | IP限制 |
|---|---|---|---|---|---|
| 腾讯云数据仓库 TCHouse-X | tchousex | 支持 | 支持 | 资源级 | 部分支持 |
说明：云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。
- 服务级：定义对服务的整体是否拥有访问权限，分为允许对服务拥有全部操作权限或者拒绝对服务拥有全部操作权限。服务级授权粒度的云产品，不支持对具体的接口进行授权。
- 操作级：定义对服务的特定接口（API）是否拥有访问权限，例如：授权某账号对云服务器服务进行只读操作。
- 资源级：定义对特定资源是否有访问权限，这是最细的授权粒度，例如：授权某账号仅读写操作某台云服务器实例。能支持资源级接口授权的产品，则会被认定为资源级授权粒度。
接口授权粒度
接口授权粒度分为资源级和操作级两个级别：
- 资源级接口：此类型接口支持对某一个具体特定的资源进行授权。
- 操作级接口：此类型接口不支持对某一个特定的资源进行授权。授权时策略语法若限定了具体的资源，CAM会判断此接口不在授权范围，判断为无权限。
写操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| AddSparkJob | 新增spark job接口 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CancelCreateInstance | 云原生取消集群创建流程 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateAndExecuteSparkJob | 创建并运行离线任务 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateAutoScalePlan | 新增、修改自动扩缩容计划 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateDatabase | 创建库 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateElasticPlan | 新增、修改分时弹性执行计划 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateElasticPlanV1 | 新增、修改分时弹性执行计划V1 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateEngineJob | 创建spark离线任务 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateFunction | 创建Function | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateInstance | 创建集群 | 操作级 | * | 支持 |
| CreateMCPInstance | 创建mcp 实例 | 操作级 | * | 支持 |
| CreateNotebookSession | wedata-notebook创建交互式会话 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateNotebookSessionStatement | wedata-notebook交互式会话提交代码 | 操作级 | * | 支持 |
| CreatePartition | 创建分区 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateRegularPlan | 新增、修改定时启停执行计划 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateRegularPlanV1 | 新增、修改定时启停执行计划V1 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateSparkDownloadLog | 创建spark 任务下载日志 | 操作级 | * | 支持 |
| CreateTable | 创建table | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateUpdateWarehouseSparkSetting | 创建或更新spark规格配置 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CreateVirtualCluster | 云原生创建虚拟集群 | 操作级 | * | 支持 |
| DeleteAutoScalePlan | 删除自动扩缩容计划 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DeleteElasticPlan | 删除分时弹性执行计划 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DeleteElasticPlanV1 | 删除分时弹性执行计划V1 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DeleteEngineJob | 向计算引擎取消某个计算作业 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DeleteNotebookSession | wedata-notebook删除交互式会话 | 操作级 | * | 支持 |
| DeleteRegularPlan | 删除定时启停执行计划 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DeleteRegularPlanV1 | 删除定时启停执行计划V1 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DeleteSparkJob | 删除spark job接口 | 操作级 | * | 支持 |
| DeleteSparkTask | 取消spark任务 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DeleteVirtualCluster | 删除warehouse | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DropDatabase | 删库 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DropFunction | 删除函数 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DropPartition | 删除分区 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DropTable | 删除表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ExecuteSparkJob | 执行spark job任务 | 操作级 | * | 支持 |
| ModifyConfigs | 修改云原生集群配置文件接口 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ModifyInstance | 修改集群名称 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ModifyTable | 修改table | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ModifyUserConfig | 新增或修改配置 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| OpenCLSDelivery | 开启CLS日志投递 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| OperateClusterStatus | 手动启停virtual cluster | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| OperateMetricSubscription | 指标订阅操作 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| RestartInstance | 重启集群 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ScaleExtraStorage | 通过接口扩缩容云原生集群的存储 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ScaleInstance | 通过接口弹性伸缩云原生集群 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ScaleInstanceV1 | 通过接口弹性伸缩云原生集群V1 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| StopCLSDelivery | 停止CLS日志投递 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| TerminateInstance | 删除集群 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| TerminateMCPInstance | 销毁mcp实例 | 操作级 | * | 支持 |
| UpdateExecSparkJob | 保存并执行离线任务 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| UpdateSparkJob | 修改spark job接口 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| UpgradeMCPInstance | 升级mcp实例 | 操作级 | * | 支持 |
其他操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| AuthorizedSql | 授权sql工作区 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| CancelSqlExecute | 取消sql执行任务 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DeleteUserConfig | 删除用户配置 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeImpalaAccreditNew | 授权、权限展示相关接口 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeImpalaObjectNew | 账户管理库表展示相关接口 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeImpalaRoleNew | 账户管理角色页面相关接口 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeImpalaUserNew | 账户管理用户页面相关接口 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSqlDraft | sql工作区sql草稿相关操作 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ExecuteEngineSql | 执行sql | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ExecuteSql | SQL工作区SQL执行接口 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| ExecuteSqlForBI | 执行sql语句 | 操作级 | * | 支持 |
| ExecuteSqlV1 | SQL工作区SQL执行接口-V1 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| OperateDataMask | 列脱敏新增、修改、删除、预览 | 操作级 | * | 支持 |
| OperateLDAP | 自定义LDAP管理 | 操作级 | * | 不支持 |
| OperateRoleV2 | 角色管理V2 | 操作级 | * | 不支持 |
| OperateRowFilter | 行过滤策略新增、修改、删除、预览 | 操作级 | * | 支持 |
| OperateUserV2 | 用户管理V2 | 操作级 | * | 不支持 |
读操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| ConnectInstance | 集群连接 | 操作级 | * | 不支持 |
| DescribeCLSConfig | CLS日志配置记录 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeCLSConfigHistory | CLS日志配置变更记录 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeDatabaseByName | 查询库详情 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeEngineClusterState | 查询计算引擎健康度 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeEngineEncryptMess | 查询计算引擎密码加密密钥 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeEngineExtParams | 查询计算引擎扩展参数列表 | 操作级 | * | 支持 |
| DescribeEngineInstances | 获取引擎实例列表 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/* | 支持 |
| DescribeEngineJobInfo | 获取提交到引擎的任务信息 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeEngineJobLog | 查询引擎交互式日志 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeEngineJobResult | 任务执行结果查询 | 资源级 | qcs::tchousex:${Region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeEngineJobState | 查询引擎计算作业执行状态和进度 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeEngineRegions | 获取引擎可用区 | 操作级 | * | 支持 |
| DescribeEventList | 拉取指定的EventId之后,新增的元数据变更信息。 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeFrontEnd | 查询前端所需信息 | 操作级 | * | 支持 |
| DescribeFunctionByName | 查询函数详情 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeGoodsDetail | 生成计费相关接口的GoodsDetail结构 | 操作级 | * | 支持 |
| DescribeImpalaSql | 通过sql查询Impala集群信息 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstance | 描述云原生集群信息 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstanceConfigHistories | 云原生获取集群配置文件修改历史 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstanceConfigs | 获取云原生集群配置文件内容 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstanceForBarad | 展示集群简短信息 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstanceOperations | 获取集群操作信息 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstanceOperationsV1 | 展示集群的操作记录 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstanceResourceUsage | 查询实例资源使用信息 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstanceVip | 获取集群的vip的相关数据 | 操作级 | * | 支持 |
| DescribeInstanceVipList | 获取集群的vip数据列表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstanceWarehouse | 获取集群warehouse信息 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeInstancesV1 | 描述集群信息列表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/* | 支持 |
| DescribeLDAPUsers | LDAP用户列表 | 操作级 | * | 不支持 |
| DescribeMCPInstance | 获取mcp实例信息 | 操作级 | * | 支持 |
| DescribeMCPRegionZone | 获取MCP大地域信息等 | 操作级 | * | 支持 |
| DescribeMetricSubscription | 指标订阅查询 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeMonitorData | 代理GetMonitorData | 操作级 | * | 支持 |
| DescribeMrMetricFiles | 查询监控指标文件列表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeNextEventId | 获取最新的元数据变更事件id | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeNotebookSession | wedata-notebook查询交互式会话 | 操作级 | * | 支持 |
| DescribeNotebookSessionStatement | wedata-notebook查询代码执行结果 | 操作级 | * | 支持 |
| DescribePhysicalInventory | 查询物理资源库存 | 操作级 | * | 支持 |
| DescribePolicy | 行过滤和列脱敏策略查询 | 操作级 | * | 支持 |
| DescribeRegionZone | 获取大地域信息等 | 操作级 | * | 支持 |
| DescribeRoleV2 | 角色列表V2 | 操作级 | * | 不支持 |
| DescribeSparkAllSessions | 获取spark所有session信息 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSparkAllTasks | 获取spark所有任务 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSparkJobs | 查询spark job 列表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSparkSqlTasks | 查询spark sql任务列表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSparkTask | 查询任务详情 | 操作级 | * | 支持 |
| DescribeSparkTaskResourceInfos | 查询离线任务运行pod信息 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSparkTasks | 查询spark 任务列表 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSpec | 云原生获取集群规格 | 操作级 | * | 支持 |
| DescribeSql | SQL工作区展示数据库表等功能 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSqlExecuteHistory | SQL工作区展示SQL执行历史记录 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSqlExecuteResult | 查看sql执行结果 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSqlHistoryRecords | 查询在线sql运行记录 | 资源级 | qcs::tchousex::uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeTableByName | 查询表详情 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeUserDefineCos | 用户自定义COS信息查询 | 操作级 | * | 支持 |
| DescribeUserV2 | 用户列表V2 | 操作级 | * | 不支持 |
| QuerySparkDownloadLogs | 查询spark 任务下载日志 | 操作级 | * | 支持 |
| QuerySparkTaskLog | 查询spark 任务日志 | 操作级 | * | 支持 |
列表操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| DescribeDatabaseList | 查询库列表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeFunctionList | 查询函数列表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribePartitionList | 查询分区列表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
| DescribeSparkJob | 查询spark job | 操作级 | * | 支持 |
| DescribeTableList | 查询表列表 | 资源级 | qcs::tchousex:${region}:uin/${uin}:tchousexInstance/${InstanceId} | 支持 |
