Message Queue CKafka
Last updated: 2025-12-04 09:08:30
Fundamental information
| Product | Abbreviation in CAM | Console | Authorization by Tag | Authorization Granularity | IP Restriction |
|---|---|---|---|---|---|
| CKafka | ckafka | 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 |
|---|---|---|---|---|
| AddPartition | AddPartition | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | not supported |
| AddRoute | AddRoute | Operation level | * | not supported |
| AddTopicIpwhitelist | AddTopicIpwhitelist | Operation level | * | not supported |
| AnalyseClickHouseSchema | Analyse ClickHouse Schema | Operation level | * | Supported |
| AnalyseContent | Analyse Content | Operation level | * | Supported |
| AnalyseRecordSchema | Analyse Record Schema | Operation level | * | Supported |
| AssociateRoutesSecurityGroup | Bind route security group | Operation level | * | Supported |
| AuthorizeToken | authorize token | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| BatchCreateAcl | BatchCreateAcl | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| BatchDeleteAcl | BatchDeleteAcl | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| BatchModifyGroupOffsets | BatchModifyGroupOffsets | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| BatchModifyTopicAttributes | BatchModifyTopicAttributes | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| BindSchema | Bind Schema | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTask/${taskId} | Supported |
| BurnCPU | BurnCPU | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${InstanceId} | Supported |
| BurnDiskIO | BurnDiskIO | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${InstanceId} | Supported |
| CancelAuthorizationToken | Cancel Authorization Token | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateAcl | CreateAcl | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateAclRule | create Acl rule | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateCdcCluster | Create Cdc Cluster | Operation level | * | Supported |
| CreateConnectResource | create dip connect resource | Operation level | * | Supported |
| CreateConnector | Create Connector | Operation level | * | Supported |
| CreateConsumer | Create consumer group | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateCrossRegionSyncTask | Create Cross Region Sync Task | Operation level | * | Supported |
| CreateDatahubGroup | create dip consumer group | Operation level | * | Supported |
| CreateDatahubTask | create dip task | Operation level | * | Supported |
| CreateDatahubTopic | create dip topic | Operation level | * | Supported |
| CreateDipLink | Create dip link | Operation level | * | Supported |
| CreateInstance | CreateInstance | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateInstanceAnalysis | Create Instance Analysis | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateInstancePre | CreateInstancePre | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/* qcs::vpc::uin/${uin}:vpc/${vpcId} qcs::vpc::uin/${uin}:subnet/${subnetId} |
Supported |
| CreateMigrateToCloudTask | Create migrate to cloud task | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreatePartition | CreatePartition | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreatePostPaidInstance | CreatePostPaidInstance | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/* qcs::vpc::uin/${uin}:vpc/${vpcId} qcs::vpc::uin/${uin}:subnet/${subnetId} |
Supported |
| CreatePrometheus | CreatePrometheus | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateRoute | CreateRoute | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateSchema | Create schema | Operation level | * | Supported |
| CreateServerlessInstance | create serverless instance | Operation level | * | Supported |
| CreateStringRegularExpressionMatchPattern | CreateStringRegularExpressionMatchPattern | Operation level | * | Supported |
| CreateSystemMaintenanceTime | CreateSystemMaintenanceTime | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateThrottleRule | batch create instance throttle rules | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${InstanceId} | Supported |
| CreateToken | create token | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateTopic | CreateTopic | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateTopicIpWhiteList | CreateTopicIpWhiteList | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| CreateUser | CreateUser | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DelayMessage | DelayMessage | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| DelayMessageRollback | DelayMessageRollback | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteAcl | DeleteAcl | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteAclRule | delete Acl rule | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteConnectResource | delete dip connect resource | Resource level | qcs::ckafka:${region}:uin/${uin}:connectResource/${resourceId} | Supported |
| DeleteConnector | Delete Connector | Operation level | * | Supported |
| DeleteCrossRegionSyncTask | Delete Cross Region Sync Task | Operation level | * | Supported |
| DeleteDatahubGroup | delete dip consumer group | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${topicId} | Supported |
| DeleteDatahubTask | delete dip task | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTask/${taskId} | Supported |
| DeleteDatahubTopic | delete dip Topic | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${topicId} | Supported |
| DeleteDipLink | Delete dip link | Operation level | * | Supported |
| DeleteGroup | Delete consumer group | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteGroupSubscribeTopic | Delete Group Subscribe Topic | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteInstance | DeleteInstance | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteInstancePost | DeleteInstancePost | Operation level | * | Supported |
| DeleteInstancePre | DeleteInstancePre | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteIsolatedInstancePre | DeleteIsolatedInstancePre | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${InstanceId} | Supported |
| DeletePrometheus | DeletePrometheus | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteRoute | DeleteRoute | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteRouteTriggerTime | Modify Route Trigger Time | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteSchema | Delete Schema | Operation level | * | Supported |
| DeleteThrottleRule | delete instance throttle rule | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${InstanceId} | Supported |
| DeleteTopic | DeleteTopic | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteTopicIpWhiteList | Delete Topic IP Whitelist | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DeleteTopicIpwhitelist | DeleteTopicIpwhitelist | Operation level | * | Supported |
| DeleteUser | DeleteUser | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DisassociateRoutesSecurityGroup | Unbind the route security group | Operation level | * | Supported |
| DownAttackRollback | DownAttackRollback | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${InstanceId} | Supported |
| FetchLatestDatahubMessageList | get latest message from task | Operation level | * | Supported |
| InjectDownAttack | shutdown | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${InstanceId} | Supported |
| InstanceScalingDown | InstanceScalingDown | Resource level | qcs::ckafka:${Region}:uin/:ckafkaId/${InstanceId} | Supported |
| IsolatedInstancePre | IsolatedInstancePre | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${InstanceId} | Supported |
| ModifyAclRule | ModifyAclRule | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| ModifyConnectResource | modify dip connect resource attributes | Resource level | qcs::ckafka:${region}:uin/${uin}:connectResource/${resourceId} | Supported |
| ModifyConsumerGroupConfig | ModifyConsumerGroupConfig | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| ModifyDatahubGroupOffsets | modify dip group offset | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${topicId} | Supported |
| ModifyDatahubPartition | add dip topic partition | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${topicId} | Supported |
| ModifyDatahubPassword | modify dip topic password | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${topicId} | Supported |
| ModifyDatahubResource | ModifyDatahubResource | Resource level | qcs::ckafka:${region}:uin/:connectTask/${taskId} | Supported |
| ModifyDatahubTask | ModifyDatahubTask | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTask/${taskId} | Supported |
| ModifyDatahubTopic | modify dip topic attributes | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${topicId} | Supported |
| ModifyForward | ModifyForward | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| ModifyGroupOffsets | ModifyGroupOffsets | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| ModifyInstanceAttributes | ModifyInstanceAttributes | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| ModifyInstanceMultiZone | ModifyInstanceMultiZone | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| ModifyInstancePre | ModifyInstancePre | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| ModifyPassword | ModifyPassword | Operation level | * | Supported |
| ModifyRouteSecurityGroups | Modify route security group association | Operation level | * | Supported |
| ModifyRoutineMaintenanceTask | ModifyRoutineMaintenanceTask | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| ModifySchema | Modify Schema | Operation level | * | Supported |
| ModifyServerlessInstance | modify serverless instance | Operation level | * | Supported |
| ModifyThrottleRule | modify instance throttle rule | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${InstanceId} | Supported |
| ModifyTopicAttributes | ModifyTopicAttributes | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| ModifyTopicReplicas | ModifyTopicReplicas | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${InstanceId} | Supported |
| ModifyTransformation | Modify Transformation | Operation level | * | Supported |
| PauseConnector | Pause Connector | Operation level | * | Supported |
| PauseCrossRegionSyncTask | Pause Cross Region Sync Task | Operation level | * | Supported |
| PauseDatahubTask | pause dip task | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTask/${taskId} | Supported |
| RenewCkafkaInstance | Renew Ckafka instance | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| ResetPublicNetwork | Reset Public Network | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| RestartDatahubTask | RestartDatahubTask | Resource level | qcs::ckafka::uin/${uin}:connectTask/${taskId} | Supported |
| RestartDisasterZone | restart disaster zone brokers | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${InstanceId} | Supported |
| ResumeConnector | Resume Connector | Operation level | * | Supported |
| ResumeCrossRegionSyncTask | Resume Cross Region Sync Task | Operation level | * | Supported |
| ResumeDatahubTask | resume dip task | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTask/${taskId} | Supported |
| SendMessage | HTTP send message | Resource level | qcs::ckafka:${region}:uin/${uin}:datahubId/${DataHubId} | Supported |
| SendMessageByDatahubTopic | Send Message By Datahub Topic | Operation level | * | Supported |
| SendMessageByTopic | Send Message By Topic | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| SetForward | Set ckafka to forward messages to cos | Operation level | * | not supported |
| SetInstanceAttributes | SetInstanceAttributes | Operation level | * | not supported |
| SetTopicAttributes | SetTopicAttributes | Operation level | * | not supported |
| SwitchAvailableZone | swicter to available zone when disaster happends. | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${InstanceId} | Supported |
| TransformContent | Transform Content | Operation level | * | Supported |
| UnbindSchema | Unbind Schema | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTask/${taskId} | Supported |
| UpgradeBrokerVersion | Upgrade Broker Version | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
Read operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| CheckCdcCluster | Check Cdc Cluster | Operation level | * | Supported |
| DescribeACL | DescribeACL | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeAclRule | DescribeAclRule | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeAnalysisDetail | Describe Analysis Detail | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeAnalysisDistribute | Describe Analysis Distribute | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeAppIdIsVip | DescribeAppIdIsVip | Operation level | * | Supported |
| DescribeAppInfo | DescribeAppInfo | Operation level | * | Supported |
| DescribeAsyncResult | DescribeAsyncResult | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeAttackAsyncRequestResult | DescribeAttackAsyncRequestResult | Resource level | qcs::ckafka:${region}:uin/${uin}:asyncRequestId/${AsyncRequestId} | Supported |
| DescribeAutoCreateConsumerGroup | Describe Auto Create Consumer Group | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeBrokerCount | Describe Broker Count | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeBrokerIpInfo | DescribeBrokerIpInfo | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeBrokerIpTcpConnect | Describe Broker Tcp Connect | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeCkafkaOverview | Describe CKafka Overview | Operation level | * | Supported |
| DescribeCkafkaPrice | DescribeCkafkaPrice | Operation level | * | Supported |
| DescribeCkafkaSpecifications | Describe CKafka Specifications | Operation level | * | Supported |
| DescribeCkafkaTypeConfigs | DescribeCkafkaTypeConfigs | Operation level | * | Supported |
| DescribeCkafkaVersion | Describe Instance Version | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeCkafkaZone | DescribeCkafkaZone | Operation level | * | Supported |
| DescribeConnectResource | describe dip connect resource attributes | Resource level | qcs::ckafka:${region}:uin/${uin}:connectResource/${ResourceId} | Supported |
| DescribeConnector | DescribeConnector | Operation level | * | Supported |
| DescribeConnectorConfigs | DescribeConnectorConfigs | Operation level | * | Supported |
| DescribeConnectorStatus | DescribeConnectorStatus | Operation level | * | Supported |
| DescribeCrossRegionConnectorTasks | Describe Cross Region Connector Tasks | Operation level | * | Supported |
| DescribeCrossRegionFlowStatus | Describe Cross Region Flow Status | Operation level | * | Supported |
| DescribeCrossRegionSupportList | Describe Cross Region Support List | Operation level | * | Supported |
| DescribeCrossRegionSyncTaskAttributes | Describe Cross Region Sync Task Attributes | Operation level | * | Supported |
| DescribeCrossRegionSyncTasks | Describe Cross Region Sync Tasks | Operation level | * | Supported |
| DescribeCvmInfo | Describe Cvm Info | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeDataSyncProgress | Describe Data Sync Progress | Operation level | * | Supported |
| DescribeDatahubGroup | describe dip group list | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${topicId} | Supported |
| DescribeDatahubGroupOffsets | describe dip group offset | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${topicId} | Supported |
| DescribeDatahubOverview | Describe Datahub Overview | Operation level | * | Supported |
| DescribeDatahubTask | describe dip task attributes | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTask/${taskId} | Supported |
| DescribeDatahubTopic | describe dip topic attributes | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${Name} | Supported |
| DescribeDatahubTopicSyncReplica | get dip topic list | Operation level | * | Supported |
| DescribeDipLinkAttributes | Describe Dip Link Attributes | Operation level | * | Supported |
| DescribeDipLinks | Describe Dip Links | Operation level | * | Supported |
| DescribeDipTaskEventLogs | Describe Dip Task Event Logs | Operation level | * | Supported |
| DescribeDipTaskSyncMetadataProgress | Describe Dip Task Sync Metadata Progress | Operation level | * | Supported |
| DescribeEventCenterLogDetail | Describe Event Center Log Detail | Operation level | * | Supported |
| DescribeEventCenterLogs | Describe Event Center Logs | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeEventLog | Describe Event Log | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeGroup | DescribeGroup | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | not supported |
| DescribeGroupInfo | DescribeGroupInfo | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | not supported |
| DescribeGroupOffsets | DescribeGroupOffsets | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeHttpSourceTask | Describe Http Source Task | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeIfCommunity | DescribeIfCommunity | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeInstanceAttributes | DescribeInstanceAttributes | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | not supported |
| DescribeInstanceBrokers | describe instance node status | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${InstanceId} | Supported |
| DescribeInstanceCvm | Describe Instance Cvm | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeInstanceDiskChangeHistory | Describe Instance Disk Change History | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeInstanceDowngrade | Describe Instance Downgrade | Operation level | * | Supported |
| DescribeMetaDataSyncProgress | Describe Meta Data Sync Progress | Operation level | * | Supported |
| DescribeMigrateToCloudTask | Describe Migrate To Cloud Task | Operation level | * | Supported |
| DescribeMigrationTask | DescribeMigrationTask | Operation level | * | Supported |
| DescribeModifyProgress | get progress of the modification | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeModifyType | Describe ckafka Instance Modify Type | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeOrderConfig | query price quota for cluster | Operation level | * | Supported |
| DescribeOrderSignInfo | describe order signature information | Operation level | * | Supported |
| DescribePrometheus | Describe Prometheus | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeRegion | DescribeRegion | Operation level | * | Supported |
| DescribeRemoteCosBucketCapacity | Query the remaining amount of the current instance cosbucket | Resource level | qcs::ckafka:${Region}:uin/:ckafkaId/${InstanceId} | Supported |
| DescribeRollbackAsyncRequestResult | DescribeRollbackAsyncRequestResult | Resource level | qcs::ckafka:${region}:uin/${uin}:asyncRequestId/${AsyncRequestId} | Supported |
| DescribeRoute | DescribeRoute | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | not supported |
| DescribeRoutineMaintenanceTasks | Describe Routine Maintenance Tasks | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeRunningEventIds | DescribeRunningEventIds | Operation level | * | Supported |
| DescribeSchema | Describe Schema | Operation level | * | Supported |
| DescribeSchemaAttributes | Describe Schema Attributes | Operation level | * | Supported |
| DescribeSecurityGroupRoutes | Query the security group routing list | Operation level | * | Supported |
| DescribeSwitchOperateStatus | check switch task status | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${InstanceId} | Supported |
| DescribeTargetResource | Describe Target Resource | Operation level | * | Supported |
| DescribeTaskStatus | DescribeTaskStatus | Operation level | * | Supported |
| DescribeTopicAttributes | DescribeTopicAttributes | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeTopicDetail | DescribeTopicDetail | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeTopicDiskUsage | Describe Topic Disk Usage | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeTopicDistribute | DescribeTopicDistribute | Operation level | * | Supported |
| DescribeTopicFlowRanking | describe some topics in the cluster. and get flow metric about the nodes in the cluster, using the default options. | Operation level | * | Supported |
| DescribeTopicOutOfReplica | Describe Topic Out Of Replica | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeTopicProduceConnection | Get producer connection info | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeTopicSubscribeGroup | DescribeTopicSubscribeGroup | Operation level | * | Supported |
| DescribeTopicSyncReplica | Get partition replica and offset info | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeTypeInstances | Describe Type Instances | Operation level | * | Supported |
| DescribeUser | DescribeUser | Operation level | * | Supported |
| DescribeUserElasticTopicPermit | describe user elastic topic permission | Operation level | * | Supported |
| DescribeUserInstances | Describe User Instances | Operation level | * | Supported |
| FetchDatahubMessageByOffset | Fetch Datahub Message By Offset | Operation level | * | Supported |
| FetchLatestMessageList | Fetch Latest Message List | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| FetchMessageByOffset | fetch message by specfic offset | Operation level | * | Supported |
| FetchMessageListByOffset | fetch message by specific partition offset | Operation level | * | Supported |
| FetchMessageListByTimestamp | Fetch message by timestamp given | Operation level | * | Supported |
| GetInstanceAttributes | GetInstanceAttributes | Operation level | * | not supported |
| GetTopicAttributes | GetTopicAttributes | Operation level | * | not supported |
| InquireCkafkaPrice | Inquire ckafka instance price | Operation level | * | Supported |
Other Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| CheckCreateDatahubTask | Check Create Datahub Task | Operation level | * | Supported |
| CheckDelete | Check Delete | Operation level | * | Supported |
List Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| DescribeConnectResources | describe dip connect resource list | Resource level | qcs::ckafka:${region}:uin/${uin}:connectResource/${resourceId} | Supported |
| DescribeConsumerGroup | DescribeConsumerGroup | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| DescribeDatahubTasks | describe dip task list | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTask/${taskId} | Supported |
| DescribeDatahubTopics | describe dip topic list | Resource level | qcs::ckafka:${region}:uin/${uin}:connectTopic/${topicId} | Supported |
| DescribeInstance | DescribeInstance | Operation level | * | Supported |
| DescribeInstanceDetail | DescribeInstanceDetail | Operation level | * | Supported |
| DescribeInstances | DescribeInstances | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${InstanceId} | not supported |
| DescribeInstancesDetail | DescribeInstancesDetail | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${InstanceId} | Supported |
| DescribeThrottleRules | query instance throttle rule list | Resource level | qcs::ckafka:${region}:uin/${uin}:ckafkaId/${InstanceId} | Supported |
| DescribeTopic | DescribeTopic | Resource level | qcs::ckafka::uin/${uin}:ckafkaId/${instanceId} | Supported |
| ListConsumerGroup | ListConsumerGroup | Operation level | * | not supported |
| ListInstance | ListInstance | Operation level | * | not supported |
| ListRoute | ListRoute | Operation level | * | not supported |
| ListTopic | ListTopic | Operation level | * | not supported |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback