Elasticsearch：UpdateCollector

dryRun

boolean

Yes

false

Specifies whether to verify and update the collector. Validation values: true (only verified but not updated) and false (verified and updated).

name

String

Yes

ct-test

The name of the collector.

status

String

Yes

activing

The status of the collector. Valid values: activating and active.

resType

String

Yes

fileBeat

The shipper type. Validated values: fileBeat, metricBeat, heartBeat, and auditBeat.

vpcId

String

Yes

vpc-bp16k1dvzxtma*****

The ID of the Virtual Private Cloud to which the collector belongs.

resVersion

String

Yes

6.8.5_with_community

The shipper version.

ownerId

String

Yes

16852099488*****

The account ID.

gmtCreatedTime

Date

Yes

2020-06-20T07:26:47.000+0000

The time when the crawer was created.

gmtUpdateTime

Date

Yes

2020-06-20T07:26:47.000+0000

The time when the collector was updated.

collectorPaths

List<String>

No

["/var/log"]

Filebeat collection path.

configs

List

Yes

The configuration file information of the collector.

└fileName

String

Yes

filebeat.yml

The name of the file.

└content

String

Yes

"filebeat.inputs:xxx"

The content of the file.

extendConfigs

Array

Yes

The extended configuration of the collector.

└configType

String

Yes

collectorElasticsearchForKibana

The configuration type. Valid values: collectorTargetInstance (Collector Output), collectorDeployMachine (Collector Deployment Machine), and collectorElasticsearchForKibana (Elasticsearch Instance Information that Supports Kibana Dashboard).

└type

String

Yes

ECSInstanceId

The type of the machine on which the Collector is deployed. Valid values: ECSInstanceId(ECS) and ACKCluster (Container Kubernetes). This field is required when the configType is set to collectorDeployMachine.

└machines

Array

No

The list of ECS instances where the crawer is deployed. This field is required when the configType is collectorDeployMachines and the type is ECSInstanceId.

└└instanceId

String

No

i-bp13y63575oypr9d****

The IDs of ECS instances.

└└agentStatus

String

No

failed

The status of the shipper on the ECS instance. Valaps: heartOk, heartLost, uninstalled, and failed.

└groupId

String

default_ct-cn-5i2l75bz4776****

The ID of the host group. This field is required when the configType is set to collectorDeployMachine.

└instanceId

String

Yes

es-cn-nif1z89fz003i****

The ID of the instance that is associated with the crawer. If the configType parameter is set to collectorTargetInstance, the value of this parameter is the ID of the output configType. If the value of this parameter is set to collectorDeployMachines and the value of this type is set to ACKCluster, the value of this parameter is the ID of the ACK cluster.

└protocol

String

Yes

HTTP

The transmission protocol, which must be the same as the access protocol of the instance specified by Output. Valic values: HTTP and HTTPS. This field is required when the configType is set to collectorTargetInstance.

└userName

String

Yes

elastic

The username that is used to access the instance. The default value is elastic. This field is required when the configType is set to collectorTargetInstance or collectorElasticsearchForKibana.

└enableMonitoring

Boolean

Yes

true

Whether to enable monitoring. This field is required when the configType is collectorTargetInstance and the instanceType is Elasticsearch. Valic values: true (enabled) and false (disabled).

└hosts

List<String>

No

["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]

The list of access addresses of the specified instance for the output of the collector. This parameter is required when the configType is set to collectorTargetInstance.

└instanceType

String

Yes

elasticsearch

The instance type specified by Collector Output. Valides: Elasticsearch and logstash. This parameter is required when the configType is set to collectorTargetInstance.

└host

String

No

es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601

The private endpoint of Kibana after you enable Kibana Dashboard. This parameter is required when the configType is set to collectorElasticsearchForKibana.

└kibanaHost

String

No

https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601

The public endpoint of Kibana after you enable Kibana Dashboard. This field is required when the configType is set to collectorElasticsearchForKibana.