基本信息
CAM中产品名 | CAM中简称 | 控制台访问 | 按标签授权 | 授权粒度 | IP限制 |
---|---|---|---|---|---|
流计算 Oceanus | oceanus | 支持 | 支持 | 资源级 | 支持 |
说明:云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。
- 服务级:定义对服务的整体是否拥有访问权限,分为允许对服务拥有全部操作权限或者拒绝对服务拥有全部操作权限。服务级授权粒度的云产品,不支持对具体的接口进行授权。
- 操作级:定义对服务的特定接口(API)是否拥有访问权限,例如:授权某账号对云服务器服务进行只读操作。
- 资源级:定义对特定资源是否有访问权限,这是最细的授权粒度,例如:授权某账号仅读写操作某台云服务器实例。能支持资源级接口授权的产品,则会被认定为资源级授权粒度。
接口授权粒度
接口授权粒度分为资源级和操作级两个级别:
- 资源级接口:此类型接口支持对某一个具体特定的资源进行授权。
- 操作级接口:此类型接口不支持对某一个特定的资源进行授权。授权时策略语法若限定了具体的资源,CAM会判断此接口不在授权范围,判断为无权限。
写操作
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
AssociateCHdfsAccessGroup | 绑定 CHDFS 权限组 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ChangeJobState | 修改作业状态 | 操作级 | * | 支持 |
CopyJobs | 单条和批量复制作业 | 操作级 | * | 支持 |
CreateCHDFSAccessGroup | 创建集群CHDFS权限组 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CreateClusterInstance | 创建集群 | 操作级 | * | 支持 |
CreateConnection | 新建数据连接 | 操作级 | * | 支持 |
CreateConnector | 创建Connector | 操作级 | * | 支持 |
CreateCorrelation | 绑定项目空间和集群的关联 | 操作级 | * | 支持 |
CreateDebugJob | 创建调试作业 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
CreateDumpFile | 创建dump | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
CreateEngineJob | wedata开发任务提交 | 操作级 | * | 支持 |
CreateEtlPreCheck | 创建ETL预检查任务 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
CreateFolder | 作业列表页面新建文件夹请求 | 操作级 | * | 支持 |
CreateFunction | 创建自定义函数 | 操作级 | * | 支持 |
CreateHadoopYarnCluster | CreateHadoopYarnCluster | 操作级 | * | 支持 |
CreateJobScalePlan | 新建作业扩容计划 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobSerialId} | 支持 |
CreateJobScaleRule | 创建自动扩缩容规则 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
CreateJobTuningAction | 创建作业调优action | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobSerialId} | 支持 |
CreateMetaCatalog | 创建元数据Catalog | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CreateMetaDatabase | 创建元数据库 | 操作级 | * | 支持 |
CreateMetaTable | 创建元数据表 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CreatePresignedUrl | 获取请求预签名 URL,主要是获取cos的url | 操作级 | * | 支持 |
CreateProperClsLogset | 创建Oceanus专属日志集 | 操作级 | * | 支持 |
CreateProperClsTopic | 创建Oceanus专属日志主题 | 操作级 | * | 支持 |
CreateProperESServerlessIndex | 创建 ES Serverless 索引 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CreateProperESServerlessSpace | 创建 ES Serverless 空间 | 操作级 | * | 支持 |
CreateResource | 创建资源 | 操作级 | * | 支持 |
CreateResourceConfig | 创建资源配置 | 操作级 | * | 支持 |
CreateRole | 创建角色 | 操作级 | * | 支持 |
CreateSessionCluster | 启动Session集群 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterGroupSerialId} | 支持 |
CreateSqlGateway | 创建SqlGateway | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CreateSubEksCluster | 创建弹性集群 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ParentResourceId} | 支持 |
CreateTableConfig | 创建数据源表的信息 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
CreateVariable | 创建变量 | 操作级 | * | 支持 |
CreateWorkSpace | 创建工作空间 | 操作级 | * | 支持 |
CreateWorkSpaceUser | 创建工作空间用户 | 操作级 | * | 支持 |
DeleteCluster | 删除集群 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DeleteClusterInstance | 销毁集群 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DeleteConnections | 删除数据连接 | 操作级 | * | 支持 |
DeleteCorrelation | 释放项目空间和集群的关联 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterGroupSerialId} | 支持 |
DeleteEngineJob | wedata取消某个计算作业 | 操作级 | * | 支持 |
DeleteExternalMetaCatalogs | 删除ExternalMetaCatalog | 操作级 | * | 支持 |
DeleteFolders | 作业列表删除文件夹 | 操作级 | * | 支持 |
DeleteFunction | 删除自定义函数 | 操作级 | * | 支持 |
DeleteFunctionArtifact | 删除udf接口 | 操作级 | * | 支持 |
DeleteJobConfigs | 删除作业配置 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DeleteJobSavepoint | 删除保存点 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DeleteJobScalePlan | 删除作业调优计划 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobSerialId} | 支持 |
DeleteJobScaleRule | 删除自动扩缩容规则 | 操作级 | * | 支持 |
DeleteJobs | 删除作业 | 操作级 | * | 支持 |
DeleteMetaDatabases | 元数据库删除 | 操作级 | * | 支持 |
DeleteMetaTableChangeLogs | 删除元数据变更记录 | 操作级 | * | 支持 |
DeleteMetaTables | 元数据表删除 | 操作级 | * | 支持 |
DeleteResourceConfigs | 删除资源版本 | 操作级 | * | 支持 |
DeleteResources | 删除资源 | 操作级 | * | 支持 |
DeleteRole | 删除角色 | 操作级 | * | 支持 |
DeleteTableConfig | 删除作业表配置 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DeleteVariables | 删除变量 | 操作级 | * | 支持 |
DeleteWorkSpace | 删除工作空间 | 操作级 | * | 支持 |
DeleteWorkSpaceUser | 删除工作空间用户 | 操作级 | * | 支持 |
DescribeFunctions | 查询自定义函数接口 | 操作级 | * | 支持 |
FinishCommands | 命令完成 | 操作级 | * | 支持 |
ModifyAdministrator | 增删超级管理员 | 操作级 | * | 支持 |
ModifyClsTopicConfiguration | 修改日志主题配置 | 操作级 | * | 支持 |
ModifyCluster | 修改集群信息 | 资源级 | qcs::oceanus:${region}:uin/${uin}:cluster/${ClusterId} | 支持 |
ModifyClusterCls | 修改集群绑定的CLS | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ModifyClusterDNS | 修改集群自定义 DNS 配置 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ModifyClusterEsServerless | 修改集群绑定的 EsServerless 信息 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ModifyClusterInstance | 调整集群配置 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ModifyConnection | 修改数据连接 | 操作级 | * | 支持 |
ModifyConnector | 修改Connector | 操作级 | * | 支持 |
ModifyDefaultJobConfig | 修改默认作业配置 | 操作级 | * | 支持 |
ModifyDraftConfig | 修改作业草稿 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
ModifyExternalMetaCatalog | 修改ExternalMetaCatalog | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ModifyFolder | 自定义树状结构页面拖拽文件夹 | 操作级 | * | 支持 |
ModifyFunctionArtifact | 更新udf | 操作级 | * | 支持 |
ModifyJob | 更新作业 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
ModifyJobConfig | 批量修改作业参数 | 操作级 | * | 支持 |
ModifyJobDefaultAlarm | 修改作业默认告警状态 | 操作级 | * | 支持 |
ModifyJobLogLevel | 修改作业日志级别 | 操作级 | * | 支持 |
ModifyJobScalePlan | 修改作业扩容计划 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobSerialId} | 支持 |
ModifyJobScaleRule | 修改自动扩缩容规则 | 操作级 | * | 支持 |
ModifyLoginSettings | 重置密码 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ModifyMetaTable | 修改元数据表 | 资源级 | qcs::oceanus:${Region}:uin/:cluster/${ClusterId} | 支持 |
ModifyMetaTableFlinkVersions | 修改元表的Flink版本 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ModifyResource | 修改资源 | 操作级 | * | 支持 |
ModifyRole | 修改角色 | 操作级 | * | 支持 |
ModifyRoleName | 修改角色名称 | 操作级 | * | 支持 |
ModifyRunningLogShipper | 修改日志投递配置 | 操作级 | * | 支持 |
ModifySetatsConfiguration | 修改 Setats 配置 | 操作级 | * | 支持 |
ModifySetatsWarehouse | 配置setats warehouse | 操作级 | * | 支持 |
ModifySubnet | 更换集群子网 | 资源级 | qcs::oceanus:${Region}:uin/:cluster/${ClusterId} | 支持 |
ModifyVariable | 编辑变量 | 操作级 | * | 支持 |
ModifyWebUIWhiteList | 修改WebUI IP白名单列表 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ModifyWorkSpace | 修改工作空间 | 操作级 | * | 支持 |
ModifyWorkSpaceUser | 修改工作空间用户角色权限 | 操作级 | * | 支持 |
ParseFunction | 解析自定义函数接口 | 操作级 | * | 支持 |
PublishJob | 发布作业 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
RecoverJob | 恢复作业 | 操作级 | * | 支持 |
RegisterFunctionArtifact | 注册udf | 操作级 | * | 支持 |
RenewClusterInstance | 续费集群 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
RespondCommands | 回应命令 | 操作级 | * | 支持 |
RestartSetats | 重启setats服务 | 操作级 | * | 支持 |
RunDebugJob | 运行调试作业 | 操作级 | * | 支持 |
RunJobScalePlan | 启动作业调优计划 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobSerialId} | 支持 |
RunJobs | 运行作业 | 操作级 | * | 支持 |
RunSqlGatewayStatement | 执行Statement | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
RunSqlPreview | 运行调试任务(session模式) | 操作级 | * | 支持 |
ScaleCluster | 集群扩容 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
ScaleInnerJobs | 扩缩容作业 | 操作级 | * | 支持 |
StopHadoopYarnCluster | StopHadoopYarnCluster | 操作级 | * | 支持 |
StopJobScalePlan | 停止作业调优计划 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobSerialId} | 支持 |
StopJobs | 停止作业 | 操作级 | * | 支持 |
StopSessionCluster | 停止Session集群 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterGroupSerialId} | 支持 |
StopSqlGateway | 停止SqlGateway | 操作级 | * | 支持 |
StopSqlPreview | 停止调试任务(session mode) | 资源级 | qcs::oceanus:${Region}:uin/:job/${JobId} | 支持 |
TriggerJobSavepoint | 触发Savepoint | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
UpdateJobResource | 更新作业资源 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobSerialId} | 支持 |
UpdateSavepoint | 更新savepoint | 操作级 | * | 支持 |
读操作
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
CheckAccount | 检查用户是否为内网(云梯)用户 | 操作级 | * | 支持 |
CheckClsInfo | 检测CLS是否可用 | 操作级 | * | 支持 |
CheckClusterName | 集群名称重名检测 | 操作级 | * | 支持 |
CheckClusterNetwork | 主要用于测试用户的Oceanus集群到用户的产品(kafka, mysql, pg等)网络是否连通 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CheckClusterScaleDown | 缩容检查影响的作业 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CheckCommonWhitelist | 通用白名单接口,查询的是 galileo的 WhiteList 表type1 允许不传ItemSpace2 细粒度 0.253 eks | 操作级 | * | 支持 |
CheckConnectionName | 检查数据连接名称是否重复 | 操作级 | * | 支持 |
CheckConnectivity | 联通性校验 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
CheckConnectorName | 查询Connector名是否重复 | 操作级 | * | 支持 |
CheckDdlGrammar | ddl语法检查 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CheckEtlTypeMapping | 检查ETL类型映射 | 操作级 | * | 支持 |
CheckIsAdministrator | 检查是否为超管 | 操作级 | * | 支持 |
CheckJobName | 检测JobName是否重名 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterSerialId} | 支持 |
CheckOceanusRoleGrant | 检查流计算角色授权 | 操作级 | * | 支持 |
CheckResourceName | 查询资源名是否重复 | 操作级 | * | 支持 |
CheckRoleAuthorization | 查询角色授权 | 操作级 | * | 支持 |
CheckRoleName | 自定义角色名称是否存在 | 操作级 | * | 支持 |
CheckSavepoint | 检查快照是否可用 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
CheckSqlDeepGrammar | 深度语法检查 | 操作级 | * | 支持 |
CheckSqlGrammar | SQL语法检查 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CheckSqlJobGraphConsistency | 检查sql跟专家配置里的运行图是否一致 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
CheckSqlJobStateCompatibility | 兼容性检查 | 操作级 | * | 支持 |
CheckUserCamEmail | 检查用户访问控制中是否绑定邮箱 | 操作级 | * | 支持 |
CheckWhitelist | 白名单检查 | 操作级 | * | 支持 |
CreateEvent | 创建事件 | 操作级 | * | 支持 |
DescribeAccountAuthorization | 查询账号授权 | 操作级 | * | 支持 |
DescribeAuthClassification | 查询授权API分类 | 操作级 | * | 支持 |
DescribeAvailableSubnets | 查询可用子网 | 操作级 | * | 支持 |
DescribeAvailableVPCs | 查询可用vpc | 操作级 | * | 支持 |
DescribeBucketInfo | 查询Cos桶信息 | 操作级 | * | 支持 |
DescribeCHDFSAccessGroups | 查询j集群CHDFS权限组 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeCOSBuckets | 获取用户 COS Bucket 列表 | 操作级 | * | 支持 |
DescribeCatalogRelatedJobs | 查询Catalog关联的Job | 操作级 | * | 支持 |
DescribeCatalogs | 查询元数据 Catalog | 操作级 | * | 支持 |
DescribeClsAuthInfo | 查询cls临时授权信息 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeClsLogSets | 查询CLS日志集列表 | 操作级 | * | 支持 |
DescribeClsLogTopics | 查询CLS日志主题 | 操作级 | * | 支持 |
DescribeClsRelatedJob | CLS关联的作业信息 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeClsTopicConfiguration | 插叙日志主题配置 | 操作级 | * | 支持 |
DescribeCluster | 查询集群 | 操作级 | * | 支持 |
DescribeClusterCls | 集群绑定CLS详情接口 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeClusterDNS | 查询集群自定义 DNS 配置 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeClusterEsServerless | 查询集群绑定的 EsServerless | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeClusterFeatures | 获取集群特性 | 操作级 | * | 支持 |
DescribeClusterState | 查询集群创建流程 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeCommonErrorKeywords | 获取常见错误关键字 | 操作级 | * | 支持 |
DescribeConnShardingTables | 查询分库分表 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeConnSubItemSchema | 查询连接表结构 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeConnectionSubItems | 库表查询接口 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeConnections | 获取数据连接列表 | 操作级 | * | 支持 |
DescribeCorrelation | 查询项目空间和集群 | 操作级 | * | 支持 |
DescribeDebugJob | 查询调试作业状态 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeDebugResult | 获取调试结果 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeDefaultParallelism | 查询作业最大并行度 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeDependencyUrl | 获取下载依赖的临时Url | 操作级 | * | 支持 |
DescribeDocuments | 获取概览页文档列表 | 操作级 | * | 支持 |
DescribeDraftConfigs | 查询作业草稿配置 | 操作级 | * | 支持 |
DescribeEngineJobLog | wedata查询引擎交互式日志 | 操作级 | * | 支持 |
DescribeEngineJobResult | wedata查询结果 | 操作级 | * | 支持 |
DescribeEngineJobState | wedata查询引擎计算作业执行状态和进度 | 操作级 | * | 支持 |
DescribeEtlPreCheckStatus | 查询预检查任务状态 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeExternalMetaCatalog | 列出ExternalMetaCatalog详情 | 操作级 | * | 支持 |
DescribeExternalMetaDatabases | 查询 ExternalMetaCatalog 数据库 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeExternalMetaTable | 导入云资源中的mysql-cdc/jdbc,或者自定义mysql-cdc/jdbc/clickhouse | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeExternalMetaTables | 查询 ExternalMetaCatalog 数据表 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeFineGrainedResourceZones | 查询支持细粒度资源的可用区 | 操作级 | * | 支持 |
DescribeFlinkConf | Flink高级参数校验 | 操作级 | * | 支持 |
DescribeFlinkRestApi | 【内部使用】调用Flink Rest Api | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeFlinkSql | 获取ETL作业对应版本的FlinkSQL | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeFolder | 查询文件夹 | 操作级 | * | 支持 |
DescribeJar | 检查jar资源包 | 操作级 | * | 支持 |
DescribeJobCheckpointMetric | 获取Checkpoint指标 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobConfigs | 查询作业配置 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobDetail | 显示作业详情 | 操作级 | * | 支持 |
DescribeJobEvents | 获取作业近期的各类关键事件 | 操作级 | * | 支持 |
DescribeJobJobManagerMetric | 获取JobManager指标 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobRunningLog | 查询作业运行日志 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobRunningLogStatus | 查询运行日志是否开启 | 操作级 | * | 支持 |
DescribeJobRuntimeInfo | 查询作业运行时信息 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobSavepoint | 查找Savepoint列表 | 资源级 | qcs::oceanus::uin/${uin}:job/${JobId} | 支持 |
DescribeJobScaleEvents | 获取自动扩缩容记录 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobScalePlans | 获取自动扩缩容计划 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobSerialId} | 支持 |
DescribeJobScaleRules | 查询扩缩容规则 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobSubmissionLog | 查询作业启动日志 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobSubmissionLogSet | 查询作业启动日志集 | 操作级 | * | 支持 |
DescribeJobTagsForMonitor | 云监控作业标签六段式接口 | 操作级 | * | 支持 |
DescribeJobTaskManagerMetric | 获取TaskManager指标 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobTaskMetric | 获取作业Task指标 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeJobs | 查询作业列表 | 资源级 | qcs::oceanus::uin/${uin}:- | 支持 |
DescribeJobsException | 查询作业异常情况 | 操作级 | * | 支持 |
DescribeJobsExists | 判断作业是否有被删除或者不存在 | 操作级 | * | 支持 |
DescribeLoginSettings | 校验登录密码合法性 | 操作级 | * | 支持 |
DescribeMetaCatalogs | 查询元数据目录列表 | 操作级 | * | 支持 |
DescribeMetaDatabases | 查询元数据库的信息 | 操作级 | * | 支持 |
DescribeMetaReferences | 查询元数据引用信息 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeMetaTable | 查询表和属性详细信息 | 操作级 | * | 支持 |
DescribeMetaTableChangeLogs | 查询元数据表变更记录 | 操作级 | * | 支持 |
DescribeMetaTables | 查询数据表 | 操作级 | * | 支持 |
DescribeMetricProxy | 调用云观测平台接口获取监控 | 操作级 | * | 支持 |
DescribePermissions | 查询所有权限 | 操作级 | * | 支持 |
DescribePodMetric | 查询作业相关pod的指标 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribePodSpecs | 查询细粒度资源规格 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeProperClsLogset | 获取Oceanus专有日志集 | 操作级 | * | 支持 |
DescribeProperClsTopic | 获取Oceanus专有日志主题 | 操作级 | * | 支持 |
DescribeProperESServerlessIndex | 查询 ES Serverless 的索引信息 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeProperESServerlessSpace | 查询ES Serverless项目空间 | 操作级 | * | 支持 |
DescribePythonEnv | 获取Flink版本下,支持的python运行环境版本 | 操作级 | * | 支持 |
DescribeRegionJobCount | 查询区域作业数 | 操作级 | * | 支持 |
DescribeRegionZones | 查询区域详情 | 操作级 | * | 支持 |
DescribeRegions | 查询区域信息 | 操作级 | * | 支持 |
DescribeResourceConfigContent | 查看资源配置内容 | 操作级 | * | 支持 |
DescribeResourceConfigs | 查询资源配置 | 操作级 | * | 支持 |
DescribeResourceOverview | 获取资源概览信息 | 操作级 | * | 支持 |
DescribeResourceRelatedJobs | 查询资源关联作业信息 | 操作级 | * | 支持 |
DescribeResources | 查询资源 | 操作级 | * | 支持 |
DescribeRoleAuthorization | 角色权限描述 | 操作级 | * | 支持 |
DescribeRoles | 查询所有角色 | 操作级 | * | 支持 |
DescribeSetatsConfiguration | 查询 Setats 配置 | 操作级 | * | 支持 |
DescribeSqlKeyword | 查询Sql关键字 | 操作级 | * | 支持 |
DescribeSqlTemplate | 查询Sql模板 | 操作级 | * | 支持 |
DescribeSupportCatalogs | 查询支持的Catalog | 操作级 | * | 支持 |
DescribeSupportZones | 查询 多可用区 | 操作级 | * | 支持 |
DescribeSynchronousVersion | 获取版本 | 操作级 | * | 支持 |
DescribeSystemResources | 查询流计算内置资源 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeTableList | 根据选定connector查询对应数据源的table列表 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeTableSchema | 查询数据源Schema | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeTableSource | 查询SQL的数据源 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
DescribeTreeJobs | 生成树状作业显示结构 | 操作级 | * | 支持 |
DescribeTreeResources | 查询树状结构资源列表 | 操作级 | * | 支持 |
DescribeUnboundWorkSpaces | 查询集群未绑定的空间 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterGroupSerialId} | 支持 |
DescribeUserAuthentication | 查询用户角色授权状态 | 操作级 | * | 支持 |
DescribeUserResourceLimit | 查询用户资源配额 | 操作级 | * | 支持 |
DescribeVariables | 变量列表展示 | 操作级 | * | 支持 |
DescribeVariablesHistory | 查询变量历史 | 操作级 | * | 支持 |
DescribeWorkSpaceUsers | 描述空间用户 | 操作级 | * | 支持 |
DescribeWorkSpaces | 授权工作空间列表 | 操作级 | * | 支持 |
FetchSqlGatewayStatementResult | 获取执行结果 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
FetchSqlPreview | 获取调试任务结果(session mode) | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
GetAreaByUin | 查询用户注册地 | 操作级 | * | 支持 |
GetMetaTable | 查询元数据表 | 操作级 | * | 支持 |
JobAlert | 作业警告 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} | 支持 |
JobsRunPreCheck | 作业运行前检查 | 操作级 | * | 支持 |
NotifyJobSucceeded | 通知作业成功 | 操作级 | * | 支持 |
ParseConnector | 解析用户自定义Connector | 操作级 | * | 支持 |
PullCommands | 拉取作业命令 | 操作级 | * | 支持 |
QueryFolder | 根据目录名查询文件夹 | 操作级 | * | 支持 |
QueryJob | 查询作业 | 资源级 | qcs::oceanus::uin/${uin}:job/${SerialId} | 支持 |
SendWarningInfo | 发送作业警告 | 操作级 | * | 支持 |
SyncJobEventAlert | 同步作业事件 | 操作级 | * | 支持 |
列表操作
接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
---|---|---|---|---|
DescribeAdministrators | 超管用户列表 | 操作级 | * | 支持 |
DescribeCHdfsFileSystems | 查询CHDFS文件系统 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |
DescribeClusters | 查询集群列表 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterIds} | 支持 |
DescribeDefaultJobConfig | 查询默认作业配置 | 操作级 | * | 支持 |
DescribeFunctionArtifact | 描述udfs接口 | 操作级 | * | 支持 |
DescribeWebUIWhiteList | 查询WebUI IP白名单列表 | 资源级 | qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} | 支持 |