文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>访问管理>支持CAM的业务接口>大数据>数据分析>检索分析服务

检索分析服务

最近更新时间：2026-02-18 09:31:55

我的收藏

本页目录：

基本信息

CAM中产品名 CAM中简称 控制台访问 按标签授权 授权粒度 IP限制
检索分析服务 tsearch 支持 支持 资源级 支持
说明：

云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。

  • 服务级：定义对服务的整体是否拥有访问权限，分为允许对服务拥有全部操作权限或者拒绝对服务拥有全部操作权限。服务级授权粒度的云产品，不支持对具体的接口进行授权。
  • 操作级：定义对服务的特定接口（API）是否拥有访问权限，例如：授权某账号对云服务器服务进行只读操作。
  • 资源级：定义对特定资源是否有访问权限，这是最细的授权粒度，例如：授权某账号仅读写操作某台云服务器实例。能支持资源级接口授权的产品，则会被认定为资源级授权粒度。

接口授权粒度

接口授权粒度分为资源级和操作级两个级别：

  • 资源级接口：此类型接口支持对某一个具体特定的资源进行授权。
  • 操作级接口：此类型接口不支持对某一个特定的资源进行授权。授权时策略语法若限定了具体的资源，CAM会判断此接口不在授权范围，判断为无权限。

写操作

