Cloud Data Warehouse
Last updated:2026-01-27 09:47:26
Fundamental information
| Product | Abbreviation in CAM | Console | Authorization by Tag | Authorization Granularity | IP Restriction |
|---|---|---|---|---|---|
| Cloud Data Warehouse ClickHouse | cdwch | Supported | Supported | Resource level | Partially supported |
Note：
The authorization granularity of cloud products is divided into three levels: service level, operation level, and resource level, based on the degree of granularity.
- Service level: It defines whether a user has the permission to access the service as a whole. A user can have either full access or no access to the service. For the authorization granularity of cloud products at service level, the authorization of specific APIs are not supported.
- Operation level: It defines whether a user has the permission to call a specific API of the service. For example, granting an account read-only access to the CVM service is an authorization at the operation level.
- Resource level: It is the finest authorization granularity which defines whether a user has the permission to access specific resources. For example, granting an account read/write access to a specific CVM instance is an authorization at the resource level.
API authorization granularity
Two authorization granularity levels of API are supported: resource level, and operation level.
- Resource level: It supports the authorization of a specific resource.
- Operation level: It does not support the authorization of a specific resource. If the policy syntax restricts a specific resource during authorization, CAM will determine that this API is not within the scope of authorization, and deem it as unauthorized.
Write operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| ActionAlterCkUser | ActionAlterCkUser | Operation level | * | Supported |
| ActionCreateCos | ActionCreateCos | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ActionCreateInstanceGrayTask | ActionCreateInstanceGrayTask | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ActionDmsAuthority | dms authority | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| AddNewDictionary | add dictionary | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| AddSparkJob | AddSparkJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| AlterCNUser | AlterCNUser | Operation level | * | Supported |
| AttachChProxy | AttachChProxy | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| AttachCosConfig | AttachCosConfig | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| AuthorizedCNSql | AuthorizedCNSql | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CancelCNCreateInstance | CancelCNCreateInstance | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CancelHostTransferJob | CancelHostTransferJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CancelHostTransferJobTable | CancelHostTransferJobTable | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CancelReShardingJob | CancelReShardingJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CancelReShardingJobTable | CancelReShardingJobTable | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CancelRestartTip | CancelRestartTip | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ClosePublicCloudClb | ClosePublicCloudClb | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ConfirmTransferJobStopWrite | ConfirmTransferJobStopWrite | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| CreateBackUpSchedule | CreateBackUpSchedule | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| CreateCNAutoScalePlan | create、modify auto scale plan | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CreateCNElasticPlan | CreateElasticPlan | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| CreateCNExtraStorage | CreateCNExtraStorage | Operation level | * | Supported |
| CreateCNInstance | CreateCNInstance | Operation level | * | Supported |
| CreateCNRegularPlan | create regular plan | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CreateCNVirtualCluster | CreateCNVirtualCluster | Operation level | * | Supported |
| CreateEsLog | CreateEsLog | Resource level | qcs::cdwch:${region}:uin/:cdwchInstance/${InstanceId} | Supported |
| CreateHostTransferJob | CreateHostTransferJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CreateInstance | CreateInstance | Operation level | * | Supported |
| CreateInstanceGrayVersion | CreateInstanceGrayVersion | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CreateInstanceNew | Create Instance | Operation level | * | Supported |
| CreateMCPInstance | CreateMcpInstance | Operation level | * | Supported |
| CreateMigrationJob | CreateMigrationJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CreatePublicCloudClb | CreatePublicCloudClb | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| CreateReShardingJob | CreateReShardingJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteBackUpData | DeleteBackUpData | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DeleteBackUpDataForce | DeleteBackUpDataForce | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteCNAutoScalePlan | delete auto scale plan | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteCNElasticPlan | DeleteElasticPlan | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteCNRegularPlan | delete regular plan | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteCNUserConfig | DeleteCNUserConfig | Resource level | qcs::cdwch:${Region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteCNVirtualCluster | DeleteCNVirtualCluster | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteDictionary | DeleteDictionary | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteHostTransferJob | DeleteHostTransferJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteInstanceGrayVersion | DeleteInstanceGrayVersion | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteReShardingJob | DeleteReShardingJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DeleteTransferJob | Delete Transfer Job | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DeleteUserConfig | DeleteUserConfig | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DestroyInstance | DestroyInstance | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DestroyRunProcess | DestroyRunProcess | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceID} | Supported |
| DisableLogService | disable log service | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| ExchangeHostTransferJobTable | ExchangeHostTransferJobTable | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ExchangeReShardingJobTable | ExchangeReShardingJobTable | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ExecuteCNSql | ExecuteCNSql | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ExecuteDmsSql | ExecuteDmsSql | Operation level | * | Supported |
| FinishTransferJob | FinishTransferJob | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| FitClsLog | FitClsLog | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| HandleEventTask | HandleEventTask | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| KillCNQueries | KillCNQueries | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| KillQueries | KillQueries | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyCNCkUserPrivileges | ModifyCNCkUserPrivileges | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyCNConfigs | ModifyCNConfigs | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyCNInstance | ModifyCNInstance | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| ModifyCNKeyValConfigs | ModifyCNKeyValConfigs | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyCNUserConfig | ModifyCNUserConfig | Resource level | qcs::cdwch:${Region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyClusterConfigs | ModifyClusterConfigs | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| ModifyConfigMode | ModifyConfigMode | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyCosMoveFactor | ModifyCosMoveFactor | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyDefaultPassword | ModifyDefaultPassword | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyDictionary | modify dictionary | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyEventRulesConfig | ModifyEventRulesConfig | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| ModifyEventTaskReadInfo | ModifyEventTaskReadInfo | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| ModifyHostTransferJob | ModifyHostTransferJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyHostTransferJobParameter | ModifyHostTransferJobParameter | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyImpalaUserPrivileges | ModifyImpalaUserPrivileges | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyInstance | Modify Information for Instance | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | Supported |
| ModifyInstanceConfigs | Modify Instance Configs | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | Supported |
| ModifyInstanceDetails | modify instance details | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyInstanceGrayVersion | ModifyInstanceGrayVersion | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyInstanceKeyValConfigs | ModifyInstanceKeyValConfigs | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/$InstanceId | Supported |
| ModifyMigrationJob | ModifyMigrationJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyMonitorInfo | ModifyMonitorInfo | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyReShardingJob | ModifyReShardingJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyReShardingJobParameter | ModifyReShardingJobParameter | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifySecurityGroups | ModifySecurityGroups | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyTransferJob | ModifyTransferJob | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| ModifyUserConfig | ModifyUserConfig | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyUserNewPrivilege | ModifyUserNewPrivilege | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyUserNodesIP | ModifyUserNodesIP | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| ModifyUserPrivilege | ModifyUserPrivilege | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ModifyZookeeperRestartSchedule | ModifyZookeeperRestartSchedule | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| OpenBackUp | OpenBackUp | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| OperateCNClusterStatus | OperateCNClusterStatus | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| RebootInstances | RebootInstances | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| RecoverBackUpJob | RecoverBackUpJob | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| RemoveHostTransferJobOriginTable | RemoveHostTransferJobOriginTable | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| RemoveReShardingJobOriginTable | RemoveReShardingJobOriginTable | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ResizeDisk | ResizeDisk | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| RestartCNInstance | RestartCNInstance | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| RestartClusterForConfigs | RestartClusterForConfigs | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| RestartInstance | RestartInstance | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| RetainReShardingJobOriginTable | RetainReShardingJobOriginTable | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| RetryTransferJobFailedTask | Retry Transfer Job Failed Task | Resource level | qcs::cdwch::uin/:cdwchInstance/${InstanceId} | Supported |
| ScaleCNExtraStorage | ScaleCNExtraStorage | Operation level | * | Supported |
| ScaleCNInstance | ScaleCNInstance | Operation level | * | Supported |
| ScaleCNOutUpInstance | scal out up instance | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ScaleOutInstance | scaleout instance | Resource level | qcs::cdwch:${Region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ScaleUpInstance | ScaleUpInstance | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| StartHostTransferJob | StartHostTransferJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| StartReShardingJob | StartReShardingJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| StartTransferJobDataCheck | StartTransferJobDataCheck | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| StartTransferJobIncrementTransfer | StartTransferJobIncrementTransfer | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| StartTransferJobPartitionFix | StartTransferJobPartitionFix | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| StartTransferJobPreCheck | StartTransferJobPreCheck | Resource level | qcs::cdwch::uin/:cdwchInstance/${InstanceId} | Supported |
| StartTransferJobSchemaCollect | StartTransferJobSchemaCollect | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| StartTransferJobStockTransfer | StartTransferJobStockTransfer | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| StopTransferJob | StopTransferJob | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| SyncMaterialViewData | SyncMaterialViewData | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | Supported |
| SyncMaterialViewPartition | SyncMaterialViewPartition | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | Supported |
| SyncMaterialViewPatition | SyncMaterialViewPartition | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | not supported |
| TerminateCNInstance | TerminateCNInstance | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| TerminateInstance | Terminate Instance | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | Supported |
| TerminateMCPInstance | terminal mcp server | Operation level | * | Supported |
| TryContinueHostTransferJobTable | TryContinueHostTransferJobTable | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| TryContinueReShardingJobTable | TryContinueReShardingJobTable | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| UpdateSparkJob | UpdateSparkJob | Operation level | * | Supported |
| UpgradeZkVersion | UpgradeZkVersion | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| ValidateLocalUser | ValidateLocalUser | Operation level | * | Supported |
Read operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| ActionDmsDescribe | ActionDmsDescribe | Operation level | * | Supported |
| CheckDictionarySourceConnection | check dictionary | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeAvailableRegion | DescribeAvailableRegion | Operation level | * | Supported |
| DescribeBackUpJob | DescribeBackUpJob | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeBackUpJobDetail | DescribeBackUpJobDetail | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeBackUpSchedule | DescribeBackUpSchedule | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeBackUpTables | DescribeBackUpTables | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeBucketLifecycle | DescribeBucketLifecycle | Operation level | * | Supported |
| DescribeCNCkSql | DescribeCNCkSql | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCNCosSpec | DescribeCNCosSpec | Operation level | * | Supported |
| DescribeCNDmsSqlHistory | DescribeCNDmsSqlHistory | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCNGoodsDetail | Generate the GoodsDetail structure of the accounting-related interface | Operation level | * | Supported |
| DescribeCNInstance | DescribeCNInstance | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCNInstances | Get Instances List | Resource level | qcs::cdwch:$region:$account:cdwchInstance/* | Supported |
| DescribeCNRegionZone | DescribeCNRegionZone | Operation level | * | Supported |
| DescribeCNRunningQuery | DescribeCNRunningQuery | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCNSlowQueryRecords | DescribeCNSlowQueryRecords | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCNSlowQueryTrend | DescribeCNSlowQueryTrend | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCNSpec | DescribeCNSpec | Operation level | * | Supported |
| DescribeCosConfig | DescribeCosConfig | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeDictionarySourceDatabases | describe db list | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeDictionarySourceTables | describe dictionary source tables | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeEventRules | DescribeEventRules | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeEventTasks | DescribeEventTasks | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeGoodsDetail | Describe GoodsDetail | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/* | Supported |
| DescribeHostTransferJob | DescribeHostTransferJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeImpalaSql | DescribeImpalaSql | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeInstance | Get Instance Details | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$cdwchInstanceId | Supported |
| DescribeInstanceClusters | DescribeInstanceClusters | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeInstanceConfigs | Describe Instance Configs | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | Supported |
| DescribeInstanceCountProxy | DescribeInstanceCountProxy | Operation level | * | Supported |
| DescribeInstanceGrayVersion | DescribeInstanceGrayVersion | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeInstanceKeyValConfigs | DescribeInstanceKeyValConfigs | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeInstanceMonitorPort | DescribeInstanceMonitorPort | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeInstanceNodes | Get Node Information for Instance | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$cdwchinstanceId | Supported |
| DescribeInstanceOperations | Describe Instance Operations | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | Supported |
| DescribeInstanceShards | DescribeInstanceShards | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeInstanceState | Describe Instance State | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$InstanceId | Supported |
| DescribeInstanceZk | Get Instance Zk Details | Resource level | qcs::cdwch::uin/${uin}:cdwchInstance/$cdwchInstanceId | Supported |
| DescribeInstances | Get Instances List | Resource level | qcs::cdwch:$region:$account:cdwchInstance/* | Supported |
| DescribeInstancesNew | DescribeInstancesNew | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/* | Supported |
| DescribeInstancesV2 | Get Instances List | Operation level | * | Supported |
| DescribeMaterialView | DescribeMaterialView | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | Supported |
| DescribeMaterialViewSchedule | DescribeMaterialViewSchedule | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | Supported |
| DescribeMetricData | Get Metric Data | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$cdwchInstanceId | Supported |
| DescribeMetricMeta | Get MetaData about monitoring | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$cdwchInstanceId | Supported |
| DescribeMrMetricFiles | DescribeMrMetricFiles | Operation level | * | Supported |
| DescribeOverviewData | Get Metric Data for OverviewPage | Resource level | qcs::cdwch:$region:$account:cdwchInstance/$cdwchInstanceId | Supported |
| DescribePricePageRegionInfo | DescribePricePageRegionInfo | Operation level | * | Supported |
| DescribePricePageSpec | DescribePricePageSpec | Operation level | * | Supported |
| DescribeReShardingJob | DescribeReShardingJob | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeReShardingTables | DescribeReShardingTables | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeRunningQuery | DescribeRunningQuery | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeSlowQueryRecords | DescribeSlowQueryRecords | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeSlowQueryTrend | DescribeSlowQueryTrend | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceID} | Supported |
| DescribeSpec | Describe Spec | Operation level | * | Supported |
| DescribeTableDistribution | DescribeTableDistribution | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeTableSchema | DescribeTableSchema | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeTransferJobDatabaseSchema | DescribeTransferJobDatabaseSchema | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeTransferJobDetail | DescribeTransferJobDetail | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeTransferJobList | DescribeTransferJobList | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeTransferJobPreCheckResult | DescribeTransferJobPreCheckResult | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeTransferJobTransferResult | Describe Transfer Job Result | Resource level | qcs::cdwch:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeUnreadEventTasks | DescribeUnreadEventTasks | Operation level | * | Supported |
| DescribeZookeeperRestartSchedule | DescribeZookeeperRestartSchedule | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| QueryPrice | QueryPrice | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${ResourceID} | Supported |
| SearchClsLog | SearchClsLog | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
List Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| DescribeAreaRegion | DescribeAreaRegion | Operation level | * | Supported |
| DescribeBillingParams | DescribeBillingParams | Operation level | * | Supported |
| DescribeCNAreaRegion | controller proxy keeper monitor role | Operation level | * | Supported |
| DescribeCNInstanceConfigHistories | DescribeCNInstanceConfigHistories | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCNInstanceConfigs | DescribeCNInstanceConfigs | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceID} | Supported |
| DescribeCNInstanceKeyValConfigs | DescribeCNInstanceKeyValConfigs | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCNInstanceOperations | DescribeCNInstanceOperations | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCNSql | DescribeCNSql | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCkMetas | DescribeCkMetas | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeCkSqlApis | DescribeCkSqlApis | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeClusterConfigsHistory | DescribeClusterConfigsHistory | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
| DescribeDictionaries | DescribeDictionaries | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeDictionaryNameList | DescribeDictionaryNameList | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeDictionarySourceTableInfo | DescribeDictionarySourceTableInfo | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeDmsSqlHistory | DescribeDmsSqlHistory | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeHostTransferJobTables | DescribeHostTransferJobTables | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeHostTransferJobs | DescribeHostTransferJobs | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeHostTransferTables | DescribeHostTransferTables | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeInstanceForMonitor | DescribeInstanceForMonitor | Operation level | * | Supported |
| DescribeInstanceGrayPacketVersions | DescribeInstanceGrayPacketVersions | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeInstanceGrayVersions | DescribeInstanceGrayVersions | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeInstanceNodesForBarad | DescribeInstanceNodesForBarad | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeInstanceScaleOutTableResults | DescribeInstanceScaleOutTableResults | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeMigrationInstances | DescribeMigrationInstances | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeMigrationTables | DescribeMigrationTables | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeMonitorSpec | DescribeMonitorSpec | Operation level | * | Supported |
| DescribeProductDiscount | DescribeProductDiscount | Operation level | * | Supported |
| DescribeReShardingJobTables | DescribeReShardingJobTables | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeReShardingJobs | DescribeReShardingJobs | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeReShardingTablePartitions | DescribeReShardingTablePartitions | Resource level | qcs::cdwch:${region}:uin/${uin}:cdwchInstance/${InstanceId} | Supported |
| DescribeRegionZone | DescribeRegionZone | Operation level | * | Supported |
Other Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| UpgradeVersion | UpgradeVersion | Resource level | qcs::${ApiModule}:${Region}:uin/:cdwchInstance/${InstanceId} | Supported |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback