基本信息
| CAM中产品名 | CAM中简称 | 控制台访问 | 按标签授权 | 授权粒度 | IP限制 |
|---|---|---|---|---|---|
| Elasticsearch Service | es | 支持 | 支持 | 资源级 | 部分支持 |
说明：云产品的授权粒度按照粒度粗细分为服务级、操作级和资源级三个级别。
- 服务级：定义对服务的整体是否拥有访问权限，分为允许对服务拥有全部操作权限或者拒绝对服务拥有全部操作权限。服务级授权粒度的云产品，不支持对具体的接口进行授权。
- 操作级：定义对服务的特定接口（API）是否拥有访问权限，例如：授权某账号对云服务器服务进行只读操作。
- 资源级：定义对特定资源是否有访问权限，这是最细的授权粒度，例如：授权某账号仅读写操作某台云服务器实例。能支持资源级接口授权的产品，则会被认定为资源级授权粒度。
接口授权粒度
接口授权粒度分为资源级和操作级两个级别：
- 资源级接口：此类型接口支持对某一个具体特定的资源进行授权。
- 操作级接口：此类型接口不支持对某一个特定的资源进行授权。授权时策略语法若限定了具体的资源，CAM会判断此接口不在授权范围，判断为无权限。
写操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| AddCVMInstancesOfCollector | 用于增加采集器下发的CVM实例 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| AddForceMergeTask | 增加forceMerge任务 | 操作级 | * | 支持 |
| BindSpaceToAnotherCluster | 绑定space到指定集群 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| CancelEsClusterTask | 取消es集群task | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| ClosePostPayService | 关闭智能搜索后付费 | 操作级 | * | 支持 |
| CreateCdcEsQuota | 创建CDC集群配额 | 操作级 | * | 支持 |
| CreateCollector | 用于创建Beats采集器 | 资源级 | qcs::es::uin/${uin}:collector/* | 支持 |
| CreateCosMigrateToServerlessInstance | cos迁移流程 | 资源级 | qcs::es:${Region}:uin/${uin}:instance/${ServerlessId} | 支持 |
| CreateDSLBlockTask | 创建拦截语句任务 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| CreateDataImport | 创建数据导入集成 | 操作级 | * | 支持 |
| CreateIndex | 创建索引 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| CreateIndexKibanaPattern | 创建kibana索引模式 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| CreateIndexMetaFieldToJson | 索引字段转json | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| CreateIndexMetaJsonToField | 索引json转字段 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| CreateIndexMigrateToNewSpace | 索引升级到新空间 | 资源级 | qcs::es:${region}:uin/${uin}:index/${ServerlessId} | 支持 |
| CreateInstance | 创建ES集群实例 | 操作级 | * | 不支持 |
| CreateInstanceLogExport | 创建ES集群日志导出 | 操作级 | * | 支持 |
| CreateLogstashInstance | 创建Logstash实例 | 操作级 | * | 不支持 |
| CreateMCPInstance | 创建mcp 实例 | 操作级 | * | 支持 |
| CreateMappingsFromSample | 根据例子创建mappings | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| CreateOperationDurationEvent | 创建可维护时间段弹窗事件 | 操作级 | * | 支持 |
| CreateOrUpdateServerlessWatcher | 创建或者更新watcher | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| CreateSearchIndex | SearchIndex 创建 | 操作级 | * | 支持 |
| CreateSearchSpace | 创建Search Index项目空间 | 操作级 | * | 支持 |
| CreateServerlessDi | 创建serverless数据接入 | 资源级 | qcs::es:${region}:uin/${uin}:index/${ServerlessId} | 支持 |
| CreateServerlessInstance | 创建Serverless索引 | 操作级 | * | 支持 |
| CreateServerlessInstanceUser | 创建Serverless索引用户 | 资源级 | qcs::es:${region}:uin/${uin}:index/${InstanceId} | 支持 |
| CreateServerlessSpace | 创建Serverless索引空间 | 操作级 | * | 支持 |
| CreateServerlessSpaceUser | 创建项目空间子用户 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| CreateServerlessSpaceV2 | 创建serverless新项目空间 | 操作级 | * | 支持 |
| CreateSpace | 创建空间 | 操作级 | * | 支持 |
| CreateThreatIndicators | 创建威胁情报 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| CreateTradeSignAuth | 创建询价或者下单签名 | 操作级 | * | 支持 |
| CreateVipForMcpAgent | 创建mcp agent访问vip | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| DeleteCVMInstancesOfCollector | 用于移除采集器下发的CVM实例 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| DeleteClusterSnapshot | 删除快照备份 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| DeleteCollector | 用于删除Beats采集器 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| DeleteDSLBlockTask | 删除拦截语句任务 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| DeleteDataImport | 删除数据导入集成 | 资源级 | qcs::es::uin/${uin}:IntegrationId/${IntegrationId} | 支持 |
| DeleteIndex | 删除索引 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| DeleteInstance | 销毁ES集群实例 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| DeleteLogstashInstance | 删除Logstash实例 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| DeleteLogstashPipelines | 删除Logstash管道 | 资源级 | qcs::es:${region}:uin/${uin}:logstash/$instanceId | 支持 |
| DeleteSearchIndex | SearchIndex 删除 | 资源级 | qcs::es::uin/${uin}:index/${IndexId} | 支持 |
| DeleteSearchSpace | 删除Search索引空间 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DeleteServerlessDi | 删除serverless数据接入 | 资源级 | qcs::es:${region}:uin/${uin}:index/${ServerlessId} | 支持 |
| DeleteServerlessInstance | 删除Serverless索引 | 资源级 | qcs::${ApiModule}:${Region}:uin/:index/${InstanceId} | 支持 |
| DeleteServerlessInstanceUser | 删除Serverless索引用户 | 资源级 | qcs::es:${region}:uin/${uin}:index/${InstanceId} | 支持 |
| DeleteServerlessSpace | 删除Serverless索引空间 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DeleteServerlessSpaceUser | 删除项目空间子用户 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DeleteServerlessWatcher | 删除watcher | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DeleteThreatIndicators | 删除威胁情报 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| DeleteVipForMcpAgent | 删除mcp agent访问vip | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| MarkCosMigrateTask | 标记cos迁移任务已读状态 | 操作级 | * | 支持 |
| MigrateEsInstance | 迁移ES集群到指定可用区 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| ModifyAutoScaleDiskInfo | 修改自动扩盘参数 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| ModifyClusterVpcServiceProperty | 修改集群VPC参数信息 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| ModifyEsVipSecurityGroup | 修改集群VIP绑定的安全组 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| ModifyInstanceDisasterRecoverGroup | 修改集群置放群组配置 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| ModifyInstanceEsVipStatus | 修改集群vip下rs的挂载状态 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| OpenPostPayService | 开通智能搜索后付费 | 操作级 | * | 支持 |
| PrepayInstanceTransferToPost | 包年包月实例转成按量计费实例 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| ReinstallCollector | 用于重装Beats采集器 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| RepairNodesMachine | 停机授权维修底层机器 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| RestartCollector | 用于重启Beats采集器 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| RestartInstance | 重启ES集群实例 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| RestartKibana | 重启Kibana | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| RestartLogstashInstance | 重启Logstash实例 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| RestartNodes | 重启集群节点 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| RestoreClusterSnapshot | 快照备份恢复 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| SaveAndDeployLogstashPipeline | 保存并部署管道 | 资源级 | qcs::es:${region}:uin/${uin}:logstash/$instanceId | 支持 |
| SendVerificationCode | 发送邮箱验证码 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| StartCollector | 用于启动Beats采集器 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| StartLogstashPipelines | 启动Logstash管道 | 资源级 | qcs::es:${region}:uin/${uin}:logstash/$instanceId | 支持 |
| StopCollector | 用于停止Beats采集器 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| StopLogstashPipelines | 停止Logstash管道 | 资源级 | qcs::es:${region}:uin/${uin}:logstash/$instanceId | 支持 |
| TerminateMCPInstance | 销毁mcp实例 | 操作级 | * | 支持 |
| UpdateAuditLogStatus | 更新审计日志状态 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| UpdateCdcEsQuota | 更新CDC集群资源包 | 操作级 | * | 支持 |
| UpdateCollector | update beats collector | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| UpdateCollectorName | 用于修改Beats采集器名称 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| UpdateDSLBlockTask | 更新拦截语句任务 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| UpdateDataImport | 变更数据导入集成 | 资源级 | qcs::es::uin/${uin}:integrationId/${IntegrationId} | 支持 |
| UpdateDataImportName | 变更数据导入集成名称 | 资源级 | qcs::es::uin/${uin}:integrationId/${IntegrationId} | 支持 |
| UpdateDiagnoseSettings | 更新智能运维配置 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| UpdateDictionaries | 更新ES集群词典 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| UpdateDns | 更新dns | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| UpdateEsOperationDurations | 批量更新es集群可维护时间段 | 资源级 | qcs::es::uin/${uin}:instance/* | 支持 |
| UpdateForceMergeTask | 修改forcemrge任务 | 操作级 | * | 支持 |
| UpdateHeteroDelayScaleIn | 更新异构扩缩容延迟状态 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| UpdateIndex | 更新索引 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| UpdateIndexMetaFieldToJson | 更新索引字段转json | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| UpdateIndexMetaJsonToField | 更新索引json转字段 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| UpdateInstance | 更新ES集群实例 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| UpdateInstancePublicAccess | 更新ES集群实例的公网开关 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| UpdateInstanceScalingHetero | 异构扩缩容集群 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| UpdateInternal | 内部调用update功能 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| UpdateIpTraceStatus | 更新IP溯源状态 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| UpdateJdk | 更新实例Jdk配置 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| UpdateKibanaSoftware | 更新ES集群实例的Kibana包 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| UpdateLogstashInstance | 更新Logstash实例 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| UpdateLogstashPipelineDesc | 更新管道描述 | 资源级 | qcs::es::uin/${uin}:logstash/${InstanceId} | 支持 |
| UpdateLsOperationDurations | 批量更新logstash集群可维护时间段 | 资源级 | qcs::es::uin/${uin}:logstash/* | 支持 |
| UpdateNodesStatus | 用于节点开机或关机 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| UpdateOutboundPublicAccess | 更新ES集群实例出站公网访问 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| UpdatePlugins | 变更插件列表 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| UpdateRequestTargetNodeTypes | 更新接收客户端请求的节点类型 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| UpdateSearchIndex | SearchIndex 更新 | 资源级 | qcs::es::uin/${uin}:index/${IndexId} | 支持 |
| UpdateSearchSpace | SearchSpace 更新空间 | 资源级 | qcs::es::uin/${uin}:space/${SpaceId} | 支持 |
| UpdateServerlessDi | 更新serverless数据接入 | 资源级 | qcs::es:${region}:uin/${uin}:index/${ServerlessId} | 支持 |
| UpdateServerlessInstance | 更新Serverless索引 | 资源级 | qcs::${ApiModule}:${Region}:uin/:index/${InstanceId} | 支持 |
| UpdateServerlessInstanceUser | 更新Serverless索引用户 | 资源级 | qcs::es:${region}:uin/${uin}:index/${InstanceId} | 支持 |
| UpdateServerlessSpace | 更新Serverless索引空间 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| UpdateServerlessSpaceRestrict | 更新serverless空间限制 | 资源级 | qcs::es::uin/${uin}:space/SpaceId | 支持 |
| UpdateServerlessSpaceUser | 更新项目空间子用户 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| UpdateServerlessWatcher | 修改Watcher | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| UpdateUserBundles | 变更用户文件包 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| UpgradeInstance | 升级ES集群版本 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| UpgradeLicense | 升级ES商业特性 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| UpgradeMCPInstance | 升级mcp实例 | 操作级 | * | 支持 |
其他操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| ChatCompletions | 大模型生成 | 操作级 | * | 支持 |
| CheckMigrateIndexMetaData | 检查cos迁移索引元数据 | 资源级 | qcs::es:${Region}:uin/${uin}:instance/${ServerlessId} | 支持 |
| ChunkDocument | 文档切片 | 操作级 | * | 支持 |
| ChunkDocumentAsync | 文档切片异步 | 操作级 | * | 支持 |
| CreateClusterSnapshot | 手动创建集群快照 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| CreateOnlineReindex | 在线reindex | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| GetImageEmbedding | 获取图片嵌入向量 | 操作级 | * | 支持 |
| GetTextEmbedding | 获取特征向量 | 操作级 | * | 支持 |
| NotifyEsServerless | NotifyEsServerless | 操作级 | * | 支持 |
| ParseDocument | 实时文档解析 | 操作级 | * | 支持 |
| ParseDocumentAsync | 文档解析异步 | 操作级 | * | 支持 |
| RenewInstance | 续费指定的ES集群包年包月实例 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| RenewLogstashInstance | 续费指定的Logstash包年包月实例 | 资源级 | qcs::${ApiModule}:${Region}:uin/:logstash/${InstanceId} | 支持 |
| RunRerank | 重排序 | 操作级 | * | 支持 |
| UpdateJvmHeap | 更新JVM | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
读操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| CheckCamLinkedRole | 检查服务角色授权情况 | 操作级 | * | 支持 |
| CheckClusterName | 用于检查要设置的ClusterName是否合法，是否重复等 | 操作级 | * | 支持 |
| CheckCreateIndex | 检查创建索引 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| CheckForceRestart | 强制重启检查 | 操作级 | * | 支持 |
| CheckOperation | 对涉及缩容或重启的操作，检查实例是否允许操作 | 资源级 | qcs::es::uin/${uin}:instanceId/${InstanceId} | 支持 |
| CheckScaleUpgrade | 扩缩容方式版本升级检查 | 操作级 | * | 支持 |
| CheckSearchSpaceName | SearchSpace 检查空间名 | 操作级 | * | 支持 |
| CheckServerlessIndexName | 检查创建Serverless索引名 | 操作级 | * | 支持 |
| CheckServerlessSpaceName | 检查创建Serverless索引空间名 | 操作级 | * | 支持 |
| CheckServerlessUsername | 检查创建Serverless索引用户名 | 资源级 | qcs::es::uin/${uin}:index/${InstanceId} | 支持 |
| CheckUpdateInstance | ES集群实例变配检查接口 | 资源级 | qcs::es::uin/${uin}:instanceId/${InstanceId} | 支持 |
| CountCollectors | 用于获取采集器数量 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| CountDataImport | 数据导入集成Count | 资源级 | qcs::es::uin/${uin}:collectorId/${CollectorId} | 支持 |
| CountInstances | 获取ES集群数量 | 操作级 | * | 支持 |
| CountLogstashInstances | 获取Logstash实例数量 | 操作级 | * | 支持 |
| CreateSearchIndexFieldToMeta | IndexMeta 创建场景 - 字段转元数据 | 操作级 | * | 支持 |
| CreateSearchIndexMappings | SearchIndex 从样例创建索引映射 | 操作级 | * | 支持 |
| CreateSearchIndexMetaToField | IndexMeta 创建场景 - 元数据转字段 | 操作级 | * | 支持 |
| CreateServerlessIndexMetaFieldToJson | 创建Serverless实例元数据字段转JSON | 操作级 | * | 支持 |
| CreateServerlessIndexMetaJsonToField | 创建Serverless实例元数据JSON转字段 | 操作级 | * | 支持 |
| CreateServerlessMappingsFromSample | 从Serverless数据样例创建索引映射 | 操作级 | * | 支持 |
| DescribeAISearchMetrics | 查询智能搜索指标数据 | 操作级 | * | 支持 |
| DescribeApmSearch | Apm查询 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| DescribeAtomicServiceDetails | 查询原子服务明细 | 操作级 | * | 支持 |
| DescribeAtomicServices | 查询原子服务 | 操作级 | * | 支持 |
| DescribeAuditLogStatus | 获取审计日志开启状态 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| DescribeAutoScaleDiskInfo | 获取自动扩盘参数 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| DescribeCVMInstancesOfCollector | 获取采集器下发的CVM实例 | 资源级 | qcs::es:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| DescribeCVMInstancesOfSameCollector | 获取所有指定类型采集器已经下发的CVM实例列表 | 操作级 | * | 支持 |
| DescribeClientIp | 获取用户ip | 操作级 | * | 支持 |
| DescribeClusterVpcServiceProperty | 获取集群VPC参数信息 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| DescribeDataImportDetail | 数据导入集成详情 | 资源级 | qcs::es::uin/${uin}:IntegrationId/${IntegrationId} | 支持 |
| DescribeDataImportOperations | 查询数据导入操作记录 | 资源级 | qcs::es::uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeDataImports | 数据导入集成Describe | 操作级 | * | 支持 |
| DescribeDiagnose | 查询智能运维诊断结果报告 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| DescribeDiagnoseStats | 查询智能运维诊断结果统计 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| DescribeDocumentTasks | 查询文档处理任务 | 操作级 | * | 支持 |
| DescribeEsInstanceEventLists | 查询事件中心列表 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| DescribeEventDataDetail | 查询事件中心记录详情 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| DescribeForceMergeTask | 查询新增的forcemerge任务列表 | 操作级 | * | 支持 |
| DescribeGenPromptTemplates | 查询GenPrompt模板列表 | 操作级 | * | 支持 |
| DescribeIndexList | 获取索引列表 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| DescribeIndexLogs | 获取索引日志 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| DescribeIndexMeta | 获取索引元数据 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| DescribeIndexOperations | 查询索引指定条件下的操作记录 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| DescribeIndices | 索引模式列表 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| DescribeInstanceBundleList | 查询实例用户文件包 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| DescribeInstanceLogExportIndex | 获取日志导出到serverless的索引 | 操作级 | * | 支持 |
| DescribeInstanceLogs | 查询ES集群日志 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| DescribeInstanceOperations | 查询实例操作记录 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| DescribeInstancePluginList | 查询实例插件列表 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| DescribeInstanceUpgradePlanList | 能够参与活动的集群列表 | 操作级 | * | 支持 |
| DescribeKibanaTools | kibana内嵌 | 资源级 | qcs::es:${region}:uin/${uin}:index/${InstanceId} | 支持 |
| DescribeKibanaUrl | 获取实例kibana链接 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| DescribeLogstashInstanceLogs | 查询Logstash实例日志 | 资源级 | qcs::es:${region}:uin/${uin}:logstash/$instanceId | 支持 |
| DescribeLogstashInstanceOperations | 查询Logstash实例操作记录 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| DescribeLogstashPipelineTemplates | 获取Logstash实例管道模板列表 | 操作级 | * | 支持 |
| DescribeLogstashPipelines | 获取Logstash实例管道列表 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| DescribeLogstashViews | 查询Logstash集群视图 | 资源级 | qcs::es::uin/${uin}:LogstashInstanceId/${LogstashInstanceId} | 支持 |
| DescribeMCPInstance | 获取mcp实例信息 | 操作级 | * | 支持 |
| DescribeModelDetails | DescribeModelDetails | 操作级 | * | 支持 |
| DescribeModels | DescribeModels | 操作级 | * | 支持 |
| DescribeNetworkConnection | 查看集群ldap目的端连通性 | 资源级 | qcs::es::uin/${uin}:instanceId/${InstanceId} | 支持 |
| DescribeNodes | 用于查询集群节点列表，包含：节点IP、节点ID、节点类型等信息 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| DescribeOperationDurationEvent | 查询可维护时间段弹窗事件 | 操作级 | * | 支持 |
| DescribePocQuota | 查询用户Poc额度 | 操作级 | * | 支持 |
| DescribePostPayStatus | 查询智能搜索后付费开通状态 | 操作级 | * | 支持 |
| DescribePromptTemplates | 查询prompt模板列表 | 操作级 | * | 支持 |
| DescribeRegions | 查询ES支持的地域列表 | 操作级 | * | 支持 |
| DescribeResourcePackage | 查询用户资源包详情 | 操作级 | * | 支持 |
| DescribeResourcePackageMeta | 查询计费项元数据 | 操作级 | * | 支持 |
| DescribeScenes | 查看全部场景列表 | 操作级 | * | 支持 |
| DescribeSearchIndexOperations | SearchIndex 获取操作记录 | 资源级 | qcs::es::uin/${uin}:index/${IndexId} | 支持 |
| DescribeSearchIndices | SearchIndex 获取列表 | 资源级 | qcs::es::uin/${uin}:index/${IndexId} | 支持 |
| DescribeSearchSpaceOperations | SearchSpace查询索引操作记录 | 资源级 | qcs::es::uin/${uin}:space/${SpaceId} | 支持 |
| DescribeSearchSpaceUsers | SearchSpace 查看用户 | 资源级 | qcs::es::uin/${uin}:space/${SpaceId} | 支持 |
| DescribeSearchSpaces | 获取SearchSpace列表 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DescribeSecurityGroupBindEs | 查询安全组绑定的es集群信息 | 资源级 | qcs::es::uin/${uin}:SecurityGroupId/${SecurityGroupId} | 支持 |
| DescribeServerlessDi | 查询serverless数据接入 | 资源级 | qcs::es:${region}:uin/${uin}:index/${ServerlessId} | 支持 |
| DescribeServerlessInstanceLogs | Serverless获取索引日志 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| DescribeServerlessInstanceMeta | Serverless获取索引元数据 | 资源级 | qcs::${ApiModule}:${Region}:uin/:index/${InstanceId} | 支持 |
| DescribeServerlessInstanceOperation | Serverless查询索引操作记录 | 资源级 | qcs::${ApiModule}:${Region}:uin/:index/${InstanceId} | 支持 |
| DescribeServerlessInstanceUsers | Serverless获取索引用户列表 | 资源级 | qcs::es:${region}:uin/${uin}:index/${InstanceId} | 支持 |
| DescribeServerlessInstances | Serverless获取索引列表 | 资源级 | qcs::es:${region}:uin/${uin}:index/${InstanceId} | 支持 |
| DescribeServerlessMappingFields | DescribeServerlessMappingFields | 操作级 | * | 支持 |
| DescribeServerlessMetrics | 获取实例对应的监控指标,过去5min维度 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DescribeServerlessQuota | 获取Serverless配额 | 操作级 | * | 支持 |
| DescribeServerlessSpaceOperations | ServerlessSpace查询索引操作记录 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DescribeServerlessSpaceRestrict | 查询空间限制 | 资源级 | qcs::es::uin/${uin}:space/SpaceId | 支持 |
| DescribeServerlessSpaceUser | 查看项目空间子用户 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DescribeServerlessSpaces | 获取Serverless索引空间列表 | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DescribeServerlessWatchers | 查询ServerlessWatchers | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DescribeSpaceDomain | ServerlessSpace域名查询 | 资源级 | qcs::es:${Region}:uin/${uin}:space/${SpaceId}, | 支持 |
| DescribeSpaceKibanaTools | 获取空间检索分析token | 资源级 | qcs::es:${region}:uin/${uin}:space/${SpaceId} | 支持 |
| DescribeSpaces | 查看空间列表 | 操作级 | * | 支持 |
| DescribeThreatIndicators | 查询威胁情报 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| DescribeUpgrade | 获取实例可升级列表，包括可升级的大版本、商业特性 | 操作级 | * | 支持 |
| DescribeUserCosSnapshotList | 查询快照信息接口 | 操作级 | * | 支持 |
| DescribeUserCosSnapshotTaskList | 查询用户 cos 迁移任务列表 | 资源级 | qcs::es:${Region}:uin/${uin}:instance/${InstanceId} | 支持 |
| DescribeUserIndexMigrateStatus | 查询索引维度的 cos迁移任务状态 | 资源级 | qcs::es:${region}:uin/${uin}:index/${InstanceId} | 支持 |
| DescribeViews | 查询集群各视图数据，包括集群维度、节点维度、Kibana维度 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| DiagnoseInstance | 智能运维诊断集群 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| DownloadCerts | 下载集群证书 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| ExportIpTraceLog | 导出IP溯源日志 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| GenDiCollectorRule | GenDiCollectorRule | 操作级 | * | 支持 |
| GenerateSceneCode | 组装代码 | 操作级 | * | 支持 |
| GetAllIndexName | 获取所有索引名称 | 资源级 | qcs::es:${region}:uin/${uin}:Instance/${InstanceId} | 支持 |
| GetAllTraceIp | 查询溯源IP | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| GetCDCInstanceCnt | 获取CDC集群下ES实例总数 | 操作级 | * | 支持 |
| GetCDCTotalResources | 获取CDC集群全部资源 | 操作级 | * | 支持 |
| GetCDCUsedResources | 获取CDC集群已使用资源 | 操作级 | * | 支持 |
| GetClientIp | 获取用户ip | 操作级 | * | 支持 |
| GetClusterMetric | 根据给定的实例ID，获取集群的实时监控指标，如节点个数，数据节点个数，索引数，文档数，已使用磁盘大小，分片数，主分片数，迁移中分片数，初始化分片数，未分配分片数等 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| GetCosMonitorData | 获取ES集群所使用的COS存储监控信息 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| GetDiCollectorSetting | GetDiCollectorSetting | 操作级 | * | 支持 |
| GetDiagnoseSettings | 查看智能运维配置 | 操作级 | * | 支持 |
| GetDocumentChunkResult | 查询文件切片结果 | 操作级 | * | 支持 |
| GetDocumentParseResult | 获取文档解析结果 | 操作级 | * | 支持 |
| GetDocumentParsingResult | 获取文档解析内容 | 操作级 | * | 支持 |
| GetEsCreateGoodsInfo | 获取新购下单参数 | 操作级 | * | 支持 |
| GetEsYmlConfig | 获取ES YML配置 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| GetFederationToken | 获取临时密钥 | 操作级 | * | 支持 |
| GetFreeTrialUsage | 免费体验次数查询 | 操作级 | * | 支持 |
| GetHeteroScalingCvmInfo | 查询异构扩缩容CVM信息 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| GetInstanceUpdateMode | 获取ES集群实例支持的变配模式，Response返回的是一个整型数组：0 直接调配，1 滚动重启模式，2 蓝绿变配模式 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| GetInternalAccountUinToJudge | 获取内部帐号并判断 | 操作级 | * | 支持 |
| GetIpTraceStatus | 查询集群IP溯源状态 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| GetJvmHeapInfo | 获取jvm heap信息 | 资源级 | qcs::es:${region}:uin/${uin}:Instance/${InstanceId} | 支持 |
| GetNodesMetric | 获取指定实例节点维度的监控指标，如IP， CPU使用率，JVM内存使用率，可使用磁盘空间，分片数等 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| GetRequestTargetNodeTypes | 获取接收客户端请求的节点类型 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| GetTaskFlow | 获取任务流程信息 | 资源级 | qcs::es:${Region}:uin/${uin}:instance/${InstanceId} | 支持 |
| InquirePriceCreateInstance | ES集群续费询价 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| InquirePriceRenewInstance | 集群续费询价接口，续费前通过调用该接口，可获取集群续费的价格。 | 资源级 | qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} | 支持 |
| InstallInstanceModel | 安装ES集群模型 | 操作级 | * | 支持 |
| ListEsClusterTask | 罗列es集群task列表 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| PredictCluster | 集群预估 | 操作级 | * | 支持 |
| PredictInstance | 集群配置预估接口 | 操作级 | * | 支持 |
| QueryAggsIpCountLog | 统计访问IP | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| QueryAggsIpFrequenceLog | 统计IP访问频率 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| QueryAndCheckServerlessWatcher | watcher查询语句预览 | 资源级 | qcs::es::uin/${uin}:serverlessId/${ServerlessId} | 支持 |
| QueryIpTraceLog | 查询IP溯源日志 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| QueryRegionZone | 查询地域区域 | 操作级 | * | 支持 |
| QueryRegionZoneForLogstash | 获取Logstash可售卖地域及可用区 | 操作级 | * | 支持 |
| QueryRegionZoneForSearch | ServerlessIndex 获取可用区 | 操作级 | * | 支持 |
| QueryRegionZoneForServerless | serverless获取可用区 | 操作级 | * | 支持 |
| QuerySearchIndex | SearchIndex 搜索接口 | 资源级 | qcs::es::uin/${uin}:index/${IndexId} | 支持 |
| QueryZoneResource | 获取可用区资源情况 | 操作级 | * | 支持 |
| QueryZoneResourceForLogstash | 获取Logstash可用区资源情况 | 操作级 | * | 支持 |
| ReconcileIndex | 自动化对账 | 资源级 | qcs::es::uin/${uin}:index/${ServerlessId} | 支持 |
| RequestInstances | 请求es集群本身 | 操作级 | * | 支持 |
| SearchServerlessData | 获取serverless索引数据内部接口 | 资源级 | qcs::es:${region}:uin/${uin}:index/${ServerlessId} | 支持 |
| SearchServerlessInstance | 获取serverless索引数据接口 | 资源级 | qcs::es:${region}:uin/${uin}:index/${ServerlessId} | 支持 |
| SmartAdvisorManage | ES 云顾问管理接口 | 资源级 | qcs::es:${Region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| SmartAdvisorManageBatch | ES 云顾问管理接口批量 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| UpdateSearchIndexFieldToMeta | 更新SearchIndex字段转元数据 | 操作级 | * | 支持 |
| UpdateSearchIndexMetaToField | IndexMeta 更新场景 - 元数据转字段 | 操作级 | * | 支持 |
| UpdateServerlessIndexMetaFieldToJson | 更新Serverless实例元数据字段转JSON | 资源级 | qcs::es::uin/${uin}:index/${InstanceId} | 支持 |
| UpdateServerlessIndexMetaJsonToField | 更新Serverless实例元数据JSON转字段 | 资源级 | qcs::es::uin/${uin}:index/${ServerlessId} | 支持 |
| VerifyInstancePaas | 校验集群账号密码 | 资源级 | qcs::es::uin/${uin}:instance/${InstanceId} | 支持 |
| WebSearch | 网页搜索接口 | 操作级 | * | 支持 |
列表操作
| 接口名 | 接口描述 | 授权粒度 | 资源六段式 | IP限制 |
|---|---|---|---|---|
| DescribeAuditLogOperateList | 查询审计日志操作记录列表 | 资源级 | qcs::es::uin/${uin}:InstanceId/${InstanceId} | 支持 |
| DescribeClusterSnapshot | 获取快照备份列表 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${InstanceId} | 支持 |
| DescribeCollectors | 用于获取采集器列表 | 资源级 | qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} | 支持 |
| DescribeDSLBlockTask | 查询语句拦截列表 | 资源级 | qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} | 支持 |
| DescribeInstances | 查询ES集群实例 | 资源级 | qcs::es:${region}:uin/${uin}:instance/$instanceId | 支持 |
| DescribeInstancesOverview | 概览页场景: 查询用户该地域下符合条件的所有实例 | 资源级 | qcs::es:${region}:uin/${uin}:instance/${instanceId} | 支持 |
| DescribeLogstashInstances | 获取Logstash实例列表 | 资源级 | qcs::es:${region}:uin/${uin}:logstash/$instanceId | 支持 |
