API概览 - API参考| 阿里云

本文为您提供阿里云Elasticsearch、Kibana、Logstash和Beats的API接口及说明。如果您需要使用本文中没有提到的接口，请联系阿里云技术支持工程师获取。

Elasticsearch


类别	API	描述
实例管理	createInstance	调用createInstance，创建Elasticsearch实例。
	ListInstance	调用ListInstance，在列表中展示所有或指定实例的详细信息。
	DescribeInstance	调用DescribeInstance，查询指定实例的详细信息。
	EstimatedRestartTime	调用EstimatedRestartTime，获取重启实例的预估时间。
	RestartInstance	调用RestartInstance，重启指定的阿里云Elasticsearch实例。
	UpdateInstanceChargeType	调用UpdateInstanceChargeType，将按量付费实例转换为包年包月实例。
	UpdateDescription	调用UpdateDescription，更新指定实例的名称。
	DeleteInstance	调用DeleteInstance，释放指定按量付费类型的阿里云Elasticsearch实例。释放后，实例所使用的物理资源都被回收，相关数据全部丢失且不可恢复；挂载实例节点的云盘和相应的快照都会被释放。
	CancelDeletion	调用CancelDeletion，恢复释放后被冻结的Elasticsearch实例。
	RenewInstance	调用RenewInstance，为包年包月实例续费。
	ActivateZones	调用ActivateZones，恢复已下线的可用区中的节点。仅对多可用区实例有效。
	DeactivateZones	调用DeactivateZones，在有多个可用区的情况下，下线部分可用区。并将下线的可用区中的节点迁移到其他可用区。
	DescribeRegions	调用DescribeRegions，获取阿里云Elasticsearch的区域信息。
	InterruptElasticsearchTask	调用InterruptElasticsearchTask，中断变更中的阿里云Elasticsearch实例。仅对状态为生效中的实例有效，中断后，实例进入变更中断（suspended）状态。
	ResumeElasticsearchTask	调用ResumeElasticsearchTask，恢复中断变更的阿里云Elasticsearch实例。
	ListAllNode	调用ListAllNode，获取集群下的所有节点信息。
	ListInstanceIndices	调用ListInstanceIndices，获取集群的索引列表。
	MigrateToOtherZone	调用MigrateToOtherZone，迁移对应可用区下的节点到目标可用区。
	ModifyInstanceMaintainTime	调用ModifyInstanceMaintainTime，更改并开启实例的可维护时间。
	标签管理	ListTags	调用ListTags，查询所有可见的用户标签。
		ListTagResources	调用ListTagResources，查询可见的资源标签关系。
		TagResources	调用TagResources，创建标签资源关系。
UntagResources		调用UntagResources，删除用户资源标签关系。
数据迁移	GetTransferableNodes	调用GetTransferableNodes，指定节点类型和个数，获取可进行数据迁移的节点。
	ValidateTransferableNodes	调用ValidateTransferableNodes，校验是否可以迁移指定实例中某些节点上的数据。
	TransferNode	调用TransferNode，执行数据迁移任务。
	ListDataTasks	调用ListDataTasks，获取数据迁移任务信息。
	GetClusterDataInformation	调用GetClusterDataInformation，获取集群的数据信息。
	DeleteDataTask	调用DeleteDataTask，删除索引迁移任务。
	CancelTask	调用CancelTask，取消数据迁移任务。
实例升降配	GetSuggestShrinkableNodes	调用GetSuggestShrinkableNodes，指定节点类型和数量，获取可缩容的节点。
	ValidateShrinkNodes	调用ValidateShrinkNodes，校验指定实例中的某些节点是否可以缩容。
	ShrinkNode	调用ShrinkNode，执行集群节点缩容操作。
	UpgradeEngineVersion	调用UpgradeEngineVersion，升级Elasticsearch的实例版本或内核补丁版本。升级实例版本功能仅支持将6.3版本的实例升级至6.7版本。
	UpdateInstance	调用UpdateInstance，变更集群配置（升配或降配）。
集群配置	UpdateInstanceSettings	调用UpdateInstanceSettings，更新指定实例的YML参数配置。
	UpdateHotIkDicts	调用UpdateHotIkDicts，更新阿里云Elasticsearch实例的IK热词词典。
	UpdateSynonymsDicts	调用UpdateSynonymsDicts，更新阿里云Elasticsearch实例的同义词词典。
	UpdateDict	调用UpdateDict，更新Elasticsearch实例的用户词典。
	UpdateAliwsDict	调用UpdateAliwsDict，更新AliNLP分词插件（analysis-aliws）的词典文件。支持自定义词库配置。
	UpdateAdvancedSetting	调用UpdateAdvancedSetting，更改指定实例的垃圾回收器配置。
	插件管理	ListPlugins	调用ListPlugins，获取指定阿里云Elasticsearch实例的插件列表。
		InstallSystemPlugin	调用InstallSystemPlugin，安装系统预置插件。
		UninstallPlugin	调用UninstallPlugin，卸载已安装的预置插件。
	日志查询	ListSearchLog	调用ListSearchLog，查看实例日志。
安全配置	TriggerNetwork	调用TriggerNetwork，开启或关闭Elasticsearch、Kibana的公网或私网访问。
	UpdatePrivateNetworkWhiteIps	调用UpdatePrivateNetworkWhiteIps，更新指定实例的VPC私网访问白名单。
	UpdatePublicWhiteIps	调用UpdatePublicWhiteIps，更新指定实例的公网地址访问白名单。
	UpdatePublicNetwork	调用UpdatePublicNetwork，开启或关闭指定实例的公网地址。
	UpdateWhiteIps	调用UpdateWhiteIps，更新Elasticsearch实例的VPC私网访问白名单。
	ModifyWhiteIps	调用ModifyWhiteIps，更新指定实例的访问白名单。
	UpdateAdminPassword	调用UpdateAdminPassword，更新指定实例的elastic账号的密码。
	OpenHttps	调用OpenHttps，开启HTTPS协议。开启前请确保您已购买协调节点。
	CloseHttps	调用CloseHttps，关闭HTTPS协议。
	AddConnectableCluster	调用AddConnectableCluster，配置实例网络互通。
	DeleteConnectedCluster	调用DeleteConnectedCluster，移除互通实例。
	DescribeConnectableClusters	调用DescribeConnectableClusters，获取能够与当前实例进行网络互通的实例列表。不包括已经打通的实例。
	ListConnectedClusters	调用ListConnectedClusters，获取已经与当前实例进行了网络互通的实例列表。
数据备份	CreateSnapshot	调用CreateSnapshot，手动对集群进行快照备份。
	DescribeSnapshotSetting	调用DescribeSnapshotSetting，获取集群的数据备份配置。
	UpdateSnapshotSetting	调用UpdateSnapshotSetting，更新指定实例的数据备份配置。
	ListSnapshotReposByInstanceId	调用ListSnapshotReposByInstanceId，获取当前实例的跨集群OSS仓库设置列表。
	ListAlternativeSnapshotRepos	调用ListAlternativeSnapshotRepos，获取当前实例可添加的OSS引用仓库。
	AddSnapshotRepo	调用AddSnapshotRepo，在设置跨集群OSS仓库时，创建引用仓库。
	DeleteSnapshotRepo	调用DeleteSnapRepo，删除一个跨集群OSS引用仓库。
智能运维	OpenDiagnosis	调用OpenDiagnosis，打开实例的智能运维功能。
	CloseDiagnosis	调用CloseDiagnosis，关闭实例的智能运维功能。
	DiagnoseInstance	调用DiagnoseInstance，即刻诊断实例。
	ListDiagnoseReport	调用ListDiagnoseReport，获取智能运维的历史报告。
	ListDiagnoseReportIds	调用ListDiagnoseReportIds，获取智能运维历史报告的ID。
	ListDiagnoseIndices	调用ListDiagnoseIndices，获取指定实例智能运维模块中，健康诊断的诊断索引。
	DescribeDiagnoseReport	调用DescribeDiagnoseReport，查看智能运维的历史报告。
	DescribeDiagnosisSettings	调用DescribeDiagnosisSettings，获取智能运维的场景设置。
	UpdateDiagnosisSettings	调用UpdateDiagnosisSettings，更新实例的智能运维场景设置。

Kibana


API	描述
DescribeKibanaSettings	调用DescribeKibanaSettings，获取Kibana配置。
UpdateKibanaSettings	调用UpdateKibanaSettings，修改Kibana配置。目前仅支持修改Kibana语言配置。
ListKibanaPlugins	调用ListKibanaPlugins，获取Kibana插件列表。
InstallKibanaSystemPlugin	调用InstallKibanaSystemPlugin，安装Kibana预置插件。要求Kibana的规格为2核4G及以上。
UninstallKibanaPlugin	调用UninstallKibanaPlugin，卸载Kibana插件。

Logstash


类别	API	描述
实例管理	CreateLogstash	调用CreateLogstash，创建一个Logstash实例。
	ListLogstash	调用ListLogstash，在列表中展示所有或指定Logstash实例的详细信息。
	DescribeLogstash	调用DescribeLogstash，查询指定实例的详细信息。
	UpdateLogstash	调用UpdateLogstash，修改指定实例的部分信息，例如节点数、配额、名称、硬盘大小等。
	RenewLogstash	调用RenewLogstash，为实例续费。
	RestartLogstash	调用RestartLogstash，重启指定实例。重启后，实例会进入生效中（activating）状态。
	UpdateLogstashDescription	调用UpdateLogstashDescription，修改指定Logstash实例的名称。
	UpdateLogstashChargeType	调用UpdateLogstashChargeType，将按量付费的阿里云Logstash实例转换为包年包月实例。
	EstimatedLogstashRestartTime	调用EstimatedLogstashRestartTime，获取Logstash实例重启的预估时间。
	DeleteLogstash	调用DeleteLogstash，释放指定实例。
	CancelLogstashDeletion	调用CancelLogstashDeletion，恢复释放后被冻结的Logstash实例。
