实例
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 索引管理 | ||
| CloseManagedIndex | 关闭Indexing Service集群中某个索引的云端托管功能。此功能不可逆，关闭后无法再开启 | 查看文档去调试 |
| CreateDataStream | 创建数据流，管理一批索引 | 查看文档去调试 |
| CreateILMPolicy | 创建索引生命周期策略，如果创建的策略名已经存在，则替换成该策略并递增版本 | 查看文档去调试 |
| CreateIndexTemplate | 创建集群索引模板，可用于索引模版的组件化设置 | 查看文档去调试 |
| DeleteDataStream | 删除指定的集群数据流 | 查看文档去调试 |
| DeleteILMPolicy | 删除指定的索引生命周期策略 | 查看文档去调试 |
| DeleteIndexTemplate | 删除置顶的索引模版 | 查看文档去调试 |
| DescribeILMPolicy | 查询指定索引生命周期详情 | 查看文档去调试 |
| DescribeIndexTemplate | 返回有关一个索引模板的信息 | 查看文档去调试 |
| ListDataStreams | 获取Elasticserch集群中，索引数据流列表 | 查看文档去调试 |
| ListILMPolicies | 查询集群已经创建的索引生命周期列表 | 查看文档去调试 |
| ListIndexTemplates | 查询索引模板列表 | 查看文档去调试 |
| RolloverDataStream | 为数据流或索引别名创建新索引 | 查看文档去调试 |
| UpdateILMPolicy | 修改Elasticsearch索引生命周期策略 | 查看文档去调试 |
| UpdateIndexTemplate | 修改Elasticsearch实例模版配置 | 查看文档去调试 |
| CreateComponentIndex | 创建Elasticsearch组合模板 | 查看文档去调试 |
| DeleteComponentIndex | 删除Elasticsearch的组合索引模板 | 查看文档去调试 |
| DeleteDeprecatedTemplate | 删除历史索引模板 | 查看文档去调试 |
| DescribeComponentIndex | 查看Elasticsearch的组合模板详情 | 查看文档去调试 |
| DescribeDeprecatedTemplate | 查看历史索引模板详情 | 查看文档去调试 |
| ListComponentIndices | 获取Elasticsearch的组合模板列表 | 查看文档去调试 |
| ListDeprecatedTemplates | 查看历史索引模板列表 | 查看文档去调试 |
| UpdateComponentIndex | 更新Elasticsearch的组合模板 | 查看文档去调试 |
createInstance | 创建Elasticsearch实例 | 查看文档去调试 |
| ListInstance | 获取ES实例列表信息 | 查看文档去调试 |
| DescribeInstance | 查询指定实例的详细信息 | 查看文档去调试 |
| DescribeRegions | 获取阿里云Elasticsearch的区域信息 | 查看文档去调试 |
| ListAllNode | 获取Elasticsearch集群下的所有节点信息 | 查看文档去调试 |
| GetElastictask | 获取集群的弹性扩缩容规则。必须在创建实例时购买弹性节点才可 | 查看文档去调试 |
| ListInstanceIndices | 能够过滤系统索引 | 查看文档去调试 |
| UpdateInstanceChargeType | Elasticsearch实例更改付费类型，按量付费实例转换为包年包月实例 | 查看文档去调试 |
| UpdateDescription | 更改Elasticsearch实例名称 | 查看文档去调试 |
| UpdateReadWritePolicy | 开启或关闭集群的写入高可用特性。目前仅支持华北2（北京）区域的实例 | 查看文档去调试 |
| ModifyElastictask | 更新集群弹性扩缩容规则 | 查看文档去调试 |
| ModifyInstanceMaintainTime | 更改并开启实例的可维护时间 | 查看文档去调试 |
| UpdateKibanaWhiteIps | 更新指定阿里云Elasticsearch实例的Kibana访问白名单 | 查看文档去调试 |
| UpdateWhiteIps | 修改ES实例的VPC私网访问白名单 | 查看文档去调试 |
| DeleteInstance | 实例所使用的物理资源都被回收，相关数据全部丢失且不可恢复；挂载实例节点的云盘和相应的快照都会被释放 | 查看文档去调试 |
| EstimatedRestartTime | 获取实例重启的大致时间 | 查看文档去调试 |
| RestartInstance | 重启Elasticsearch集群 | 查看文档去调试 |
| RenewInstance | 为包年包月的Elasticseach实例续费 | 查看文档去调试 |
| ActivateZones | 恢复已下线的可用区。仅对多可用区实例有效 | 查看文档去调试 |
| DeactivateZones | 在有多个可用区的情况下，下线部分可用区。并将下线的可用区中的节点迁移到其他可用区 | 查看文档去调试 |
| InterruptElasticsearchTask | 中断实例变更任务，仅对状态为生效中的实例有效，中断后，实例进入变更中断（suspended）状态 | 查看文档去调试 |
| ResumeElasticsearchTask | 恢复实例之间啊变更中断的任务 | 查看文档去调试 |
| MigrateToOtherZone | 迁移对应可用区下的节点到目标可用区 | 查看文档去调试 |
| CancelDeletion | 恢复释放后被冻结的Elasticsearch实例 | 查看文档去调试 |
| DiagnoseInstance | 即刻诊断实例 | 查看文档去调试 |
| MoveResourceGroup | 修改实例所属资源组 | 查看文档去调试 |
| CapacityPlan | 用于系统根据业务场景、QPS和日志产生量等情况为您推荐集群容量规划的最佳配置信息 | 查看文档去调试 |
| GetOpenStoreUsage | 查看OpensStore实例的存储容量和使用情况 | 查看文档去调试 |
| ListDicts | 查看指定类型的词典列表详情 | 查看文档去调试 |
| ListShardRecoveries | 查询有关正在进行和已完成的分片恢复的数据进度列表，默认返回正在进行的分片恢复信息 | 查看文档去调试 |
数据迁移
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| GetTransferableNodes | 指定节点类型和个数，获取可进行数据迁移的节点 | 查看文档去调试 |
| ListDataTasks | 获取不同Elasticsearch集群之间的数据迁移任务的列表 | 查看文档去调试 |
| GetClusterDataInformation | 获取索引迁移数据信息 | 查看文档去调试 |
| DeleteDataTask | 删除Elasticsearch索引迁移任务 | 查看文档去调试 |
| ValidateTransferableNodes | 校验是否可以迁移指定实例中某些节点上的数据 | 查看文档去调试 |
| TransferNode | 节点数据迁移，方便进行缩节点操作 | 查看文档去调试 |
| CancelTask | 取消正在运行的数据迁移任务 | 查看文档去调试 |
采集器
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateCollector | 创建采集器，采集指定服务上的数据 | 查看文档去调试 |
| DescribeCollector | 获取采集器实例的详细信息 | 查看文档去调试 |
| ListDefaultCollectorConfigurations | 获取采集器的默认配置文件 | 查看文档去调试 |
| ListCollectors | 获取采集器列表信息 | 查看文档去调试 |
| ListNodes | 智能运维的历史报告列表 | 查看文档去调试 |
| ModifyDeployMachine | 更新一个collector安装的esc机器 | 查看文档去调试 |
| UpdateCollector | 修改采集器配置 | 查看文档去调试 |
| UpdateCollectorName | 修改采集器名称 | 查看文档去调试 |
| StartCollector | 启动采集器，进行数据采集 | 查看文档去调试 |
| StopCollector | 停止运行中的采集器 | 查看文档去调试 |
| DeleteCollector | 删除指定的采集器 | 查看文档去调试 |
| RestartCollector | 重启采集器，进行数据采集工作 | 查看文档去调试 |
| ReinstallCollector | 重试安装在创建时没有安装成功的采集器 | 查看文档去调试 |
集群配置
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeTemplates | 获取实例的场景模板配置，集群settings配置 | 查看文档去调试 |
| ListAckClusters | 获取容器服务Kubernetes版ACK（Container Service for Kubernetes）集群列表 | 查看文档去调试 |
| ListDictInformation | 查看对应的词典信息 | 查看文档去调试 |
| ListEcsInstances | 获取当前用户vpc和vswitch下的ECS 实例列表 | 查看文档去调试 |
| DescribeAckOperator | 查看指定容器服务Kubernetes版ACK（Container Service for Kubernetes）集群上安装的Elasticsearch Operator信息 | 查看文档去调试 |
| GetRegionConfiguration | 获取当前的区域信息 | 查看文档去调试 |
| ListAckNamespaces | 查看指定容器服务Kubernetes版ACK（Container Service for Kubernetes）集群的所有命名空间 | 查看文档去调试 |
| UpdateInstanceSettings | 修改指定ES实例的YML参数配置 | 查看文档去调试 |
| UpdateHotIkDicts | 更新阿里云Elasticsearch实例的IK热词词典 | 查看文档去调试 |
| UpdateSynonymsDicts | 更新阿里云Elasticsearch实例的同义词词典 | 查看文档去调试 |
| UpdateDict | 更新Elasticsearch实例的用户词典 | 查看文档去调试 |
| UpdateAdvancedSetting | 更改Elasticsearch指定实例的垃圾回收器配置 | 查看文档去调试 |
| UpdateExtendConfig | 修改Elasticsearch场景化配置模板 | 查看文档去调试 |
| UpdateTemplate | 修改集群的场景化模板配置内容 | 查看文档去调试 |
| UpdateAliwsDict | 更新AliNLP分词插件（英文名为analysis-aliws）的词典 | 查看文档去调试 |
| deprecatedUpdateBlackIps | 更新IP黑名单，已废弃 | 查看文档去调试 |
| InstallAckOperator | 在指定容器服务集群上安装 Ack Operator | 查看文档去调试 |
| InstallUserPlugins | 安装用户自定义的已经上传至Elasticsearch控制台的插件 | 查看文档去调试 |
| RecommendTemplates | 获取推荐的集群配置 | 查看文档去调试 |
| ValidateSlrPermission | 验证当前账户SLR权限 | 查看文档去调试 |
| InitializeOperationRole | 创建服务关联角色 | 查看文档去调试 |
安全配置
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| AddConnectableCluster | 配置网络互通，完成不同实例的连接 | 查看文档去调试 |
| DescribeConnectableClusters | 获取能够与当前实例进行网络互通的实例列表。不包括已经打通的实例 | 查看文档去调试 |
| ListConnectedClusters | 获取已经与当前实例进行了网络互通的实例列表 | 查看文档去调试 |
| UpdatePrivateNetworkWhiteIps | 更新指定实例的VPC私网访问白名单 | 查看文档去调试 |
| UpdatePublicWhiteIps | 更新指定Elasticsearch实例的公网地址访问白名单 | 查看文档去调试 |
| UpdatePublicNetwork | 开启或关闭指定Elasticsearch实例的公网地址 | 查看文档去调试 |
| UpdateAdminPassword | 更新指定Elasticsearch实例的elastic账号的密码 | 查看文档去调试 |
| ModifyWhiteIps | 更新指定实例的访问白名单 | 查看文档去调试 |
| DeleteConnectedCluster | 删除两个实例之间的网络互通 | 查看文档去调试 |
| TriggerNetwork | 开启或关闭Elasticsearch或Kibana集群的公网或私网访问 | 查看文档去调试 |
| OpenHttps | 开启HTTPS协议。开启前请确保已购买协调节点 | 查看文档去调试 |
| CloseHttps | 关闭集群HTTPS协议 | 查看文档去调试 |
| CreateVpcEndpoint | 创建私网链接VPC终端节点，用于连接用户VPC下创建的终端节点服务 | 查看文档去调试 |
| DeleteVpcEndpoint | 删除服务VPC下的终端节点 | 查看文档去调试 |
| ListVpcEndpoints | 查看服务服务账号vpc下的终端节点状态 | 查看文档去调试 |
数据备份
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| CreateSnapshot | 手动对集群进行快照备份 | 查看文档去调试 |
| AddSnapshotRepo | 在设置跨集群OSS仓库时，创建引用仓库 | 查看文档去调试 |
| DescribeSnapshotSetting | 获取集群的快照备份设置，备份周期 | 查看文档去调试 |
| ListSnapshotReposByInstanceId | 获取当前实例的跨集群OSS仓库设置列表 | 查看文档去调试 |
| ListAlternativeSnapshotRepos | 获取当前实例可添加的OSS引用仓库 | 查看文档去调试 |
| UpdateSnapshotSetting | 更新指定实例的数据备份配置 | 查看文档去调试 |
| DeleteSnapshotRepo | 删除实例跨集群OSS引用仓库 | 查看文档去调试 |
智能运维
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| ListDiagnoseReport | 获取智能运维的历史报告 | 查看文档去调试 |
| ListDiagnoseReportIds | 获取智能运维历史报告所有的ID | 查看文档去调试 |
| DescribeDiagnoseReport | 查看智能运维的历史报告 | 查看文档去调试 |
| DescribeDiagnosisSettings | 获取智能运维的场景设置 | 查看文档去调试 |
| ListDiagnoseIndices | 获取指定实例智能运维模块中健康诊断的诊断索引 | 查看文档去调试 |
| UpdateDiagnosisSettings | 修改指定Elasticsearch实例的智能运维场景设置 | 查看文档去调试 |
| ListDiagnosisItems | 列举Elasticsearch实例智能诊断项目 | 查看文档去调试 |
| OpenDiagnosis | 打开实例的智能运维功能 | 查看文档去调试 |
| CloseDiagnosis | 关闭实例的智能运维功能 | 查看文档去调试 |
Kibana
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| DescribeKibanaSettings | 获取Elasticsearch实例的Kibana节点的配置 | 查看文档去调试 |
| ListKibanaPlugins | 获取Elasticsearch Kibana节点的插件列表 | 查看文档去调试 |
| UpdateKibanaSettings | 修改Kibana配置。目前仅支持修改Kibana语言配置 | 查看文档去调试 |
| InstallKibanaSystemPlugin | 安装Kibana预置插件。要求Kibana的规格为2核4G及以上 | 查看文档去调试 |
| UninstallKibanaPlugin | 卸载Elasticsearch实例Kibana节点插件 | 查看文档去调试 |
Logstash
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 实例管理 | ||
| ListLogstash | 在列表中展示所有或指定Logstash实例的详细信息 | 查看文档去调试 |
| DescribeLogstash | 查询Logstash实例详细信息 | 查看文档去调试 |
| UpdateLogstash | 修改指定实例的部分信息，例如节点数、配额、名称、硬盘大小等 | 查看文档去调试 |
| UpdateLogstashDescription | 修改指定Logstash实例名称 | 查看文档去调试 |
| UpdateLogstashChargeType | 将按量付费的阿里云Logstash实例转换为包年包月实例 | 查看文档去调试 |
| DeleteLogstash | 主动释放Logstash实例 | 查看文档去调试 |
| RenewLogstash | 指定Logstash实例续费 | 查看文档去调试 |
| RestartLogstash | 重启指定实例。重启后，实例会进入生效中（activing）状态 | 查看文档去调试 |
| EstimatedLogstashRestartTime | 获取Logstash实例重启的预估时间 | 查看文档去调试 |
| 集群配置 | ||
| ListExtendfiles | 获取Logstash实例的扩展文件配置 | 查看文档去调试 |
| UpdateLogstashSettings | 更新指定Logstash实例的配置 | 查看文档去调试 |
| 插件管理 | ||
| ListLogstashPlugins | 获取所有或指定插件的详细信息 | 查看文档去调试 |
| InstallLogstashSystemPlugin | 为指定的Logstash实例安装系统插件 | 查看文档去调试 |
| UninstallLogstashPlugin | Logstash实例卸载已安装的插件 | 查看文档去调试 |
| 日志查询 | ||
| ListLogstashLog | 查看Logstash实例的日志 | 查看文档去调试 |
| 集群监控 | ||
| ListAvailableEsInstanceIds | 在设置Logstash实例的X-Pack监控时，获取可用的Elasticsearch实例列表 | 查看文档去调试 |
| DescribeXpackMonitorConfig | 获取Logstash实例的X-Pack监控配置 | 查看文档去调试 |
| UpdateXpackMonitorConfig | 更新Logstash实例的X-Pack监控报警配置 | 查看文档去调试 |
| ValidateConnection | 验证提供X-Pack监控的Elasticsearch实例的联通性 | 查看文档去调试 |
| 变更任务管理 | ||
| InterruptLogstashTask | 中断后，实例会进入中断中（suspended）状态 | 查看文档去调试 |
| ResumeLogstashTask | 恢复实例的变更中断任务。恢复后实例会进入生效中（activating）状态 | 查看文档去调试 |
| 管道管理 | ||
| CreatePipelines | 创建Logstash管道，采集数据 | 查看文档去调试 |
| ListPipeline | 获取Logstash的管道列表 | 查看文档去调试 |
| DescribePipeline | 获取Logstash实例的管道信息 | 查看文档去调试 |
| DescribePipelineManagementConfig | 获取Logstash管道管理配置 | 查看文档去调试 |
| UpdatePipelines | 更新Logstash管道信息 | 查看文档去调试 |
| StopPipelines | 停止运行Logstash管道 | 查看文档去调试 |
| UpdatePipelineManagementConfig | 修改指定Logstash实例的管道管理方式 | 查看文档去调试 |
| DeletePipelines | 删除Logstash实例所配置的管道 | 查看文档去调试 |
| RunPipelines | 立即部署Logstash管道 | 查看文档去调试 |
| CreateLogstash | 创建一个Logstash实例 | 查看文档去调试 |
| ListPipelineIds | 获取Logstash实例管道ID列表 | 查看文档去调试 |
| UpdateExtendfiles | 更新Logstash实例的扩展文件配置 | 查看文档去调试 |
| CancelLogstashDeletion | 恢复释放后被冻结的Logstash实例 | 查看文档去调试 |
其他
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| ListInstanceHistoryEvents | 查看Elasticsearch集群触发的硬件运维事件列表 | 查看文档去调试 |
| UpdateDynamicSettings | 修改Elasticsearch集群的动态参数 | 查看文档去调试 |
| DescribeDynamicSettings | 获取Elasticsearch集群的动态参数 | 查看文档去调试 |
| ListActionRecords | 获取实例过去一段时间的管控变更记录 | 查看文档去调试 |
| DisableKibanaPvlNetwork | 关闭kibana私网 | 查看文档去调试 |
| UpdateKibanaPvlNetwork | 更新kibana私网访问 | 查看文档去调试 |
| ListKibanaPvlNetwork | 查询kibana私网详细信息 | 查看文档去调试 |
| EnableKibanaPvlNetwork | 开启Kibana私网访问 | 查看文档去调试 |