CreateCollector_Elasticsearch_API文档-阿里云OpenAPI开发者门户

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

elasticsearch:CreateCollector	Create	全部资源 *	无	无

请求语法

POST /openapi/collectors HTTP/1.1

请求参数

字段名称	字段详情
clientTokenstring	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodyobject	请求体参数。用来指定待创建采集器的配置信息。示例值:{ "dryRun": false, "name": "test_beats_1", "resType": "fileBeat", "resVersion": "6.8.5_with_community", "vpcId": "vpc-bp12nu14urf0upaf*****", "collectorPaths": [ "/var/log" ], "configs": [ { "fileName": "filebeat.yml", "content": "filebeat.inputs:xxx" } ] }

请求说明

extendConfigs 参数说明

extendConfigs 中的参数含义如下。

名称	类型	是否必选	示例值	描述
extendConfigs	Array			采集器扩展配置。
└configType	String	是	collectorElasticsearchForKibana	配置类型。可选值：collectorTargetInstance（采集器 Output）、collectorDeployMachine（采集器的部署机器）、collectorElasticsearchForKibana（支持 Kibana 仪表盘的 Elasticsearch 实例信息）。
└type	String	否	ECSInstanceId	采集器部署的机器类型。可选值：ECSInstanceId（ECS）、ACKCluster（容器 Kubernetes）。当 configType 为 collectorDeployMachine 时必填。
└instanceType	String	否	elasticsearch	采集器 Output 指定的实例类型。可选值：elasticsearch、logstash。当 configType 为 collectorTargetInstance 时必填。
└instanceId	String	是	es-cn-nif201ihd0012****	采集器关联的实例 ID。当 configType 为 collectorTargetInstance 时，为采集器 Output 的实例 ID；当 configType 为 collectorDeployMachines，且 type 为 ACKCluster 时，为 ACK 集群 ID。
└machines	Array	否		采集器所部署的 ECS 机器列表信息。当 configType 为 collectorDeployMachines，且 type 为 ECSInstanceId 时，必填。
└└instanceId	String	是	i-bp11u91xgubypcuz****	ECS 机器 ID 列表。
└groupId	String		default_ct-cn-5i2l75bz4776****	机器组 ID。当 configType 为 collectorDeployMachine 时，必填。
└protocol	String	否	HTTP	传输协议，需要与采集器 Output 指定实例的访问协议保持一致。可选值：HTTP、HTTPS。当 configType 为 collectorTargetInstance 时必填。
└userName	String	否	elastic	采集器 Output 指定实例的访问用户名，默认为 elastic。当 configType 为 collectorTargetInstance 或 collectorElasticsearchForKibana 时必填。
└password	String	否	*****	对应用户名的密码。
└enableMonitoring	Boolean	否	true	是否启用 Monitoring，当 configType 为 collectorTargetInstance，且 instanceType 为 elasticsearch 时必填。可选值：true（启用）、false（不启用）。
└hosts	List	否	["es-cn-nif201i*****.elasticsearch.aliyuncs.com:9200"]	采集器 Output 指定实例的访问地址列表。当 configType 为 collectorTargetInstance 时必填。
└host	String	否	es-cn-nif201ihd0012****-kibana.internal.elasticsearch.aliyuncs.com:5601	启用 Kibana Dashboard 后，Kibana 的私网访问地址。当 configType 为 collectorElasticsearchForKibana 时必填。
└kibanaHost	String	否	https://es-cn-nif201ihd0012****.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

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:8466BDFB-C513-4B8D-B4E3-5AB256AB****
Resultobject	返回结果。

返回示例

变更历史

	变更时间	变更内容概要	操作
	2022-12-28	新增请求参数body

1
2
10 条/页