基本信息
| CAM中产品名 | CAM中简称 | 控制台访问 | 按标签授权 | 授权粒度 | IP限制 |
|---|---|---|---|---|---|
| 日志服务 | cls | 支持 | 支持 | 资源级 | 部分支持 |
说明：云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。
- 服务级：定义对服务的整体是否拥有访问权限，分为允许对服务拥有全部操作权限或者拒绝对服务拥有全部操作权限。服务级授权粒度的云产品，不支持对具体的接口进行授权。
- 操作级：定义对服务的特定接口（API）是否拥有访问权限，例如：授权某账号对云服务器服务进行只读操作。
- 资源级：定义对特定资源是否有访问权限，这是最细的授权粒度，例如：授权某账号仅读写操作某台云服务器实例。能支持资源级接口授权的产品，则会被认定为资源级授权粒度。
接口授权粒度
接口授权粒度分为资源级和操作级两个级别：
- 资源级接口：此类型接口支持对某一个具体特定的资源进行授权。
- 操作级接口：此类型接口不支持对某一个特定的资源进行授权。授权时策略语法若限定了具体的资源，CAM会判断此接口不在授权范围，判断为无权限。
写操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| AddMachineGroupInfo | 用于添加机器组信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:machinegroup/${GroupId} | 支持 |
| ApplyConfigToMachineGroup | 应用采集配置到机器组 | 资源级 | qcs::cls:$region:$account:machinegroup/$machinegroupId | 支持 |
| ApplyConfigurationTemplate | 应用配置模板 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} qcs::cls:${region}:uin/${uin}:logset/${LogsetId} |
支持 |
| CancelRebuildIndexTask | 取消重建索引任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | 支持 |
| CloseKafkaConsume | 关闭Kafka消费 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | 支持 |
| CloseKafkaConsumer | 关闭Kafka协议消费 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | 支持 |
| CommitConsumerOffsets | 提交消费组点位信息 | 资源级 | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | 不支持 |
| CreateAlarm | 创建告警 | 操作级 | * | 不支持 |
| CreateAlarmNotice | 创建告警通知模板 | 操作级 | * | 不支持 |
| CreateAlarmShield | 创建告警屏蔽 | 资源级 | qcs::cls:${region}:uin/${uin}:alarmNotice/${AlarmNoticeId} | 支持 |
| CreateAsyncContextTask | 创建异步上下文任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${topicId} | 支持 |
| CreateAsyncSearchTask | 创建异步检索任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${topicId} | 支持 |
| CreateBinlogSubscribe | 创建binlog采集配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| CreateChart | 创建图表 | 资源级 | qcs::cls:$region:$account:dashboard/$dashboardId | 不支持 |
| CreateConfig | 创建采集配置 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| CreateConfigExtra | 本接口用于创建特殊采集配置任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | 支持 |
| CreateConfigurationTemplate | 创建配置模板 | 操作级 | * | 支持 |
| CreateConsole | 创建DataSight控制台实例 | 操作级 | * | 支持 |
| CreateConsoleSharing | 创建控制台分享 | 操作级 | * | 不支持 |
| CreateConsumer | 本接口用于创建投递任务-ckafka | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| CreateConsumerGroup | 创建消费组 | 资源级 | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | 不支持 |
| CreateCosRecharge | 本接口用于创建cos导入任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| CreateDashboard | 创建仪表盘 | 操作级 | * | 不支持 |
| CreateDashboardSubscribe | 创建仪表盘订阅 | 资源级 | qcs::cls::uin/${uin}:dashboard/${DashboardId} | 支持 |
| CreateDataTransform | 本接口用于创建数据加工任务。 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | 支持 |
| CreateDeliverCloudFunction | 创建投递SCF任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| CreateDeliverFunction | 创建投递函数 | 操作级 | * | 不支持 |
| CreateDemonstrations | 本接口用于批量创建演示示例 | 操作级 | * | 支持 |
| CreateExport | 创建日志导出 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| CreateExternalDataSource | 创建外部数据源 | 资源级 | qcs::cls::uin/${uin}:topic/${TopicId} | 支持 |
| CreateFolder | 创建文件夹 | 操作级 | * | 支持 |
| CreateIndex | 创建索引 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| CreateKafkaRecharge | 创建Kafka导入配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| CreateLogset | 创建日志集 | 操作级 | * | 不支持 |
| CreateMachineGroup | 创建机器组 | 操作级 | * | 不支持 |
| CreateMetricSubscribe | 创建指标订阅配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| CreateNonBilling | 本接口用于创建体验账户 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | 支持 |
| CreateNoticeContent | 创建通知内容 | 操作级 | * | 支持 |
| CreateRebuildIndexTask | 创建重建索引任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | 支持 |
| CreateRemoteWriteTask | 创建remote write 任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| CreateScheduledSql | 本接口用于创建ScheduledSql任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | 支持 |
| CreateShipper | 创建投递规则 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| CreateTopic | 创建日志主题 | 操作级 | * | 不支持 |
| CreateTopicExtendConfig | 创建采集配置(clb专用) | 操作级 | * | 支持 |
| CreateWebCallback | 创建告警渠道回调配置 | 操作级 | * | 支持 |
| DeleteAlarm | 删除告警 | 资源级 | qcs::cls:$region:$account:alarm/alarmId | 不支持 |
| DeleteAlarmNotice | 删除告警策略模板 | 资源级 | qcs::cls:$region:$account:alarmNotice/$alarmNoticeId | 不支持 |
| DeleteAlarmShield | 删除告警屏蔽 | 资源级 | qcs::cls:${region}:uin/${uin}:alarmNotice/${AlarmNoticeId} | 支持 |
| DeleteAsyncContextTask | 删除异步上下文任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${topicId} | 支持 |
| DeleteAsyncSearchTask | 删除异步检索任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${topicId} | 支持 |
| DeleteBinlogSubscribe | 删除binlog采集配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DeleteChart | 删除图表 | 资源级 | qcs::cls:$region:$account:chart/$chartId | 不支持 |
| DeleteCloudProductLogTask | 删除云产品日志投递任务 | 操作级 | * | 不支持 |
| DeleteConfig | 删除采集配置 | 资源级 | qcs::cls:$region:$account:config/$configId | 支持 |
| DeleteConfigExtra | 本接口用于删除特殊采集规则配置 | 资源级 | qcs::${ApiModule}:${Region}:uin/:config/${ConfigExtraId} | 支持 |
| DeleteConfigFromMachineGroup | 删除采集配置与机器组的绑定关系 | 资源级 | qcs::cls:$region:$account:machinegroup/$machinegroupId | 支持 |
| DeleteConfigurationTemplate | 删除配置模板 | 操作级 | * | 支持 |
| DeleteConsole | 删除DataSight控制台 | 资源级 | qcs::cls::uin/${uin}:datasight/${datasightId} | 支持 |
| DeleteConsumer | 本接口用于删除投递配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DeleteConsumerGroup | 删除消费组 | 资源级 | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | 不支持 |
| DeleteCosRecharge | 删除cos导入任务 | 资源级 | qcs::cls:${Region}:uin/${uin}:topic/${TopicId} | 不支持 |
| DeleteDashboard | 删除仪表盘 | 资源级 | qcs::cls::uin/${uin}:dashboard/$dashboardId | 支持 |
| DeleteDashboardSubscribe | 删除仪表盘订阅 | 操作级 | * | 支持 |
| DeleteDataTransform | 本接口用于删除数据加工任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:datatransform/${TaskId} | 支持 |
| DeleteDeliverCloudFunction | 删除投递SCF任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DeleteDeliverFunction | 删除投递函数 | 操作级 | * | 不支持 |
| DeleteDemonstrations | 批量删除演示示例 | 资源级 | qcs::${ApiModule}:${Region}:uin/:demonstration/${DemonstrationIds} | 支持 |
| DeleteExport | 删除日志导出 | 操作级 | * | 支持 |
| DeleteExternalDataSource | 删除外部数据源 | 资源级 | qcs::cls::uin/${uin}:topic/${TopicId} | 支持 |
| DeleteFolder | 删除文件夹 | 操作级 | * | 支持 |
| DeleteIndex | 删除索引 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| DeleteKafkaRecharge | 删除Kafka导入配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DeleteLogset | 删除日志集 | 资源级 | qcs::cls:$region:$account:logset/$logsetId | 不支持 |
| DeleteMachineGroup | 删除机器组 | 资源级 | qcs::cls:$region:$account:machinegroup/$groupid | 支持 |
| DeleteMachineGroupInfo | 用于删除机器组信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:machinegroup/${GroupId} | 支持 |
| DeleteMetricSubscribe | 删除指标订阅配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DeleteNoticeContent | 删除通知内容配置 | 操作级 | * | 支持 |
| DeleteScheduledSql | 本接口用于删除ScheduledSql任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | 支持 |
| DeleteShipper | 删除投递规则 | 资源级 | qcs::cls:${region}:uin/${uin}:shipper/${ShipperId} | 支持 |
| DeleteTopic | 删除日志主题 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| DeleteTopicExtendConfig | 删除采集配置(clb专用) | 操作级 | * | 支持 |
| DeleteTrigger | 删除触发器 | 操作级 | * | 不支持 |
| DeleteWebCallback | 删除告警渠道回调配置 | 操作级 | * | 支持 |
| HeartBeat | 上报心跳 | 操作级 | * | 支持 |
| MergePartition | 合并主题分区 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| MetricsRemoteWrite | 日志服务时序指标remote write接口 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 不支持 |
| ModifyAlarm | 修改告警 | 资源级 | qcs::cls:$region:$account:alarm/alarmId | 不支持 |
| ModifyAlarmNotice | 修改告警通知模板 | 资源级 | qcs::cls:$region:$account:alarmNotice/$alarmNoticeId | 不支持 |
| ModifyAlarmShield | 修改告警屏蔽 | 资源级 | qcs::cls:${region}:uin/${uin}:alarmNotice/${AlarmNoticeId} | 支持 |
| ModifyBinlogSubscribe | 修改binlog采集配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| ModifyChart | 修改图表 | 资源级 | qcs::cls:$region:$account:chart/$chartId | 不支持 |
| ModifyCloudProductLogTask | 修改云产品日志投递任务 | 操作级 | * | 不支持 |
| ModifyConfig | 修改采集配置 | 资源级 | qcs::cls:$region:$account:config/$configId | 支持 |
| ModifyConfigExtra | 本接口用于修改特殊采集配置任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:config/${ConfigExtraId} | 支持 |
| ModifyConfigurationTemplate | 修改配置模板 | 操作级 | * | 支持 |
| ModifyConsole | 编辑DataSight控制台实例 | 资源级 | qcs::cls::uin/${uin}:datasight/${datasightId} | 支持 |
| ModifyConsumer | 本接口用于修改投递任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| ModifyConsumerGroup | 修改消费组 | 资源级 | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | 不支持 |
| ModifyCosRecharge | 本接口用于修改cos导入任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| ModifyDashboard | 修改仪表盘 | 资源级 | qcs::cls::uin/${uin}:dashboard/$dashboardId | 不支持 |
| ModifyDashboardSubscribe | 修改仪表盘订阅 | 资源级 | qcs::cls::uin/${uin}:dashboard/${DashboardId} | 支持 |
| ModifyDashboardSubscribeAck | 确认仪表盘订阅发送成功 | 操作级 | * | 支持 |
| ModifyDataTransform | 本接口用于修改数据加工任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:datatransform/${TaskId} | 支持 |
| ModifyDeliverCloudFunction | 修改投递SCF任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| ModifyDeliverFunction | 修改投递函数 | 操作级 | * | 不支持 |
| ModifyExternalDataSource | 修改外部数据源 | 资源级 | qcs::cls::uin/${uin}:topic/${TopicId} | 支持 |
| ModifyFolder | 修改文件夹 | 操作级 | * | 支持 |
| ModifyIdleResourcePolicy | 修改限制资源策略信息 | 操作级 | * | 支持 |
| ModifyIndex | 修改索引 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| ModifyKafkaConsumer | 修改Kafka协议消费信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | 支持 |
| ModifyKafkaRecharge | 修改Kafka导入配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| ModifyLogset | 修改日志集 | 资源级 | qcs::cls:$region:$account:logset/$logsetId | 不支持 |
| ModifyMachineGroup | 修改机器组 | 资源级 | qcs::cls:$region:$account:machinegroup/$groupid | 不支持 |
| ModifyMetricSubscribe | 修改指标订阅配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| ModifyNoticeContent | 修改通知内容配置 | 操作级 | * | 支持 |
| ModifyRemoteWriteTask | 修改remote write 任务信息 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| ModifyResourceAndFolderRelation | 修改资源与文件夹关系 | 操作级 | * | 支持 |
| ModifyScheduledSql | 本接口用于修改ScheduledSql任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | 支持 |
| ModifyShipper | 修改投递规则 | 资源级 | qcs::cls:${region}:uin/${uin}:shipper/${ShipperId} | 支持 |
| ModifyTopic | 修改日志主题 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| ModifyTopicExtendConfig | 修改采集配置(clb专用) | 操作级 | * | 支持 |
| ModifyWebCallback | 修改告警渠道回调配置 | 操作级 | * | 支持 |
| OpenClsService | 开通日志服务 | 操作级 | * | 支持 |
| OpenKafkaConsume | 打开kafka消费功能 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | 支持 |
| OpenKafkaConsumer | 打开kafka协议消费 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | 支持 |
| RealtimeProducer | 实时生产 | 资源级 | qcs::cls::uin/${uin}:logset/${logsetId} | 不支持 |
| RemoveMachine | 剔除标签组异常机器 | 操作级 | * | 支持 |
| RetryScheduledSqlTask | 重试失败的ScheduledSql任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | 支持 |
| RetryShipperTask | 重试失败的投递任务 | 资源级 | qcs::cls:${region}:uin/${uin}:shipper/${ShipperId} | 支持 |
| SendConsumerHeartbeat | 发送心跳信息接口 | 资源级 | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | 不支持 |
| SplitPartition | 分裂主题分区 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| SwitchAlarm | 开启告警 | 资源级 | qcs::cls:$region:$account:alarm/$alarmId | 不支持 |
| UnbindDeliverCloudFunction | 删除投递SCF任务 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| UpdateAgentStatus | Agent升级状态更新 | 操作级 | * | 支持 |
| UpgradeAgentNormal | 启动agent升级任务 | 操作级 | * | 支持 |
| UploadLog | 上传日志 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicId | 支持 |
| agentHeartBeat | agent上报心跳 | 操作级 | * | 不支持 |
| consumerGroupHeartBeat | 消费者心跳 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| createConsumer | 创建消费配置 | 操作级 | * | 支持 |
| createConsumerGroup | 创建消费组 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| createLogset | 创建日志集 | 操作级 | * | 不支持 |
| createMachineGroup | 创建机器组 | 操作级 | * | 不支持 |
| createShipper | 创建投递配置 | 操作级 | * | 支持 |
| createTopic | 创建日志主题 | 资源级 | qcs::cls:$region:$account:logset/$logsetId | 不支持 |
| deleteConsumerGroup | 删除消费组 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| deleteLogset | 删除日志集 | 资源级 | qcs::cls:$region:$account:logset/$logsetId | 不支持 |
| deleteMachineGroup | 删除机器组 | 资源级 | qcs::cls:$region:$account:machinegroup/$machinegroupId | 支持 |
| deleteShipper | 删除投递配置 | 资源级 | qcs::cls:$region:$account:shipper/$shipperId | 支持 |
| deleteTopic | 删除日志主题 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| downloadLog | 下载日志 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| modifyConsumer | 修改消费配置 | 操作级 | * | 支持 |
| modifyConsumerGroup | 修改消费组 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| modifyConsumerGroupCursor | 修改消费组游标 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| modifyIndex | 修改索引配置 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| modifyLogset | 修改日志集 | 资源级 | qcs::cls:$region:$account:logset/$logsetId | 不支持 |
| modifyMachineGroup | 修改机器组 | 资源级 | qcs::cls:$region:$account:machinegroup/$machinegroupId | 不支持 |
| modifyShipper | 修改投递配置 | 资源级 | qcs::cls:$region:$account:shipper/$shipperId | 支持 |
| modifyShipperTask | 重试失败的任务 | 资源级 | qcs::cls:$region:$account:shipper/$shipperId | 不支持 |
| modifyTopic | 修改日志主题 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| pushLog | 上传日志 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| updatePartition | 分裂/合并主题分区 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
读操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| CheckAlarmChannel | 告警渠道检测接口 | 操作级 | * | 支持 |
| CheckAlarmRule | 告警策略检测接口 | 操作级 | * | 支持 |
| CheckDomainRepeat | 检查域名是否重复 | 操作级 | * | 支持 |
| CheckFunction | 本接口用于语法校验接口。 | 操作级 | * | 支持 |
| CheckRechargeKafkaServer | Kafka服务集群连通性校验 | 操作级 | * | 支持 |
| DescribeAsyncContextResult | 获取异步上下文任务结果 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${topicId} | 支持 |
| DescribeAsyncSearchResult | 获取异步检索任务结果 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${topicId} | 支持 |
| DescribeBinlogSubscribeConnectivity | binlog采集配置连通性校验 | 操作级 | * | 支持 |
| DescribeBinlogSubscribePreview | binlog采集预览 | 操作级 | * | 支持 |
| DescribeCloudProductLogTasks | 查看云产品日志投递任务列表 | 操作级 | * | 不支持 |
| DescribeCloudProductResources | 获取云产品资源信息 | 操作级 | * | 支持 |
| DescribeClsPrePayDetails | 本接口用于获取cls预付费资源包使用详情 | 操作级 | * | 支持 |
| DescribeClsPrePayInfos | 本接口用于获取cls预付费资源包信息列表 | 操作级 | * | 支持 |
| DescribeConfigMachineGroups | 获取采集配置所绑定的机器组 | 资源级 | qcs::cls:$region:$account:config/$configId | 支持 |
| DescribeConfigs | 获取采集配置信息 | 资源级 | qcs::cls:$region:$account:config/$configId | 不支持 |
| DescribeConsole | 查询免腾讯云账号登录控制台 | 操作级 | * | 支持 |
| DescribeConsoles | 查询DataSight控制台实例列表 | 资源级 | qcs::cls::uin/${uin}:datasight/${datasightId} | 支持 |
| DescribeConsumer | 本接口用于获取投递配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DescribeConsumerPreview | 本接口用于kafka投递数据预览 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | 支持 |
| DescribeCosRecharges | 本接口用于获取cos导入配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DescribeDashboardSubscribes | 获取仪表盘订阅列表 | 资源级 | qcs::cls::uin/${uin}:dashboard/${dashboardId} | 支持 |
| DescribeDashboards | 本接口用于获取仪表盘列表 | 资源级 | qcs::cls::uin/${uin}:dashboard/${dashboardId} | 支持 |
| DescribeDataTransformFailLogInfo | 获取数据加工任务失败日志详请 | 资源级 | qcs::cls:${region}:uin/${uin}:datatransform/${TaskId} | 支持 |
| DescribeDataTransformInfo | 本接口用于获取数据加工任务列表基本信息 | 资源级 | qcs::cls:${region}:uin/${uin}:datatransform/$TaskId | 支持 |
| DescribeDataTransformPreviewDataInfo | 本接口用于获取数据加工预览详细数据。 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicId qcs::cls:${region}:uin/${uin}:datatransform/$datatransformId |
支持 |
| DescribeDataTransformPreviewInfo | 获取数据加工预览任务基本信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:datatransform/${TaskId} | 支持 |
| DescribeDataTransformProcessInfo | 本接口用于获取数据加工任务执行进度详情 | 资源级 | qcs::${ApiModule}:${Region}:uin/:datatransform/${TaskId} | 支持 |
| DescribeDemonstrations | 本接口用于获取日志服务演示示例列表 | 操作级 | * | 支持 |
| DescribeExceptionResources | 获取异常资源列表 | 操作级 | * | 支持 |
| DescribeExports | 获取日志导出列表 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| DescribeExternalDataSourcePreview | 外部数据源预览（验证连通性） | 操作级 | * | 支持 |
| DescribeFunctions | 本接口用于获取可使用的函数列表。 | 操作级 | * | 支持 |
| DescribeIdleResourcePolicy | 获取资源策略信息 | 操作级 | * | 支持 |
| DescribeIndex | 获取索引信息 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| DescribeIndexs | 本接口用于获取索引配置列表 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 支持 |
| DescribeKafkaConsume | 获取Kakfa消费信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | 支持 |
| DescribeKafkaConsumer | 获取Kafka协议消费信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${FromTopicId} | 支持 |
| DescribeKafkaRecharges | 获取Kafka导入配置列表 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DescribeLatestJsonLog | 获取json格式日志内容 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| DescribeLatestUserLog | 获取用户最新一条json格式日志 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DescribeLogContext | 检索上下文 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| DescribeLogFastAnalysis | 快速分析 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| DescribeLogHistogram | 获取直方图 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| DescribeMachineGroupConfigs | 获取机器组绑定的采集规则配置 | 资源级 | qcs::cls:$region:$account:machinegroup/$machinegroupId | 支持 |
| DescribeMachines | 获取机器状态 | 资源级 | qcs::cls:$region:$account:machinegroup/$groupid | 支持 |
| DescribeMetricCorrectDimension | 获取指标校准维度信息 | 操作级 | * | 支持 |
| DescribeMetricSubscribePreview | 指标订阅数据预览 | 操作级 | * | 支持 |
| DescribePartitions | 获取分区信息 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
| DescribeRemoteWriteTask | 获取remote write 任务列表 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DescribeResources | 获取全地域指标资源 | 操作级 | * | 支持 |
| DescribeScheduledSqlInfo | 本接口用于获取ScheduledSql任务列表 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 支持 |
| DescribeScheduledSqlProcessInfo | 本接口用于获取ScheduledSql任务进度信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${SrcTopicId} | 支持 |
| DescribeShipperPreview | 本接口用于返回cos投递预览数据结果 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | 支持 |
| DescribeShipperTasks | 获取投递任务列表 | 资源级 | qcs::cls:${region}:uin/${uin}:shipper/${ShipperId} | 支持 |
| DescribeShippers | 获取投递规则 | 资源级 | qcs::cls:${region}:uin/${uin}:shipper/${ShipperId} | 支持 |
| DescribeTopics | 批量获取日志主题 | 资源级 | qcs::cls:$region:$account:topic/$topicid | 支持 |
| EstimateRebuildIndexTask | 预估重建索引任务 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | 支持 |
| GetAccount | 获取用户状态信息 | 操作级 | * | 不支持 |
| GetAlarm | 获取告警信息 | 资源级 | qcs::cls:$region:$account:alarm/alarmId | 不支持 |
| GetAlarmLog | 获取告警历史 | 资源级 | qcs::cls:${region}:uin/${uin}:alarm/$alarmId | 支持 |
| GetChart | 获取图表信息 | 资源级 | qcs::cls:$region:$account:chart/$chartId | 不支持 |
| GetClsService | 查询日志服务是否开通 | 操作级 | * | 支持 |
| GetConfigurationTemplateApplyLog | 获取配置模板应用日志 | 操作级 | * | 支持 |
| GetDashboard | 获取仪表盘信息 | 资源级 | qcs::cls::uin/${uin}:dashboard/$dashboardId | 不支持 |
| GetDeliverFunction | 获取投递函数 | 操作级 | * | 不支持 |
| GetFastAnalysis | 获取快速分析结果 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| GetHistogram | 获取日志条数分布图 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| GetLog | 日志下载 | 操作级 | * | 不支持 |
| GetMetricLabelValues | 查询指标名称 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| GetMetricSeries | 根据正则匹配获取指标名称 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| GetResource | 获取全地域数据指标 | 操作级 | * | 不支持 |
| MetricsLabelValues | 时序指标label value查询 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 不支持 |
| MetricsLabels | 时序Labels指标查询 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 不支持 |
| MetricsQuery | Metrics 查询接口 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 不支持 |
| MetricsQueryExemplars | 时序指标Query Exemplars接口 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 不支持 |
| MetricsQueryRange | 时序指标范围查询接口 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 不支持 |
| MetricsRemoteRead | prometheus 远程读取接口 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 不支持 |
| MetricsSeries | 时序Series查询 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 不支持 |
| PreviewKafkaRecharge | Kafka导入日志预览 | 操作级 | * | 支持 |
| QueryMetric | 时序指标主题检索 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| QueryRangeMetric | 时序范围检索 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| SearchCosRechargeInfo | 本接口用于预览cos导入信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | 支持 |
| SearchDashboardSubscribe | 预览仪表盘订阅 | 资源级 | qcs::cls::uin/${uin}:dashboard/${DashboardId} | 支持 |
| SearchLog | 查询日志 | 资源级 | qcs::cls:${Region}:uin/${uin}:topic/${TopicId} | 支持 |
| ShowContext | 上下文检索 | 操作级 | * | 不支持 |
| getConfig | agent 获取配置 | 操作级 | * | 不支持 |
| getConsumer | 获取消费配置 | 操作级 | * | 不支持 |
| getConsumerGroupCursor | 获取消费组游标 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| getCursor | 获取日志游标 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| getIndex | 获取索引配置 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| getLogset | 获取日志集详情 | 资源级 | qcs::cls:$region:$account:logset/$logsetId | 不支持 |
| getMachineGroup | 获取机器组详情 | 资源级 | qcs::cls:$region:$account:machinegroup/$machinegroupId | 不支持 |
| getMachineStatus | 获取机器状态 | 资源级 | qcs::cls:$region:$account:machinegroup/$machinegroupId | 不支持 |
| getShipper | 获取投递配置详情 | 资源级 | qcs::cls:$region:$account:shipper/$shipperId | 不支持 |
| getTopic | 获取日志主题详情 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| getTopicExtendConfig | 获取clb的topic业务配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/$topicid | 不支持 |
| pullLog | 拉取数据 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 不支持 |
| pullLogs | 消费数据 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| searchLog | 查询日志 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 支持 |
其他操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| CheckRemoteWriteTaskConnect | 校验remote write task 连通性 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DeleteConsoleSharing | 删除控制台分享 | 操作级 | * | 不支持 |
| DeleteRemoteWriteTask | 删除remote write tasl | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| ModifyConsoleSharing | 修改控制台分享 | 操作级 | * | 不支持 |
列表操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| DescribeAgentConfigs | 获取采集配置 | 操作级 | * | 支持 |
| DescribeAlarmNotices | 获取告警通知模板列表 | 资源级 | qcs::cls:$region:$account:alarmNotice/$alarmNoticeId | 支持 |
| DescribeAlarmShields | 获取告警屏蔽列表 | 资源级 | qcs::cls:${region}:uin/${uin}:alarmNotice/${AlarmNoticeId} | 支持 |
| DescribeAlarms | 获取告警策略列表 | 资源级 | qcs::cls:$region:$account:alarm/$alarmId | 支持 |
| DescribeAlertRecordHistory | 告警历史记录 | 资源级 | qcs::cls:${region}:uin/${uin}:alarm/$alarmId | 支持 |
| DescribeAsyncContextTasks | 获取异步上下文任务列表 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${topicId} | 不支持 |
| DescribeAsyncSearchTasks | 获取异步检索任务列表 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${topicId} | 不支持 |
| DescribeBinlogSubscribes | 获取binlog采集配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DescribeConfigurationTemplates | 获取配置模板列表 | 操作级 | * | 支持 |
| DescribeConsoleSharingList | 批量查询控制台分享 | 操作级 | * | 不支持 |
| DescribeConsumerGroups | 或者消费组详情列表 | 资源级 | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | 不支持 |
| DescribeConsumerOffsets | 获取消费组点位信息 | 资源级 | qcs::cls:${region}:uin/${uin}:logset/${logsetId} | 不支持 |
| DescribeDataTransformAutoCreateLogSets | 获取数据加工自动创建日志集信息 | 操作级 | * | 支持 |
| DescribeDataTransformAutoCreateTopics | 获取数据加工自动创建日志主题 | 操作级 | * | 支持 |
| DescribeExternalDataSources | 获取外部数据源信息列表 | 资源级 | qcs::cls::uin/${uin}:topic/${TopicId} | 支持 |
| DescribeFolders | 获取文件夹列表 | 操作级 | * | 支持 |
| DescribeKafkaConsumerTopics | 获取kafka协议消费主题信息列表 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${FromTopicId} | 支持 |
| DescribeLogsets | 获取日志集列表 | 资源级 | qcs::cls:$region:$account:logset/$logsetid | 支持 |
| DescribeMachineGroups | 获取机器组列表 | 资源级 | qcs::cls:$region:$account:machinegroup/$groupid | 支持 |
| DescribeMetricSubscribes | 获取指标订阅配置 | 资源级 | qcs::cls:${region}:uin/${uin}:topic/${TopicId} | 支持 |
| DescribeNoticeContents | 获取通知内容列表 | 操作级 | * | 支持 |
| DescribeRebuildIndexTasks | 获取重建索引任务列表 | 资源级 | qcs::${ApiModule}:${Region}:uin/:topic/${TopicId} | 支持 |
| DescribeTopicExtendConfig | 获取采集配置(clb专用) | 操作级 | * | 支持 |
| DescribeWebCallbacks | 获取告警渠道回调配置列表 | 操作级 | * | 支持 |
| ListAlarm | 获取告警列表 | 操作级 | * | 不支持 |
| ListChart | 获取图表列表 | 资源级 | qcs::cls:$region:$account:dashboard/$dashboardId | 不支持 |
| ListDashboard | 获取仪表盘列表 | 操作级 | * | 不支持 |
| listConsumerGroup | 获取消费组列表 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| listLogset | 获取日志集列表 | 操作级 | * | 不支持 |
| listMachineGroup | 获取机器组列表 | 操作级 | * | 不支持 |
| listPartitions | 获取主题分区列表 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| listShipper | 获取投递配置列表 | 资源级 | qcs::cls:$region:$account:topic/$topicId | 不支持 |
| listShipperTask | 获取投递任务列表 | 资源级 | qcs::cls:$region:$account:shipper/$shipperId | 不支持 |
| listTopic | 获取日志主题列表 | 资源级 | qcs::cls:$region:$account:logset/$logsetId | 不支持 |