接口名 |
接口描述 |
授权粒度 |
资源六段式 |
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} |
支持 |
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} |
支持 |
CheckWhitelist |
白名单检查 |
操作级 |
* |
支持 |
CreateEvent |
创建事件 |
操作级 |
* |
支持 |
DescribeAccountAuthorization |
查询账号授权 |
操作级 |
* |
支持 |
DescribeAuthClassification |
查询授权API分类 |
操作级 |
* |
支持 |
DescribeAvailableSubnets |
查询可用子网 |
资源级 |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
支持 |
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 |
查询作业最大并行度 |
操作级 |
* |
支持 |
DescribeDependencyUrl |
获取下载依赖的临时Url |
操作级 |
* |
支持 |
DescribeDocuments |
获取概览页文档列表 |
操作级 |
* |
支持 |
DescribeDraftConfigs |
查询作业草稿配置 |
操作级 |
* |
支持 |
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} |
支持 |
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 |
查询作业启动日志集 |
操作级 |
* |
支持 |
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 |
查询表和属性详细信息 |
资源级 |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
支持 |
DescribeMetaTableChangeLogs |
查询元数据表变更记录 |
操作级 |
* |
支持 |
DescribeMetaTables |
查询数据表 |
操作级 |
* |
支持 |
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 |
查询资源配置 |
资源级 |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
支持 |
DescribeResourceOverview |
获取资源概览信息 |
操作级 |
* |
支持 |
DescribeResourceRelatedJobs |
查询资源关联作业信息 |
操作级 |
* |
支持 |
DescribeResources |
查询资源 |
操作级 |
* |
支持 |
DescribeRoleAuthorization |
角色权限描述 |
操作级 |
* |
支持 |
DescribeRoles |
查询所有角色 |
操作级 |
* |
支持 |
DescribeSqlKeyword |
查询Sql关键字 |
操作级 |
* |
支持 |
DescribeSqlTemplate |
查询Sql模板 |
操作级 |
* |
支持 |
DescribeSupportCatalogs |
查询支持的Catalog |
操作级 |
* |
支持 |
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} |
支持 |
GetMetaTable |
查询元数据表 |
操作级 |
* |
支持 |
JobAlert |
作业警告 |
资源级 |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
支持 |
JobsRunPreCheck |
作业运行前检查 |
操作级 |
* |
支持 |
NotifyJobSucceeded |
通知作业成功 |
操作级 |
* |
支持 |
PullCommands |
拉取作业命令 |
操作级 |
* |
支持 |
QueryJob |
查询作业 |
资源级 |
qcs::oceanus::uin/${uin}:job/${SerialId} |
支持 |
SendWarningInfo |
发送作业警告 |
操作级 |
* |
支持 |
SyncJobEventAlert |
同步作业事件 |
操作级 |
* |
支持 |
本页内容是否解决了您的问题?