接口名 接口描述 授权粒度 资源六段式 IP限制
AddCVMInstancesOfCollector 用于增加采集器下发的CVM实例 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
CreateCollector 用于创建Beats采集器 操作级 * 支持
CreateDataImport 创建数据导入集成 操作级 * 支持
CreateIndex 创建索引 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
CreateIndexKibanaPattern 创建索引Kibana Pattern 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
CreateIndexMetaFieldToJson 创建索引元数据字段转JSON 操作级 * 支持
CreateIndexMetaJsonToField 创建索引元数据JSON转字段 操作级 * 支持
CreateInstance 创建TSearch集群实例 操作级 * 支持
CreateInstanceLogExport 创建ES集群日志导出 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
CreateLogstashInstance 创建Logstash实例 操作级 * 支持
CreateMappingsFromSample 从数据样例创建索引映射 操作级 * 支持
CreateOperationDurationEvent 创建可维护时间段弹窗事件 操作级 * 支持
CreateServerlessDi 创建serverless数据接入 资源级 qcs::tsearch::uin/${uin}:index/${ServerlessId} 支持
CreateServerlessIndexMetaFieldToJson 创建Serverless实例元数据字段转JSON 操作级 * 支持
CreateServerlessIndexMetaJsonToField 创建Serverless实例元数据JSON转字段 操作级 * 支持
CreateServerlessInstance 创建Serverless索引 操作级 * 支持
CreateServerlessInstanceUser 创建Serverless索引用户 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
CreateServerlessMappingsFromSample 从Serverless数据样例创建索引映射 操作级 * 支持
CreateServerlessSpace 创建Serverless索引空间 操作级 * 支持
CreateTradeSignAuth 创建询价或者下单签名 操作级 * 支持
DeleteCVMInstancesOfCollector 用于移除采集器下发的CVM实例 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
DeleteCollector 用于删除Beats采集器 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
DeleteDataImport 删除数据导入集成 资源级 qcs::tsearch::uin/${uin}:integration/${IntegrationId} 支持
DeleteIndex 删除索引 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DeleteInstance 销毁TSearch集群实例 资源级 qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} 支持
DeleteLogstashInstance 删除Logstash实例 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
DeleteLogstashPipelines 删除Logstash管道 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
DeleteServerlessDi 删除serverless数据接入 资源级 qcs::tsearch::uin/${uin}:index/${ServerlessId} 支持
DeleteServerlessInstance 删除Serverless索引 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
DeleteServerlessInstanceUser 删除Serverless索引用户 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
DeleteServerlessSpace 删除Serverless索引空间 资源级 qcs::tsearch::uin/${uin}:space/${SpaceId} 支持
DiagnoseInstance 智能运维诊断集群 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DownloadCerts 下载es证书 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
InquirePriceCreateInstance 创建实例询价 操作级 * 支持
MigrateEsInstance 迁移TSearch集群到指定可用区 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
ModifyAutoScaleDiskInfo 修改自动扩盘参数 资源级 qcs::tsearch:${region}:uin/${uin}:instance/${InstanceId} 支持
ModifyClusterVpcServiceProperty 修改集群VPC参数信息 资源级 qcs::tsearch:${region}:uin/${uin}:instance/$instanceId 支持
ModifyEsVipSecurityGroup 修改集群VIP绑定的安全组 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
ModifyInstanceDisasterRecoverGroup 修改集群置放群组配置 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
PrepayInstanceTransferToPost 包年包月实例转成按量计费实例 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
ReinstallCollector 用于重装Beats采集器 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
RenewInstance 续费指定的ES集群包年包月实例 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
RenewLogstashInstance 续费指定的Logstash包年包月实例 资源级 qcs::tsearch::uin/${uin}:logstash/${InstanceId} 支持
RepairNodesMachine 停机授权维修底层机器 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
RestartCollector 用于重启Beats采集器 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
RestartInstance 重启ES集群实例 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
RestartKibana 重启Kibana 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
RestartLogstashInstance 重启Logstash实例 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
RestartNodes 重启集群节点 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
SaveAndDeployLogstashPipeline 保存并部署管道 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
StartCollector 用于启动Beats采集器 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
StartLogstashPipelines 启动Logstash管道 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
StopCollector 用于停止Beats采集器 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
StopLogstashPipelines 停止Logstash管道 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
UpdateAuditLogStatus 更新审计日志状态 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpdateCollector update beats collector 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
UpdateCollectorName 用于修改Beats采集器名称 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
UpdateDataImport 变更数据导入集成 资源级 qcs::tsearch::uin/${uin}:integration/${IntegrationId} 支持
UpdateDataImportName 变更数据导入集成Name 资源级 qcs::tsearch::uin/${uin}:integration/${IntegrationId} 支持
UpdateDiagnoseSettings 更新智能运维配置 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpdateDictionaries 更新ES集群词典 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpdateDns 更新内网域名解析服务器 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpdateEsOperationDurations 批量更新es集群可维护时间段 操作级 * 支持
UpdateHeteroDelayScaleIn 更新异构扩缩容延迟状态 资源级 qcs::tsearch::uin/${uin}:InstanceId/${InstanceId} 支持
UpdateIndex 更新索引 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpdateIndexMetaFieldToJson 更新索引元数据字段转JSON 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
UpdateIndexMetaJsonToField 更新索引元数据JSON转字段 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
UpdateInstance 升级TSearch集群版本 资源级 qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} 支持
UpdateInstancePublicAccess 更新ES集群实例的公网开关 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
UpdateInstanceScalingHetero 异构扩缩容集群 资源级 qcs::tsearch::uin/${uin}:InstanceId/${InstanceId} 支持
UpdateInternal 内部更新接口 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpdateJdk 更新实例Jdk配置 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
UpdateJvmHeap 更新JVM 资源级 qcs::tsearch::uin/${uin}:Instance/${InstanceId} 支持
UpdateKibanaSoftware 更新ES集群实例的Kibana包 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpdateLogstashInstance 更新Logstash实例 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
UpdateLogstashInternal Logstash内部更新接口 资源级 qcs::tsearch::uin/${uin}:logstash/${InstanceId} 支持
UpdateLogstashPipelineDesc 更新管道描述 资源级 qcs::tsearch::uin/${uin}:logstash/${InstanceId} 支持
UpdateLsOperationDurations 批量更新logstash集群可维护时间段 操作级 * 支持
UpdateNodesStatus 更新集群节点运行状态 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpdateOutboundPublicAccess 更新TS集群实例出站公网访问 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpdatePlugins 变更插件列表 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
UpdateRequestTargetNodeTypes 更新接收客户端请求的节点类型 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
UpdateServerlessDi 更新serverless数据接入 资源级 qcs::tsearch::uin/${uin}:index/${ServerlessId} 支持
UpdateServerlessIndexMetaFieldToJson 更新Serverless实例元数据字段转JSON 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
UpdateServerlessIndexMetaJsonToField 更新Serverless实例元数据JSON转字段 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
UpdateServerlessInstance 更新Serverless索引 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
UpdateServerlessInstanceUser 更新Serverless索引用户 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
UpdateServerlessSpace 更新Serverless索引空间 资源级 qcs::tsearch::uin/${uin}:space/${SpaceId} 支持
UpdateUserBundles 变更用户文件包 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
UpgradeInstance 升级ES集群版本 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
UpgradeLicense 升级ES商业特性 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持

