Cloud Log Service
Last updated: 2025-12-04 09:08:47
Fundamental information
| Product | Abbreviation in CAM | Console | Authorization by Tag | Authorization Granularity | IP Restriction |
|---|---|---|---|---|---|
| Cloud Log Service | cls | 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 |
|---|---|---|---|---|
| AddMachineGroupInfo | Add MachineGroup Info | Resource level | qcs::cls:${region}:uin/${uin}:machinegroup/${GroupId} | Supported |
| ApplyConfigToMachineGroup | ApplyConfigToMachineGroup | Resource level | qcs::cls:$region:$account:machinegroup/$machinegroupId | Supported |
| ApplyConfigurationTemplate | apply configuration template | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} qcs::cls:${region}:uin/${uin}:logset/${LogsetId} |
Supported |
| CancelRebuildIndexTask | CancelRebuildIndexTask | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CloseKafkaConsume | Close Kafka Consume | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | Supported |
| CloseKafkaConsumer | Close Kafka Consume | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | Supported |
| CommitConsumerOffsets | commit consumer group offset | Resource level | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | Supported |
| CreateAlarm | create alarm | Operation level | * | Supported |
| CreateAlarmNotice | create alarm notice | Operation level | * | Supported |
| CreateAlarmShield | Create Alarm Shield | Resource level | qcs::cls:${region}:uin/${uin}:alarmNotice/${AlarmNoticeId} | Supported |
| CreateAlarmsFromTemplate | Create Alarms From Template | Operation level | * | Supported |
| CreateArchiveStorageRetrieve | Create an archive storage data retrieval task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | not supported |
| CreateBinlogSubscribe | Create Binlog Subscribe | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateChart | create chart | Resource level | qcs::cls:$region:$account:dashboard/$dashboardId | not supported |
| CreateCloudProductLogCollection | create cloud product log collection | Resource level | qcs::cls:${region}:uin/${uin}:topic/${topicId} qcs::cls:${region}:uin/${uin}:logset/${logsetId} qcs::cdb:${region}:uin/${uin}:instanceId/${instanceId} qcs::mongodb:${region}:uin/${uin}:instance/${instanceId} qcs::tdmysql:${region}:uin/${uin}:instance/${instanceId} qcs::dcdb:${region}:uin/${uin}:instance/${InstanceId} qcs::mariadb:${region}:uin/${uin}:instance/${InstanceId} qcs::postgres:${region}:uin/${uin}:DBInstanceId/${InstanceId} |
Supported |
| CreateCloudProductLogTask | CreateCloudProductLogTask | Operation level | * | Supported |
| CreateConfig | CreateConfig | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${Output} | Supported |
| CreateConfigExtra | CreateConfigExtra | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateConfigurationTemplate | Create Configuration Template | Operation level | * | Supported |
| CreateConsole | Create datasight instance | Operation level | * | Supported |
| CreateConsoleSharing | Create cls console sharing | Operation level | * | Supported |
| CreateConsumer | Create Consumer | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateConsumerGroup | create consumer group | Resource level | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | Supported |
| CreateCosRecharge | Create CosRecharge | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateDashboard | create dashboard | Operation level | * | not supported |
| CreateDashboardSubscribe | CreateDashboardSubscribe | Resource level | qcs::cls::uin/${uin}:dashboard/${DashboardId} | Supported |
| CreateDataTransform | CreateDataTransform | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | Supported |
| CreateDeliverCloudFunction | create deliver cloud function | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateDeliverFunction | create deliver function | Operation level | * | not supported |
| CreateDemonstrations | This API is used to create demonstrations. | Operation level | * | Supported |
| CreateDlcDeliver | create dlc deliver task | Resource level | qcs::cls:${Region}:uin/:topic/${TopicId} | Supported |
| CreateEsRecharge | create es recharge task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateExport | create export | Resource level | qcs::cls::uin/${uin}:topic/${TopicId} | Supported |
| CreateExternalDataSource | create external datasource | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateFolder | create folder | Operation level | * | Supported |
| CreateHostMetricConfig | create host metric config | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateIndex | Create Index | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| CreateKafkaRecharge | Create Kafka Recharge | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | Supported |
| CreateLLMPerfProfileTask | create large language model perf profile task | Resource level | qcs::${ApiModule}:${Region}:uin/:cluster/${ClusterId} | not supported |
| CreateLogset | Create Logset | Operation level | * | Supported |
| CreateMachineGroup | Create MachineGroup | Operation level | * | Supported |
| CreateMetricConfig | create metric config | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateMetricSubscribe | Create Metric Subscribe | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateNetworkApplication | create network application | Operation level | * | not supported |
| CreateNoticeContent | create notice content | Operation level | * | Supported |
| CreateRebuildIndexTask | CreateRebuildIndexTask | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateRecordingRuleTask | create recording rule task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateRecordingRuleYamlTask | Create Recording Rule Yaml Task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateRemoteWriteTask | create remote write task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateRollbackTask | CreateRollbackTask | Operation level | * | not supported |
| CreateScheduledSql | CreateScheduledSql | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | Supported |
| CreateShipper | create shipper | Resource level | qcs::cls:${Region}:uin/:topic/${TopicId} | Supported |
| CreateSplunkDeliver | create splunk deliver task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| CreateTopic | Create Topic | Operation level | * | Supported |
| CreateTopicExtendConfig | create config for clb | Operation level | * | Supported |
| CreateWebCallback | Create WebCallback | Operation level | * | Supported |
| DeleteAlarm | delete alarm | Resource level | qcs::cls:$region:$account:alarm/$alarmId | Supported |
| DeleteAlarmNotice | delete alarm notice | Resource level | qcs::cls:$region:$account:alarmNotice/$alarmNoticeId | Supported |
| DeleteAlarmShield | Delete Alarm Shield | Resource level | qcs::cls:${region}:uin/${uin}:alarmNotice/${AlarmNoticeId} | Supported |
| DeleteArchiveStorageRetrieve | Delete an archive storage data retrieval task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | not supported |
| DeleteBinlogSubscribe | Delete Binlog Subscribe | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteChart | delete chart | Resource level | qcs::cls:$region:$account:chart/$chartId | not supported |
| DeleteCloudProductLogCollection | delete cloud product log collection | Resource level | qcs::cdb:${region}:uin/${uin}:instanceId/${InstanceId} qcs::mongodb:${region}:uin/${uin}:instance/${InstanceId} qcs::tdmysql:${region}:uin/${uin}:instance/${InstanceId} qcs::dcdb:${region}:uin/${uin}:instance/${InstanceId} qcs::mariadb:${region}:uin/${uin}:instance/${InstanceId} qcs::postgres:${region}:uin/${uin}:DBInstanceId/${InstanceId} |
Supported |
| DeleteCloudProductLogTask | DeleteCloudProductLogTask | Operation level | * | Supported |
| DeleteConfig | DeleteConfig | Resource level | qcs::cls:$region:$account:config/$configId qcs::cls:$region:$account:topic/${topicId} |
Supported |
| DeleteConfigExtra | DeleteConfigExtra | Resource level | qcs::cls:${region}:uin/${uin}:config/${ConfigExtraId} | Supported |
| DeleteConfigFromMachineGroup | DeleteConfigFromMachineGroup | Resource level | qcs::cls:$region:$account:machinegroup/$machinegroupId | Supported |
| DeleteConfigurationTemplate | Delete Configuration Template | Operation level | * | Supported |
| DeleteConsole | Delete DataSight instance | Resource level | qcs::cls::uin/${uin}:datasight/${datasightId} | Supported |
| DeleteConsoleSharing | delete cls console sharing | Operation level | * | Supported |
| DeleteConsumer | Delete Consumer | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteConsumerGroup | delete consumer group | Resource level | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | Supported |
| DeleteCosRecharge | delete cos recharge task | Resource level | qcs::cls:${Region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteDashboard | delete dashboard | Resource level | qcs::cls::uin/${uin}:dashboard/${dashboardId} | Supported |
| DeleteDashboardSubscribe | DeleteDashboardSubscribe | Operation level | * | Supported |
| DeleteDataTransform | DeleteDataTransform | Resource level | qcs::${ApiModule}:${Region}:uin/:datatransform/${TaskId} | Supported |
| DeleteDeliverCloudFunction | delete deliver cloud function | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteDeliverFunction | delete deliver function | Operation level | * | not supported |
| DeleteDlcDeliver | delete dlc deliver task | Resource level | qcs::cls:${Region}:uin/:topic/${TopicId} | Supported |
| DeleteEsRecharge | delete es recharge config | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteExport | delete export | Resource level | qcs::cls:${Region}:uin/:topic/${TopicId} | Supported |
| DeleteExternalDataSource | delete external datasource | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteFolder | delete folder | Operation level | * | Supported |
| DeleteHostMetricConfig | delete host metric config | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteIndex | Delete Index | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| DeleteKafkaRecharge | Delete Kafka Recharge | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteLLMPerfProfileTask | delete large language model perf profile task | Resource level | qcs::${ApiModule}:${Region}:uin/:cluster/${ClusterId} | not supported |
| DeleteLogset | Delete Logset | Resource level | qcs::cls:$region:$account:logset/$logsetId | Supported |
| DeleteMachineGroup | Delete MachineGroup | Resource level | qcs::cls:${region}:uin/${uin}:machinegroup/${GroupId} | Supported |
| DeleteMachineGroupInfo | Delete MachineGroup Info | Resource level | qcs::cls:${region}:uin/${uin}:machinegroup/${GroupId} | Supported |
| DeleteMetricConfig | delete metric config | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteMetricSubscribe | Delete Metric Subscribe | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteNetworkApplication | delete network application | Operation level | * | not supported |
| DeleteNoticeContent | delete notice content | Operation level | * | Supported |
| DeleteRecordingRuleTask | Delete Recording Rule Task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteRecordingRuleYamlTask | delete yaml recording rule task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteRemoteWriteTask | delete remote write task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteScheduledSql | DeleteScheduledSql | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | Supported |
| DeleteShipper | delete shipper | Resource level | qcs::cls:${region}:uin/${uin}:shipper/${ShipperId} qcs::cls:${region}:uin/${uin}:topic/${TopicId} |
Supported |
| DeleteSplunkDeliver | delete splunk deliver task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DeleteTopicExtendConfig | delete config for clb | Operation level | * | Supported |
| DeleteTrigger | delete trigger | Operation level | * | not supported |
| DeleteWebCallback | Delete WebCallback | Operation level | * | Supported |
| EstimateRebuildIndexTask | EstimateRebuildIndexTask | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| HeartBeat | Heart Beat | Operation level | * | Supported |
| MergePartition | Merge Partition | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| MetricsRemoteWrite | cls services metrics remote write interface | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicid | not supported |
| ModifyAlarm | modify alarm | Resource level | qcs::cls:$region:$account:alarm/$alarmId | Supported |
| ModifyAlarmNotice | modify alarm notice | Resource level | qcs::cls:$region:$account:alarmNotice/$alarmNoticeId | Supported |
| ModifyAlarmShield | Modify Alarm Shield | Resource level | qcs::cls:${region}:uin/${uin}:alarmNotice/${AlarmNoticeId} | Supported |
| ModifyArchiveStorageRetrieve | Modify an archive storage data retrieval task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | not supported |
| ModifyBinlogSubscribe | Modify Binlog Subscribe | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyChart | modify chart | Resource level | qcs::cls:$region:$account:chart/$chartId | not supported |
| ModifyCloudProductLogCollection | modify cloud product log collection | Resource level | qcs::cdb:${region}:uin/${uin}:instanceId/${InstanceId} qcs::mongodb:${region}:uin/${uin}:instance/${InstanceId} qcs::tdmysql:${region}:uin/${uin}:instance/${InstanceId} qcs::dcdb:${region}:uin/${uin}:instance/${InstanceId} qcs::mariadb:${region}:uin/${uin}:instance/${InstanceId} qcs::postgres:${region}:uin/${uin}:DBInstanceId/${InstanceId} |
not supported |
| ModifyCloudProductLogTask | ModifyCloudProductLogTask | Operation level | * | Supported |
| ModifyConfig | ModifyConfig | Resource level | qcs::cls:${region}:uin/${uin}:config/${ConfigId} qcs::cls:${region}:uin/${uin}:topic/${Output} |
Supported |
| ModifyConfigExtra | ModifyConfigExtra | Resource level | qcs::cls:${region}:uin/${uin}:config/${ConfigExtraId} | Supported |
| ModifyConfigurationTemplate | Modify Configuration Template | Operation level | * | Supported |
| ModifyConsole | Modify DataSight instance | Resource level | qcs::cls::uin/${uin}:datasight/${datasightId} | Supported |
| ModifyConsoleSharing | delete cls console sharing | Operation level | * | Supported |
| ModifyConsumer | Modify Consumer | Resource level | qcs::cls:${Region}:uin/:topic/${TopicId} | Supported |
| ModifyConsumerGroup | modify consumer group | Resource level | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | Supported |
| ModifyCosRecharge | Modify CosRecharge | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyDashboard | modify dashboard | Resource level | qcs::cls::uin/${uin}:dashboard/${dashboardId} | not supported |
| ModifyDashboardSubscribe | ModifyDashboardSubscribe | Resource level | qcs::cls::uin/${uin}:dashboard/${DashboardId} | Supported |
| ModifyDashboardSubscribeAck | ModifyDashboardSubscribeAck | Operation level | * | Supported |
| ModifyDataTransform | ModifyDataTransform | Resource level | qcs::${ApiModule}:${Region}:uin/:datatransform/${TaskId} | Supported |
| ModifyDeliverCloudFunction | modify deliver cloud function | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyDeliverFunction | modify deliver function | Operation level | * | not supported |
| ModifyDlcDeliver | modify dlc deliver task | Resource level | qcs::cls:${Region}:uin/:topic/${TopicId} | Supported |
| ModifyEsRecharge | modify es recharge task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyExternalDataSource | modify external datasource | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyFolder | modify folder | Operation level | * | Supported |
| ModifyHostMetricConfig | modify host metric config | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyIdleResourcePolicy | modify Idle resource policy | Operation level | * | Supported |
| ModifyIndex | Modify Index | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| ModifyKafkaConsumer | Modify Kafka Consumer Info | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | Supported |
| ModifyKafkaRecharge | Modify Kafka Recharge | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | Supported |
| ModifyLLMPerfProfileTask | modify large language model perf profile task | Resource level | qcs::${ApiModule}:${Region}:uin/:cluster/${ClusterId} | Supported |
| ModifyLogset | Modify Logset | Resource level | qcs::cls:$region:$account:logset/$logsetId | Supported |
| ModifyMachineGroup | Modify MachineGroup | Resource level | qcs::cls:$region:$account:machinegroup/${GroupId} | Supported |
| ModifyMetricConfig | modify metric config | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyMetricSubscribe | Modify Metric Subscribe | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyNetworkApplication | modify network application | Operation level | * | not supported |
| ModifyNoticeContent | modify notice content | Operation level | * | Supported |
| ModifyRecordingRuleTask | modify recording rule task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyRecordingRuleYamlTask | modify yaml recording rule task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyRemoteWriteTask | modify remote write task info | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| ModifyResourceAndFolderRelation | modify resource and folder relation | Operation level | * | Supported |
| ModifyScheduledSql | ModifyScheduledSql | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | Supported |
| ModifyServerMetricService | Modified from the metric topic monitoring service | Operation level | * | not supported |
| ModifyShipper | modify shipper | Resource level | qcs::cls:${region}:uin/${uin}:shipper/${ShipperId} qcs::cls:${region}:uin/${uin}:topic/${TopicId} |
Supported |
| ModifyTopicExtendConfig | modify config for clb | Operation level | * | Supported |
| ModifyWebCallback | Modify WebCallback | Operation level | * | Supported |
| OpenKafkaConsume | Open Kafka Consume | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | Supported |
| OpenKafkaConsumer | Open Kafka Consume | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | Supported |
| PreviewKafkaRecharge | Preview Kafka Recharge | Operation level | * | Supported |
| RealtimeProducer | real-time producer log | Resource level | qcs::cls::uin/${uin}:logset/${logsetId} | not supported |
| RemoveMachine | remove machine | Resource level | qcs::cls:${Region}:uin/:machinegroup/${GroupId} | Supported |
| RetryScheduledSqlTask | RetryScheduledSqlTask | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | Supported |
| RetryShipperTask | retry shipper task | Resource level | qcs::cls:${region}:uin/${uin}:shipper/${ShipperId} | Supported |
| SearchDashboardSubscribe | SearchDashboardSubscribe | Resource level | qcs::cls::uin/${uin}:dashboard/${DashboardId} | Supported |
| SendConsumerHeartbeat | send consumer heartbeat | Resource level | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | Supported |
| SplitPartition | Split Partition | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| UnbindDeliverCloudFunction | Unbind deliver cloud function | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| UpdateAgentStatus | update agent status | Operation level | * | Supported |
| UpgradeAgentNormal | upgrade agent normal | Operation level | * | Supported |
| UploadLog | Upload Log | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicId | Supported |
| agentHeartBeat | put loglistener (CLS agent) heartbeat to server | Operation level | * | not supported |
| consumerGroupHeartBeat | put heartbeat to consumer group | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| createConsumer | create consumer | Operation level | * | Supported |
| createConsumerGroup | create consumer group | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| createLogset | create logset | Operation level | * | Supported |
| createMachineGroup | create machine group | Operation level | * | Supported |
| createShipper | create shipper | Operation level | * | Supported |
| createTopic | create topic | Resource level | qcs::cls:$region:$account:logset/$logsetId | Supported |
| deleteConsumerGroup | delete consumer group | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| deleteLogset | delete logset | Resource level | qcs::cls:$region:$account:logset/$logsetId | Supported |
| deleteMachineGroup | delete machine group | Resource level | qcs::cls:$region:$account:machinegroup/$machinegroupId | Supported |
| deleteShipper | delete shipper | Resource level | qcs::cls:$region:$account:shipper/$shipperId | Supported |
| downloadLog | download logs | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| modifyConsumer | modify consumer | Operation level | * | Supported |
| modifyConsumerGroup | modify consumer group | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| modifyConsumerGroupCursor | modify cursor of consumer group | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| modifyIndex | modify index | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| modifyLogset | modify logset | Resource level | qcs::cls:$region:$account:logset/$logsetId | Supported |
| modifyMachineGroup | modify machine group | Resource level | qcs::cls:$region:$account:machinegroup/$machinegroupId | Supported |
| modifyShipper | modify shipper | Resource level | qcs::cls:$region:$account:shipper/$shipperId | Supported |
| modifyShipperTask | try failed shipper task again | Resource level | qcs::cls:$region:$account:shipper/$shipperId | not supported |
| pullLog | pull log | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | not supported |
| pushLog | push logs | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| updatePartition | split or merge partition | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
Read operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| ChatCompletions | ChatCompletions | Operation level | * | Supported |
| CheckAlarmChannel | CheckAlarmChannel | Operation level | * | Supported |
| CheckAlarmRule | CheckAlarmRule | Operation level | * | Supported |
| CheckDomainRepeat | check domain is repeat | Operation level | * | Supported |
| CheckEsRechargeConnect | check es recharge connect | Operation level | * | Supported |
| CheckFunction | CheckFunction | Operation level | * | Supported |
| CheckRechargeKafkaServer | Check Recharge Kafka Server | Operation level | * | Supported |
| CheckSplunkConnect | check splunk connect | Operation level | * | Supported |
| DescribeArchiveStorageRetrieve | Search an archive storage data retrieval task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | not supported |
| DescribeBinlogSubscribeConnectivity | Describe Binlog Subscribe Connectivity | Operation level | * | Supported |
| DescribeBinlogSubscribePreview | Describe Binlog Subscribe Preview | Operation level | * | Supported |
| DescribeCloudProductResources | Describe Cloud Product Resources | Operation level | * | Supported |
| DescribeConfigMachineGroups | DescribeConfigMachineGroups | Resource level | qcs::cls:$region:$account:config/$configId | Supported |
| DescribeConfigs | describe configs | Resource level | qcs::cls:$region:$account:config/$configId | not supported |
| DescribeConsole | describe console | Operation level | * | Supported |
| DescribeConsoles | List DataSight instances | Resource level | qcs::cls::uin/${uin}:datasight/${datasightId} | Supported |
| DescribeConsumer | Describe Consumer | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeConsumerPreview | describe kafka preview info | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | Supported |
| DescribeCosRecharges | Describe CosRecharges | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeDashboardSubscribes | Describe Dashboard Subscribes | Resource level | qcs::cls::uin/${uin}:dashboard/${dashboardId} | Supported |
| DescribeDashboards | DescribeDashboards | Resource level | qcs::cls::uin/${uin}:dashboard/${dashboardId} | Supported |
| DescribeDataTransformFailLogInfo | DescribeDataTransformFailLogInfo | Resource level | qcs::cls:${region}:uin/${uin}:datatransform/${TaskId} | Supported |
| DescribeDataTransformInfo | DescribeDataTransformInfo | Resource level | qcs::cls:${region}:uin/${uin}:datatransform/$TaskId | Supported |
| DescribeDataTransformPreviewDataInfo | DescribeDataTransformPreviewDataInfo | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicId qcs::cls:${region}:uin/${uin}:datatransform/$datatransformId |
Supported |
| DescribeDataTransformPreviewInfo | DescribeDataTransformPreviewInfo | Resource level | qcs::${ApiModule}:${Region}:uin/:datatransform/${TaskId} | Supported |
| DescribeDataTransformProcessInfo | DescribeDataTransformProcessInfo | Resource level | qcs::${ApiModule}:${Region}:uin/:datatransform/${TaskId} | Supported |
| DescribeDedicatedClusterData | DescirbeDedicatedClusterData | Operation level | * | Supported |
| DescribeDemonstrations | This API is used to get list of demonstrations. | Operation level | * | Supported |
| DescribeEsRechargePreview | es recharge preview | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeExceptionResources | describe abnormal resource list | Operation level | * | Supported |
| DescribeExternalDataSourcePreview | describe external datasource preview | Operation level | * | Supported |
| DescribeFunctions | DescribeFunctions | Operation level | * | Supported |
| DescribeIdleResourcePolicy | describe Idle resource policy | Operation level | * | Supported |
| DescribeIndex | Describe Index | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| DescribeIndexs | Describe Indexs | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicid | Supported |
| DescribeKafkaConsume | Describe Kafka Consume | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | Supported |
| DescribeKafkaConsumer | Describe Kafka Consumer Info | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | Supported |
| DescribeKafkaConsumerPreview | Describe kafka consumer preview info | Resource level | qcs::cls:${region}:uin/${uin}:topic/${FromTopicId} | Supported |
| DescribeLLMPerfProfileDetail | describe large language model perf profile task detail | Resource level | qcs::${ApiModule}:${Region}:uin/:cluster/${ClusterId} | Supported |
| DescribeLatestJsonLog | Describe Latest Json Log | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicId | Supported |
| DescribeLatestUserLog | Describe Latest User Log | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeLogContext | DescribeLogContext | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| DescribeLogFastAnalysis | DescribeLogFastAnalysis | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| DescribeLogHistogram | DescribeLogHistogram | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| DescribeMachineGroupConfigs | DescribeMachineGroupConfigs | Resource level | qcs::cls:${region}:uin/${uin}:machinegroup/${GroupId} | Supported |
| DescribeMachines | Describe Machines | Resource level | qcs::cls:$region:$account:machinegroup/$groupid | Supported |
| DescribeMetricCorrectDimension | Describe Metric Correct Dimension | Operation level | * | Supported |
| DescribeMetricSubscribePreview | Describe Metric Subscribe Preview | Operation level | * | Supported |
| DescribeNetworkApplicationDetail | describe network application detail | Operation level | * | not supported |
| DescribePartitions | Describe Partitions | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| DescribeRecordingRuleProcessInfo | describe recording rule process info | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeRemoteWriteTask | describe remote write task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeResources | Describe Resources | Operation level | * | Supported |
| DescribeScheduledSqlInfo | DescribeScheduledSqlInfo | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicid | Supported |
| DescribeScheduledSqlProcessInfo | DescribeScheduledSqlProcessInfo | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | Supported |
| DescribeServiceMonitor | describe service monitor | Operation level | * | Supported |
| DescribeShipperPreview | describe shipper preview info | Resource level | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | Supported |
| DescribeShipperTasks | describe shipper task | Resource level | qcs::cls:${region}:uin/${uin}:shipper/${ShipperId} qcs::cls:${region}:uin/${uin}:topic/${TopicId} |
Supported |
| DescribeShippers | describe shippers | Resource level | qcs::cls:${region}:uin/${uin}:shipper/${shipperId} qcs::cls:${region}:uin/${uin}:topic/${topicId} |
Supported |
| DescribeSplunkDelivers | describe splunk deliver tasks | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeSplunkPreview | Splunk deliver preview | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeTopics | Describe Topics | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicId | Supported |
| GetAlarmLog | get alarm log | Resource level | qcs::cls:${region}:uin/${uin}:alarm/$alarmId | Supported |
| GetChart | get chart | Resource level | qcs::cls:$region:$account:chart/$chartId | not supported |
| GetConfigurationTemplateApplyLog | Get Configuration Template Apply Log | Operation level | * | Supported |
| GetDashboard | get dashboard | Resource level | qcs::cls::uin/${uin}:dashboard/$dashboardId | not supported |
| GetDeliverFunction | get deliver function | Operation level | * | not supported |
| GetLog | download log | Operation level | * | not supported |
| GetMetricLabelValues | get metric label values | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| GetMetricSeries | get metric name | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| GetTopicDetail | get topic info | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| MetricsLabelValues | metrics label values | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicid | not supported |
| MetricsLabels | metrics labels query | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicid | not supported |
| MetricsQuery | metrics query | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicid | not supported |
| MetricsQueryExemplars | Metrics query exemplars | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicid | not supported |
| MetricsQueryRange | Metrics Query Range | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicid | not supported |
| MetricsRemoteRead | prometheus remote read interface | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | not supported |
| MetricsSeries | metrics series query | Resource level | qcs::cls:${region}:uin/${uin}:topic/$topicid | not supported |
| QueryMetric | query metric | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| QueryRangeMetric | query range metric | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| SearchCosRechargeInfo | Search CosRechargeInfo | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| SearchLog | search log | Resource level | qcs::cls:${Region}:uin/${uin}:topic/${TopicId} | Supported |
| getConfig | get config of loglistener | Operation level | * | not supported |
| getConsumer | get consumer | Operation level | * | not supported |
| getConsumerGroupCursor | get cursor of consumer group | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| getCursor | get cursor to download logs | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| getIndex | get index | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| getMachineGroup | get machine group | Resource level | qcs::cls:$region:$account:machinegroup/$machinegroupId | not supported |
| getMachineStatus | get machine status | Resource level | qcs::cls:$region:$account:machinegroup/$machinegroupId | not supported |
| getShipper | get shipper | Resource level | qcs::cls:$region:$account:shipper/$shipperId | not supported |
| getTopic | get topic | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| pullLogs | pull logs | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
Other Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| CheckJoinSourceConnect | check join source connect | Operation level | * | Supported |
| CheckRemoteWriteTaskConnect | check remote write task connect | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
List Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| DescribeAgentConfigs | Describe Agent Configs | Operation level | * | Supported |
| DescribeAgentMachineGroupMetadata | DescribeAgentMachineGroupMetadata | Operation level | * | Supported |
| DescribeAlarmNotices | describe alarm notices | Resource level | qcs::cls:$region:$account:alarmNotice/$alarmNoticeId | Supported |
| DescribeAlarmShields | Describe Alarm Shields | Resource level | qcs::cls:${region}:uin/${uin}:alarmNotice/${AlarmNoticeId} | Supported |
| DescribeAlarmTemplates | describe alarm template list | Operation level | * | Supported |
| DescribeAlarms | Descibe Alarms | Resource level | qcs::cls:$region:$account:alarm/$alarmId | Supported |
| DescribeAlertRecordHistory | DescribeAlertRecordHistory | Resource level | qcs::cls:${region}:uin/${uin}:alarm/$alarmId | Supported |
| DescribeBinlogSubscribes | Describe Binlog Subscribes | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeCloudProductLogTasks | DescribeCloudProductLogTasks | Operation level | * | Supported |
| DescribeClusterBaseMetricConfigs | describe cluster base metric config | Resource level | qcs::cls:${region}:uin/${uin}:machinegroup/${GroupId} | Supported |
| DescribeClusterMetricConfigs | describe metric config | Resource level | qcs::cls:${region}:uin/${uin}:machinegroup/${GroupId} | Supported |
| DescribeConfigurationTemplates | Describe Configuration Templates | Operation level | * | Supported |
| DescribeConsoleSharingList | batch describe cls console sharing list | Operation level | * | Supported |
| DescribeConsumerGroups | describe consumer group info | Resource level | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | Supported |
| DescribeConsumerOffsets | describe consumer offset info | Resource level | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | Supported |
| DescribeConsumers | deacribe consumer list | Resource level | qcs::cls:${region}:uin/${uin}:topic/${topicId} | Supported |
| DescribeDataTransformAutoCreateLogSets | Describe DataTransform Auto Create LogSets | Operation level | * | Supported |
| DescribeDataTransformAutoCreateTopics | Describe DataTransform AutoCreate Topics | Operation level | * | Supported |
| DescribeDlcDelivers | describe dlc deliver tasks | Resource level | qcs::cls:${Region}:uin/:topic/${TopicId} | Supported |
| DescribeEsRecharges | describe es recharge infos | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeExports | Describe Exports | Resource level | qcs::cls:$region:$account:topic/$topicId | Supported |
| DescribeExternalDataSources | describe external datasources | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeFolders | get folder list | Operation level | * | Supported |
| DescribeHostMetricConfigs | describe host metric configs | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeKafkaConsumerTopics | Describe Kafka Consumer Topics | Resource level | qcs::cls:${region}:uin/${uin}:topic/${FromTopicId} | Supported |
| DescribeKafkaRecharges | Describe Kafka Recharges | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeLLMPerfProfileTasks | describe large language model perf profile task | Resource level | qcs::${ApiModule}:${Region}:uin/:cluster/${ClusterId} | not supported |
| DescribeLogsets | describe logsets | Resource level | qcs::cls:$region:$account:logset/$logsetid | Supported |
| DescribeMachineGroups | Describe MachineGroups | Resource level | qcs::cls:${region}:uin/${uin}:machinegroup/$GroupId | Supported |
| DescribeMetricSubscribes | Describe Metric Subscribes | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeNetworkApplications | describe network application list | Operation level | * | not supported |
| DescribeNoticeContents | describe notice contents | Operation level | * | Supported |
| DescribeRebuildIndexTasks | DescribeRebuildIndexTasks | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeRecordingRuleTask | describe recording rule task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeRecordingRuleYamlTask | describe yaml recording rule task | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeRemoteWriteTasks | describe remote write task list | Resource level | qcs::cls:${region}:uin/${uin}:topic/${topicId} | Supported |
| DescribeResourcePackageDeductDetail | DescribeResourcePackageDeductDetail | Operation level | * | Supported |
| DescribeTopicBaseMetricConfigs | describe base metric config info | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeTopicExtendConfig | describe config for clb | Operation level | * | Supported |
| DescribeTopicMetricConfigs | describe metric config | Resource level | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | Supported |
| DescribeWebCallbacks | Describe WebCallbacks | Operation level | * | Supported |
| GetArchive | GetArchive | Operation level | * | not supported |
| ListChart | list chart | Resource level | qcs::cls:$region:$account:dashboard/$dashboardId | not supported |
| ListDashboard | list dashboard | Operation level | * | not supported |
| listConsumerGroup | list consumer group | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| listLogset | list logset | Operation level | * | not supported |
| listMachineGroup | list machine group | Operation level | * | not supported |
| listPartitions | list pratitions of topic | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| listShipper | list shipper | Resource level | qcs::cls:$region:$account:topic/$topicId | not supported |
| listShipperTask | list shipper tasks | Resource level | qcs::cls:$region:$account:shipper/$shipperId | not supported |
| listTopic | list topics | Resource level | qcs::cls:$region:$account:logset/$logsetId | not supported |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback