UpdateCollector_Elasticsearch_API文档

RequestBody

RequestBody 中还需填入以下参数，用来指定待更新采集器的配置信息。

参数	类型	是否必选	示例值	描述
dryRun	boolean	是	false	是否校验并更新采集器。可选值：true（只校验不更新）、false（校验并更新）。
name	String	是	ct-test	采集器名称。
status	String	是	activing	采集器状态。可选值：activing（生效中）、active（已生效）。
resType	String	是	fileBeat	采集器类型。可选值：fileBeat、metricBeat、heartBeat、auditBeat。
vpcId	String	是	vpc-bp16k1dvzxtma*****	采集器所在的专有网络 ID。
resVersion	String	是	6.8.5_with_community	采集器版本。
ownerId	String	是	16852099488*****	账号 ID。
gmtCreatedTime	Date	是	2020-06-20T07:26:47.000+0000	采集器创建时间。
gmtUpdateTime	Date	是	2020-06-20T07:26:47.000+0000	采集器更新时间。
collectorPaths	List	否	["/var/log"]	Filebeat 采集路径。
configs	List	是		采集器的配置文件信息。
└fileName	String	是	filebeat.yml	文件名称。
└content	String	是	"filebeat.inputs:xxx"	文件内容。
extendConfigs	Array	是		采集器扩展配置。
└configType	String	是	collectorElasticsearchForKibana	配置类型。可选值：collectorTargetInstance（采集器 Output）、collectorDeployMachine（采集器的部署机器）、collectorElasticsearchForKibana（支持 Kibana 仪表盘的 Elasticsearch 实例信息）。
└type	String	是	ECSInstanceId	采集器部署的机器类型。可选值：ECSInstanceId（ECS）、ACKCluster（容器 Kubernetes）。当 configType 为 collectorDeployMachine 时必填。
└machines	Array	否		采集器所部署的 ECS 机器列表信息。当 configType 为 collectorDeployMachines，且 type 为 ECSInstanceId 时，必填。
└└instanceId	String	否	i-bp13y63575oypr9d****	ECS 机器 ID 列表。
└└agentStatus	String	否	failed	ECS 上各采集器的状态。可选值：heartOk（心跳正常）、heartLost（心跳异常）、uninstalled（未安装）、failed（安装失败）。
└groupId	String		default_ct-cn-5i2l75bz4776****	机器组 ID。当 configType 为 collectorDeployMachine 时，必填。
└instanceId	String	是	es-cn-nif1z89fz003i****	采集器关联的实例 ID。当 configType 为 collectorTargetInstance 时，为采集器 Output 的实例 ID；当 configType 为 collectorDeployMachines，且 type 为 ACKCluster 时，为 ACK 集群 ID。
└protocol	String	是	HTTP	传输协议，需要与采集器 Output 指定实例的访问协议保持一致。可选值 HTTP、HTTPS。当 configType 为 collectorTargetInstance 时必填。
└userName	String	是	elastic	采集器 Output 指定实例的访问用户名，默认为 elastic。当 configType 为 collectorTargetInstance 或 collectorElasticsearchForKibana 时必填。
└enableMonitoring	Boolean	是	true	是否启用 Monitoring，当 configType 为 collectorTargetInstance，且 instanceType 为 elasticsearch 时必填。可选值：true（启用）、false（不启用）。
└hosts	List	否	["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]	采集器 Output 指定实例的访问地址列表。当 configType 为 collectorTargetInstance 时必填。
└instanceType	String	是	elasticsearch	采集器 Output 指定的实例类型。可选值：elasticsearch、logstash。当 configType 为 collectorTargetInstance 时必填。
└host	String	否	es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601	启用 Kibana Dashboard 后，Kibana 的私网访问地址。当 configType 为 collectorElasticsearchForKibana 时必填。
└kibanaHost	String	否	https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601	启用 Kibana Dashboard 后，Kibana 的公网访问地址。当 configType 为 collectorElasticsearchForKibana 时必填。

特殊参数说明

extendConfigs 中包括 3 种 configType，分别为 collectorTargetInstance、collectorElasticsearchForKibana、collectorDeployMachine，部署机器不同，需要配置的参数不同，具体组合方式如下：

• collectorTargetInstance

  • ECS configType、instanceId、instanceType、hosts、userName、password、protocol、enableMonitoring
  • ACK configType、instanceId、instanceType、userName、password、protocol、enableMonitoring

• collectorElasticsearchForKibana

  • ECS configType、instanceId、host、kibanaHost、userName、password、protocol
  • ACK configType

• collectorDeployMachine

  • ECS configType、type、machines、groupId
  • ACK configType、type、instanceId、totalPodsCount、successPodsCount