读操作

接口名 接口描述 授权粒度 资源六段式 IP限制
CheckCamLinkedRole 检查服务角色授权情况 操作级 * 支持
CheckClusterName 检查ClusterName 操作级 * 支持
CheckCreateIndex 检查创建索引 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
CheckForceRestart 强制重启检查 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
CheckOperation 检查操作 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
CheckScaleUpgrade 扩缩容方式版本升级检查 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
CheckServerlessIndexName 检查创建Serverless索引名 操作级 * 支持
CheckServerlessSpaceName 检查创建Serverless索引空间名 操作级 * 支持
CheckServerlessUsername 检查创建Serverless索引用户名 操作级 * 支持
CheckUpdateInstance TSearch集群实例变配检查接口 资源级 qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} 支持
CountCollectors 用于获取采集器数量 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
CountDataImport 数据导入集成Count 操作级 * 支持
CountInstances 获取集群数量 资源级 qcs::tsearch::uin/${uin}:instance/${instance} 支持
CountLogstashInstances 获取Logstash实例数量 操作级 * 支持
DescribeApmSearch Apm查询 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeAuditLogStatus 审计日志状态查询 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeAutoScaleDiskInfo 获取自动扩盘参数 资源级 qcs::tsearch:${region}:uin/${uin}:instance/${InstanceId} 支持
DescribeCVMInstancesOfCollector 获取采集器下发的CVM实例 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
DescribeCVMInstancesOfSameCollector 获取所有指定类型采集器已经下发的CVM实例列表 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
DescribeClientIp 展示客户端Ip 操作级 * 支持
DescribeClusterDiskRange 获取集群节点磁盘大小上下限信息 资源级 qcs::tsearch:${region}:uin/${uin}:instance/${InstanceId} 支持
DescribeClusterVpcServiceProperty 获取集群VPC参数信息 资源级 qcs::tsearch:${region}:uin/${uin}:instance/$instanceId 支持
DescribeDataImportDetail 数据导入集成DescribeDetail 资源级 qcs::tsearch::uin/${uin}:integration/${IntegrationId} 支持
DescribeDataImports 数据导入集成Describe 操作级 * 支持
DescribeDiagnose 查询智能运维诊断结果报告 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeDiagnoseStats 查询智能运维诊断结果统计 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeEsInstanceEventLists 查询事件中心列表 资源级 qcs::tsearch:${region}:uin/${uin}:Instance/${InstanceId} 支持
DescribeEventDataDetail 查询事件中心记录详情 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeIndexList 获取索引列表 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeIndexLogs 获取索引日志 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeIndexMeta 获取索引元数据 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeIndexOperations 查询索引指定条件下的操作记录 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeInstanceBundleList 查询实例用户文件包 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeInstanceLogs 查询集群日志 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
DescribeInstanceOperations 查询实例操作记录 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
DescribeInstancePluginList 查询实例插件列表 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeKibanaUrl 获取实例kibana链接 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeLogstashInstanceLogs 查询Logstash实例日志 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
DescribeLogstashInstanceOperations 查询Logstash实例操作记录 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
DescribeLogstashPipelineTemplates 获取Logstash实例管道模板列表 操作级 * 支持
DescribeLogstashPipelines 获取Logstash实例管道列表 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
DescribeNetworkConnection 查看集群目的端连通性 资源级 qcs::tsearch::uin/${uin}:instanceId/${InstanceId} 支持
DescribeNodes 用于查询集群节点列表，包含：节点IP、节点ID、节点类型等信息 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeOperationDurationEvent 查询可维护时间段弹窗事件 操作级 * 支持
DescribeSecurityGroupBindEs 查询安全组绑定的es集群信息 操作级 * 支持
DescribeServerlessDi 查询serverless数据接入 资源级 qcs::tsearch::uin/${uin}:index/${ServerlessId} 支持
DescribeServerlessInstanceLogs Serverless获取索引日志 操作级 * 支持
DescribeServerlessInstanceMeta Serverless获取索引元数据 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
DescribeServerlessInstanceOperation Serverless查询索引操作记录 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
DescribeServerlessInstanceUsers Serverless获取索引用户列表 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
DescribeServerlessInstances Serverless获取索引列表 资源级 qcs::tsearch::uin/${uin}:index/${InstanceId} 支持
DescribeServerlessQuota 获取Serverless配额 资源级 qcs::tsearch::uin/${uin}:space/${SpaceId} 支持
DescribeServerlessSpaces 获取Serverless索引空间列表 资源级 qcs::tsearch::uin/${uin}:space/${SpaceId} 支持
DescribeViews 查询集群各视图数据，包括集群维度、节点维度、可视化web节点维度 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
GetClusterMetric 根据给定的实例ID，获取集群的实时监控指标，如节点个数，数据节点个数，索引数，文档数，已使用磁盘大小，分片数，主分片数，迁移中分片数，初始化分片数，未分配分片数等 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
GetCosMonitorData 获取ES集群所使用的COS存储监控信息 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
GetDiagnoseSettings 查看智能运维配置 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
GetEsYmlConfig 获取集群YML配置 资源级 qcs::tsearch::uin/${uin}:InstanceId/${InstanceId} 支持
GetFederationToken 获取临时密钥 操作级 * 支持
GetHeteroScalingCvmInfo 查询异构扩缩容CVM信息 资源级 qcs::tsearch::uin/${uin}:InstanceId/${InstanceId} 支持
GetInstanceUpdateMode 获取TSearch集群实例支持的变配模式 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
GetJvmHeapInfo 获取jvm heap信息 资源级 qcs::tsearch::uin/${uin}:Instance/${InstanceId} 支持
GetNodesMetric 获取节点监控指标 操作级 * 支持
GetRequestTargetNodeTypes 获取接收客户端请求的节点类型 资源级 qcs::tsearch::uin/${uin}:instance/$instanceId 支持
InquirePriceRenewInstance 集群续费询价接口，续费前通过调用该接口，可获取集群续费的价格。 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
ListEsClusterTask 列出集群task信息 资源级 qcs::tsearch::uin/${uin}:InstanceId/${InstanceId} 支持
PredictCluster 预估ES集群 操作级 * 支持
PredictInstance 集群配置预估 操作级 * 支持
QueryRegionZone 获取可售卖地域及可用区 操作级 * 支持
QueryZoneResource 查询地域可用区资源 操作级 * 支持