集群配置	UpdateLogstashSettings	调用UpdateLogstashSettings，更新指定Logstash实例的配置。
	ListExtendfiles	调用ListExtendfiles，获取Logstash实例的扩展文件配置。
	UpdateExtendfiles	调用UpdateExtendfiles，更新Logstash实例的扩展文件配置。
集群监控	ListAvailableEsInstanceIds	调用ListAvailableEsInstanceIds，在设置Logstash实例的X-Pack监控时，获取可用的Elasticsearch实例列表（具备X-Pack监控能力）。
	ValidateConnection	调用ValidateConnection，在Logstash实例的监控报警配置中，验证提供X-Pack监控的Elasticsearch实例的联通性。
	UpdateXpackMonitorConfig	调用UpdateXpackMonitorConfig，更新Logstash实例的X-Pack监控报警配置。
	DescribeXpackMonitorConfig	调用DescribeXpackMonitorConfig，获取Logstash实例的X-Pack监控配置。
插件管理	ListLogstashPlugins	调用ListLogstashPlugins，获取所有或指定插件的详细信息。
	InstallLogstashSystemPlugin	调用InstallLogstashSystemPlugin，安装插件。
	UninstallLogstashPlugin	调用UninstallLogstashPlugin，卸载已安装的插件。
日志查询	ListLogstashLog	调用ListLogstashLog，查看Logstash实例的日志。
变更任务管理	InterruptLogstashTask	调用InterruptLogstashTask，中断实例变更任务。中断后，实例会进入中断中（suspended）状态。
变更任务管理	ResumeLogstashTask	调用ResumeLogstashTask，恢复实例的变更中断任务。恢复后实例会进入生效中（activating）状态。
管道管理	CreatePipelines	调用CreatePipelines，创建Logstash管道。
	ListPipeline	调用ListPipeline，获取Logstash实例的管道列表。
	DescribePipeline	调用DescribePipeline，获取Logstash实例的管道信息。
	UpdatePipelines	调用UpdatePipelines，更新Logstash管道信息。
	RunPipelines	调用RunPipelines，立即部署Logstash管道。
	StopPipelines	调用StopPipelines，停止运行Logstash管道。
	UpdatePipelineManagementConfig	调用UpdatePipelineManagementConfig，更新Logstash管道管理方式。
	DescribePipelineManagementConfig	调用DescribePipelineManagementConfig，获取Logstash管道管理配置。
	DeletePipelines	调用DeletePipelines，删除指定的Logstash管道。

Beats


API	描述
CreateCollector	调用CreateCollector，创建采集器。
DescribeCollector	调用DescribeCollector，获取采集器实例的详细信息。
ReinstallCollector	调用ReinstallCollector，重试安装在创建时没有安装成功的采集器。
ListCollectors	调用ListCollectors，获取采集器列表信息。
ListDefaultCollectorConfigurations	调用ListDefaultCollectorConfigurations，获取采集器的默认配置文件。
UpdateCollectorName	调用UpdateCollectorName，修改采集器名称。
UpdateCollector	调用UpdateCollector，更新采集器实例信息。
StartCollector	调用StartCollector，启动采集器。
RestartCollector	调用RestartCollector，重启采集器。
StopCollector	调用StopCollector，停止运行中的采集器。
DeleteCollector	调用DeleteCollector，删除采集器。
ListEcsInstances	调用ListEcsInstances，获取ECS机器列表。
ModifyDeployMachine	调用ModifyDeployMachine，更新采集器安装的ECS机器。
ListNodes	调用ListNodes，查看安装采集器的ECS机器的状态。
ListAckClusters	调用ListAckClusters，获取容器服务Kubernetes版ACK（Container Service for Kubernetes）集群列表。
ListAckNamespaces	调用ListAckNamespaces，查看指定容器服务Kubernetes版ACK集群的所有命名空间。
DescribeAckOperator	调用DescribeAckOperator，查看指定容器服务Kubernetes版ACK集群上安装的Elasticsearch Operator信息。
InstallAckOperator	调用InstallAckOperator，在指定容器服务Kubernetes版ACK集群上安装Elasticsearch Operator。

访问控制


API	描述
InitializeOperationRole	调用InitializeOperationRole，创建服务关联角色。
ValidateSlrPermission	调用ValidateSlrPermission，验证是否已经创建服务关联角色。