API |
API Description |
Authorization Granularity |
Six-segment Resource Description |
IP Restriction |
CheckAccount |
CheckAccount |
Operation level |
* |
Supported |
CheckClsInfo |
check CLS |
Operation level |
* |
Supported |
CheckClusterName |
Cluster name rename detection |
Operation level |
* |
Supported |
CheckClusterNetwork |
Check network for cluster |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
CheckClusterScaleDown |
Check Cluster Scale Down |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
CheckCommonWhitelist |
Check Common White list |
Operation level |
* |
Supported |
CheckConnectionName |
check connection name |
Operation level |
* |
Supported |
CheckConnectivity |
Check Connectivity |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
CheckDdlGrammar |
CheckDdlGrammar |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
CheckEtlTypeMapping |
check mapping |
Operation level |
* |
Supported |
CheckIsAdministrator |
Check for SuperAdministrator |
Operation level |
* |
Supported |
CheckJobName |
Check whether the JobName is renamed |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterSerialId} |
Supported |
CheckOceanusRoleGrant |
check oceanus role |
Operation level |
* |
Supported |
CheckResourceName |
CheckResourceName |
Operation level |
* |
Supported |
CheckRoleAuthorization |
Query role authorization |
Operation level |
* |
Supported |
CheckRoleName |
check role name exists or not |
Operation level |
* |
Supported |
CheckSavepoint |
check if savepoint is available |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
CheckSqlDeepGrammar |
CheckSqlDeepGrammar |
Operation level |
* |
Supported |
CheckSqlGrammar |
CheckSqlGrammar |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
CheckSqlJobGraphConsistency |
To check if the SQL query matches the execution plan in the expert configuration |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
CheckWhitelist |
CheckWhitelist |
Operation level |
* |
Supported |
CreateEvent |
CreateEvent |
Operation level |
* |
Supported |
DescribeAccountAuthorization |
DescribeAccountAuthorization |
Operation level |
* |
Supported |
DescribeAuthClassification |
Query authorization API classification |
Operation level |
* |
Supported |
DescribeAvailableSubnets |
Query available subnets |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeAvailableVPCs |
Query available vpc |
Operation level |
* |
Supported |
DescribeBucketInfo |
DescribeBucketInfo |
Operation level |
* |
Supported |
DescribeCHDFSAccessGroups |
DescribeCHDFSAccessGroups |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeCOSBuckets |
DescribeCOSBuckets |
Operation level |
* |
Supported |
DescribeCatalogRelatedJobs |
Describe Catalog Related Jobs |
Operation level |
* |
Supported |
DescribeCatalogs |
Describe Catalogs |
Operation level |
* |
Supported |
DescribeClsAuthInfo |
query cls temporary secretId/secretKey/token |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeClsLogSets |
DescribeClsLogSets |
Operation level |
* |
Supported |
DescribeClsLogTopics |
DescribeClsLogTopics |
Operation level |
* |
Supported |
DescribeClsRelatedJob |
describe CLS related job |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeClsTopicConfiguration |
DescribeClsTopicConfiguration |
Operation level |
* |
Supported |
DescribeCluster |
describe cluster |
Operation level |
* |
Supported |
DescribeClusterCls |
describe cluster CLS |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeClusterDNS |
DescribeClusterDNS |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeClusterEsServerless |
DescribeClusterEsServerless |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeClusterFeatures |
DescribeClusterFeatures |
Operation level |
* |
Supported |
DescribeClusterState |
DescribeClusterState |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeCommonErrorKeywords |
DescribeCommonErrorKeywords |
Operation level |
* |
Supported |
DescribeConnShardingTables |
Describe sharding tables |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeConnSubItemSchema |
Describe Conn SubItem Schema |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeConnectionSubItems |
Describe Connection SubItems |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeConnections |
get connection list |
Operation level |
* |
Supported |
DescribeCorrelation |
Query for the project space and for the clusters |
Operation level |
* |
Supported |
DescribeDebugJob |
DescribeDebugJob |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeDebugResult |
DescribeDebugResult |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeDefaultParallelism |
DescribeDefaultParallelism |
Operation level |
* |
Supported |
DescribeDependencyUrl |
DescribeDependencyUrl |
Operation level |
* |
Supported |
DescribeDocuments |
DescribeDocuments |
Operation level |
* |
Supported |
DescribeDraftConfigs |
DescribeDraftConfigs |
Operation level |
* |
Supported |
DescribeEtlPreCheckStatus |
Querying the Precheck Task Status |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeExternalMetaCatalog |
Describe External MetaCatalog |
Operation level |
* |
Supported |
DescribeExternalMetaDatabases |
Describe External Meta Databases |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeExternalMetaTable |
import data from cloud |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeExternalMetaTables |
Describe External Meta Tables |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeFineGrainedResourceZones |
DescribeFineGrainedResourceZones |
Operation level |
* |
Supported |
DescribeFlinkConf |
DescribeFlinkConf |
Operation level |
* |
Supported |
DescribeFlinkRestApi |
DescribeFlinkRestApi |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeFlinkSql |
get flink sql |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeFolder |
Describe folder information |
Operation level |
* |
Supported |
DescribeJar |
DescribeJar |
Operation level |
* |
Supported |
DescribeJobCheckpointMetric |
DescribeJobCheckpointMetric |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobConfigs |
DescribeJobConfigs |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobEvents |
List all of the critical events for the job |
Operation level |
* |
Supported |
DescribeJobJobManagerMetric |
DescribeJobJobManagerMetric |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobRunningLog |
DescribeJobRunningLog |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobRunningLogStatus |
DescribeJobRunningLogStatus |
Operation level |
* |
Supported |
DescribeJobRuntimeInfo |
DescribeJobRuntimeInfo |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobSavepoint |
DescribeJobSavepoint |
Resource level |
qcs::oceanus::uin/${uin}:job/${JobId} |
Supported |
DescribeJobScaleEvents |
Get auto-scaling records |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobScalePlans |
describe job scale plan |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobSerialId} |
Supported |
DescribeJobScaleRules |
Querying automatic scaling rules |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobSubmissionLog |
DescribeJobSubmissionLog |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobSubmissionLogSet |
DescribeJobSubmissionLogSet |
Operation level |
* |
Supported |
DescribeJobTaskManagerMetric |
DescribeJobTaskManagerMetric |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobTaskMetric |
DescribeJobTaskMetric |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeJobs |
describe job list |
Resource level |
qcs::oceanus::uin/${uin}:- |
Supported |
DescribeJobsException |
Describe Jobs Exception |
Operation level |
* |
Supported |
DescribeJobsExists |
describe jobs exists |
Operation level |
* |
Supported |
DescribeLoginSettings |
DescribeLoginSettings |
Operation level |
* |
Supported |
DescribeMetaCatalogs |
DescribeMetaCatalogs |
Operation level |
* |
Supported |
DescribeMetaDatabases |
DescribeMetaDatabases |
Operation level |
* |
Supported |
DescribeMetaReferences |
DescribeMetaReferences |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeMetaTable |
DescribeMetaTable |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeMetaTableChangeLogs |
DescribeMetaTableChangeLogs |
Operation level |
* |
Supported |
DescribeMetaTables |
DescribeMetaTables |
Operation level |
* |
Supported |
DescribePermissions |
describe permissions |
Operation level |
* |
Supported |
DescribePodMetric |
DescribePodMetric |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribePodSpecs |
DescribePodSpecs |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeProperClsLogset |
describe proper CLS logset |
Operation level |
* |
Supported |
DescribeProperClsTopic |
describe proper CLS topic |
Operation level |
* |
Supported |
DescribeProperESServerlessIndex |
DescribeProperESServerlessIndex |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeProperESServerlessSpace |
Describe ES ServerlessSpace |
Operation level |
* |
Supported |
DescribePythonEnv |
Obtain the python operating environment version supported by Flink |
Operation level |
* |
Supported |
DescribeRegionJobCount |
DescribeRegionJobCount |
Operation level |
* |
Supported |
DescribeRegionZones |
DescribeRegionZones |
Operation level |
* |
Supported |
DescribeRegions |
DescribeRegions |
Operation level |
* |
Supported |
DescribeResourceConfigContent |
DescribeResourceConfigContent |
Operation level |
* |
Supported |
DescribeResourceConfigs |
DescribeResourceConfigs |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeResourceOverview |
DescribeResourceOverview |
Operation level |
* |
Supported |
DescribeResourceRelatedJobs |
DescribeResourceRelatedJobs |
Operation level |
* |
Supported |
DescribeResources |
DescribeResources |
Operation level |
* |
Supported |
DescribeRoleAuthorization |
Role permissions description |
Operation level |
* |
Supported |
DescribeRoles |
describe all roles |
Operation level |
* |
Supported |
DescribeSqlKeyword |
DescribeSqlKeyword |
Operation level |
* |
Supported |
DescribeSqlTemplate |
DescribeSqlTemplate |
Operation level |
* |
Supported |
DescribeSupportCatalogs |
Describe Support Catalogs |
Operation level |
* |
Supported |
DescribeSynchronousVersion |
Get the version |
Operation level |
* |
Supported |
DescribeSystemResources |
DescribeSystemResources |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
DescribeTableList |
Query the table list of the corresponding data sources according to the selected connector |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeTableSchema |
DescribeTableSchema |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeTableSource |
DescribeTableSource |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
DescribeTreeJobs |
describe tree job |
Operation level |
* |
Supported |
DescribeTreeResources |
DescribeTreeResources |
Operation level |
* |
Supported |
DescribeUnboundWorkSpaces |
Query unbound cluster |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterGroupSerialId} |
Supported |
DescribeUserAuthentication |
DescribeUserAuthentication |
Operation level |
* |
Supported |
DescribeUserResourceLimit |
DescribeUserResourceLimit |
Operation level |
* |
Supported |
DescribeVariables |
describe variables |
Operation level |
* |
Supported |
DescribeVariablesHistory |
describe variables history |
Operation level |
* |
Supported |
DescribeWorkSpaceUsers |
Describe space users |
Operation level |
* |
Supported |
DescribeWorkSpaces |
Authorized workspace list |
Operation level |
* |
Supported |
FetchSqlGatewayStatementResult |
Fetch Result |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:cluster/${ClusterId} |
Supported |
FetchSqlPreview |
Fetch the result of preview sql(session mode) |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
GetMetaTable |
GetMetaTable |
Operation level |
* |
Supported |
JobAlert |
job alert |
Resource level |
qcs::oceanus:${Region}:uin/${Uin}:job/${JobId} |
Supported |
JobsRunPreCheck |
check before run the job |
Operation level |
* |
Supported |
NotifyJobSucceeded |
notify job success |
Operation level |
* |
Supported |
PullCommands |
pull flink job commands |
Operation level |
* |
Supported |
QueryJob |
query flink job |
Resource level |
qcs::oceanus::uin/${uin}:job/${SerialId} |
Supported |
SendWarningInfo |
send job warn info |
Operation level |
* |
Supported |
SyncJobEventAlert |
synchronous job event |
Operation level |
* |
Supported |
Was this page helpful?