列表操作

接口名 接口描述 授权粒度 资源六段式 IP限制
DescribeCollectors 用于获取采集器列表 资源级 qcs::tsearch::uin/${uin}:collector/${CollectorId} 支持
DescribeDataImportOperations 查询DataImport操作记录 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeIndices 索引模式列表 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
DescribeInstanceUpgradePlanList 能够参与活动的集群列表 操作级 * 支持
DescribeInstances 查询集群实例 资源级 qcs::tsearch::uin/${uin}:instance/${instance} 支持
DescribeInstancesOverview 概览页场景: 查询用户该地域下符合条件的所有实例 资源级 qcs::tsearch::uin/${uin}:instance/${instanceId} 支持
DescribeLogstashInstances 获取Logstash实例列表 资源级 qcs::tsearch::uin/${uin}:logstash/$instanceId 支持
DescribeRegions 查询ES支持的地域列表 操作级 * 支持
DescribeUpgrade 获取实例可升级列表 资源级 qcs::tsearch::uin/${uin}:instance/${InstanceId} 支持
GetClientIp 获取客户端Ip 操作级 * 支持
QueryRegionZoneForLogstash 获取Logstash可售卖地域及可用区 操作级 * 支持
QueryZoneResourceForLogstash 获取Logstash可用区资源情况 操作级 * 支持
中国站
目录