調(diào)用CreateCollector，創(chuàng)建采集器。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數(shù)文檔。

請求語法

POST /openapi/collectors HTTP/1.1

請求參數(shù)

名稱 類型 位置 是否必選 示例值 描述
clientToken String Query 否 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保證請求的冪等性。由客戶端生成該參數(shù)值，要保證在不同請求間唯一，最大不超過64個ASCII字符。
Object Body 否

請求體參數(shù)。用來指定待創(chuàng)建采集器的配置信息。
dryRun Boolean Body 是 true

是否校驗(yàn)并創(chuàng)建采集器，只有在創(chuàng)建或更新采集器時使用此參數(shù)。可選值：

  • true：只校驗(yàn)不更新
  • false：校驗(yàn)并更新
name String Body 是 ct-test

采集器名稱。長度為1~30個字符，以大小寫字母開頭，可以包含字母、數(shù)字、下劃線（_）或連字符（-）。
resType String Body 是 fileBeat

采集器類型。可選值：fileBeat、metricBeat、heartBeat和auditBeat。
vpcId String Body 是 vpc-bp12nu14urf0upaf*****

采集器所在的專有網(wǎng)絡(luò)ID。
resVersion String Body 是 6.8.5_with_community

采集器版本。可選值：

  • 基于ECS部署：6.8.5_with_community
  • 基于ACK部署：6.8.13_with_community
collectorPaths Array of String Body 否 ["/var/log"]

fileBeat采集路徑。僅當(dāng)采集器的安裝機(jī)器為ECS時，需要配置。
configs Array Body 是

采集器的配置文件信息。
fileName String Body 是 filebeat.yml

文件名。
content String Body 是 "filebeat.inputs:xxx"

文件內(nèi)容。
extendConfigs Array of Object Body 是 { "instanceId": "es-cn-nif201ihd0012****", "instanceType": "elasticsearch", "configType": "collectorTargetInstance", "hosts": [ "es-cn-nif201ihd0012****.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "*****", "protocol": "HTTP" }, { "type": "ECSInstanceId", "configType": "collectorDeployMachine", "machines": [ { "instanceId": "i-bp11u91xgubypcuz****" } ] } ]

采集器擴(kuò)展配置，詳情請參見下文的extendConfigs參數(shù)說明章節(jié)。

extendConfigs參數(shù)說明

extendConfigs中的參數(shù)含義如下。

名稱

類型

是否必選

示例值

描述

extendConfigs

Array

采集器擴(kuò)展配置。

└configType

String

是

collectorElasticsearchForKibana

配置類型。可選值：collectorTargetInstance（采集器Output）、collectorDeployMachine（采集器的部署機(jī)器）、collectorElasticsearchForKibana（支持Kibana儀表盤的Elasticsearch實(shí)例信息）。

└type

String

否

ECSInstanceId

采集器部署的機(jī)器類型。可選值：ECSInstanceId（ECS）、ACKCluster（容器Kubernetes）。當(dāng)configType為collectorDeployMachine時必填。

└instanceType

String

否

elasticsearch

采集器Output指定的實(shí)例類型。可選值：elasticsearch、logstash。當(dāng)configType為collectorTargetInstance時必填。

└instanceId

String

是

es-cn-nif201ihd0012****

采集器關(guān)聯(lián)的實(shí)例ID。當(dāng)configType為collectorTargetInstance時，為采集器Output的實(shí)例ID；當(dāng)configType為collectorDeployMachines，且type為ACKCluster時，為ACK集群ID。

└machines

Array

否

采集器所部署的ECS機(jī)器列表信息。當(dāng)configType為collectorDeployMachines，且type為ECSInstanceId時，必填。

└└instanceId

String

是

i-bp11u91xgubypcuz****

ECS機(jī)器ID列表。

└groupId

String

default_ct-cn-5i2l75bz4776****

機(jī)器組ID。當(dāng)configType為collectorDeployMachine時，必填。

└protocol

String

否

HTTP

傳輸協(xié)議，需要與采集器Output指定實(shí)例的訪問協(xié)議保持一致。可選值：HTTP、HTTPS。當(dāng)configType為collectorTargetInstance時必填。

└userName

String

否

elastic

采集器Output指定實(shí)例的訪問用戶名，默認(rèn)為elastic。當(dāng)configType為collectorTargetInstance或collectorElasticsearchForKibana時必填。

└password

String

否

*****

對應(yīng)用戶名的密碼。

└enableMonitoring

Boolean

否

true

是否啟用Monitoring，當(dāng)configType為collectorTargetInstance，且instanceType為elasticsearch時必填。可選值：true（啟用）、false（不啟用）。

└hosts

List<String>

否

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

采集器Output指定實(shí)例的訪問地址列表。當(dāng)configType為collectorTargetInstance時必填。

└host

String

否

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

啟用Kibana Dashboard后，Kibana的私網(wǎng)訪問地址。當(dāng)configType為collectorElasticsearchForKibana時必填。

└kibanaHost

String

否

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

啟用Kibana Dashboard后，Kibana的公網(wǎng)訪問地址。當(dāng)configType為collectorElasticsearchForKibana時必填。

說明 └表示子參數(shù)。

extendConfigs中包括3種configType，分別為collectorTargetInstance、collectorElasticsearchForKibana、collectorDeployMachine，部署機(jī)器不同，需要配置的參數(shù)不同，具體組合方式如下：

  • 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

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
RequestId String 8466BDFB-C513-4B8D-B4E3-5AB256AB****

請求ID。
Result Object

返回結(jié)果。
resId String ct-cn-4135is2tj194p****

創(chuàng)建成功的采集器ID。

示例

請求示例

POST /openapi/collectors?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
    "dryRun": false, 
    "name": "test_beats_1", 
    "resType": "fileBeat", 
    "resVersion": "6.8.5_with_community", 
    "vpcId": "vpc-bp12nu14urf0upaf*****", 
    "collectorPaths": [
        "/var/log"
    ], 
    "extendConfigs": [
        {
            "instanceId": "es-cn-nif201ihd0012****", 
            "instanceType": "elasticsearch", 
            "configType": "collectorTargetInstance", 
            "hosts": [
                "es-cn-nif201ihd0012****.elasticsearch.aliyuncs.com:9200"
            ], 
            "userName": "elastic", 
            "password": "*****", 
            "protocol": "HTTP"
        }, 
        {
            "type": "ECSInstanceId", 
            "configType": "collectorDeployMachine", 
            "machines": [
                {
                    "instanceId": "i-bp11u91xgubypcuz****"
                }
            ]
        }
    ], 
    "configs": [
        {
            "fileName": "filebeat.yml", 
            "content": "filebeat.inputs:xxx"
        }, 
        {
            "fileName": "fields.yml", 
            "content": "- key: log\n title: Log file content\n description: >\n Contains log file lines.\n ...."
        }
    ]
}

正常返回示例

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : {
    "resId" : "ct-cn-4135is2tj194p****"
  },
  "RequestId" : "8466BDFB-C513-4B8D-B4E3-5AB256AB****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。