全部產品
Search

搜尋本產品

    Elasticsearch：ListCollectors

    文件中心

    Elasticsearch：ListCollectors

    更新時間：Jan 16, 2025

    調用ListCollectors，擷取採集器列表資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    要求標頭

    該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

    請求文法

    GET /openapi/collectors HTTP/1.1

    請求參數

    名稱 類型 位置 是否必選 樣本值 描述
    resId String Query 否 ct-cn-77uqof2s7rg5c****

    採集器ID。
    name String Query 否 collectorName1

    採集器名稱。
    instanceId String Query 否 es-cn-nif1q8auz0003****

    採集器關聯的執行個體ID。
    page Integer Query 否 1

    返回結果的分頁數。預設值：1，最小值：1，最大值：200。
    size Integer Query 否 10

    每頁的結果數。預設值：20，最小值：1，最大值：500。
    sourceType String Query 否 ECS

    指定採集器部署機器的類型，不填返回全部類型。可選值：

    • ECS：ECS執行個體
    • ACK：容器Kubernetes叢集

    返回資料

    名稱 類型 樣本值 描述
    Headers Struct

    返回頭資訊。
    X-Total-Count Integer 5

    返回的記錄數。
    RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

    請求ID。
    Result Array of Result

    返回結果。
    collectorPaths List ["/var/log"]

    Filebeat的採集路徑。
    configs Array of configs

    採集器的設定檔資訊。
    content String - key: log\n title: Log file content\n description: >\n Contains log file lines.\n ....

    檔案內容。
    fileName String fields.yml

    檔案名稱。
    dryRun Boolean false

    是否校正並建立採集器。支援：

    • true：只校正不建立
    • false：校正並建立
    extendConfigs Array of extendConfigs

    擴充參數資訊。
    configType String collectorDeployMachine

    配置類型。支援：

    • collectorTargetInstance：採集器Output
    • collectorDeployMachine：採集器的部署機器
    • collectorElasticsearchForKibana：支援Kibana儀錶盤的Elasticsearch執行個體資訊
    enableMonitoring Boolean true

    是否啟用Monitoring，當configType為collectorTargetInstance，且instanceType為elasticsearch時顯示。支援：

    • true：啟用
    • false：不啟用
    groupId String default_ct-cn-5i2l75bz4776****

    機器組ID。當configType為collectorDeployMachine時顯示。
    host String es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601

    啟用Kibana Dashboard後，Kibana的私網訪問地址。當configType為collectorElasticsearchForKibana時顯示。
    hosts List ["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]

    採集器Output指定執行個體的訪問地址清單。當configType為collectorTargetInstance時顯示。
    instanceId String es-cn-nif1z89fz003i****

    採集器關聯的執行個體ID。當configType為collectorTargetInstance時，為採集器Output的執行個體ID；當configType為collectorDeployMachines，且type為ACKCluster時，為ACK（容器Kubernetes）叢集ID。
    instanceType String elasticsearch

    採集器Output指定的執行個體類型。支援elasticsearch、logstash。當configType為collectorTargetInstance時顯示。
    kibanaHost String https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601

    啟用Kibana Dashboard後，Kibana的公網訪問地址。當configType為collectorElasticsearchForKibana時顯示。
    machines Array of machines

    採集器所部署的ECS機器列表資訊。當configType為collectorDeployMachines，且type為ECSInstanceId時顯示。
    agentStatus String heartOk

    ECS上各採集器的狀態。支援：

    • heartOk：心跳正常
    • heartLost：心跳異常
    • uninstalled：未安裝
    • failed：安裝失敗
    instanceId String i-bp13y63575oypr9d****

    ECS機器ID列表。
    protocol String HTTP

    傳輸協議，需要與採集器Output指定執行個體的訪問協議保持一致。支援HTTP、HTTPS。當configType為collectorTargetInstance時顯示。
    successPodsCount String 8

    ACK叢集所有成功採集的Pod節點數。當configType為collectorDeployMachines，且type為ACKCluster時顯示。
    totalPodsCount String 10

    ACK叢集所有採集的Pod節點數。當configType為collectorDeployMachines，且type為ACKCluster時顯示。
    type String ECSInstanceId

    採集器部署的機器類型，當configType為collectorDeployMachine時顯示。支援：

    • ECSInstanceId：ECS
    • ACKCluster：容器Kubernetes
    userName String elastic

    採集器Output指定執行個體的訪問使用者名稱，預設為elastic。當configType為collectorTargetInstance或collectorElasticsearchForKibana時顯示。
    gmtCreatedTime String 2020-08-18T02:06:12.000+0000

    採集器建立時間。
    gmtUpdateTime String 2020-08-18T09:40:43.000+0000

    採集器更新時間。
    name String FileBeat001

    採集器名稱。
    ownerId String 168520994880****

    帳號ID。
    resId String ct-cn-0v3xj86085dvq****

    採集器執行個體ID。
    resType String fileBeat

    採集器類型。支援fileBeat、metricBeat、heartBeat和auditBeat。
    resVersion String 6.8.5_with_community

    採集器版本。
    status String active

    採集器狀態。支援：

    • activing：生效中
    • active：已生效
    vpcId String vpc-bp16k1dvzxtma*****

    採集器所在的專用網路ID。

    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

    樣本

    請求樣本

    GET /openapi/collectors?resId=ct-cn-77uqof2s7rg5c****&page=1&size=10&sourceType=ECS HTTP/1.1
公用要求標頭

    正常返回樣本

    JSON格式

    {
  "Result": [
    {
      "gmtCreatedTime": "2020-11-05T12:42:47.000+0000",
      "gmtUpdateTime": "2020-11-06T06:06:20.000+0000",
      "name": "fileBeatOnACK",
      "resId": "ct-cn-6fy17c8z99c7i****",
      "resVersion": "6.8.5_with_community",
      "vpcId": "vpc-bp16k1dvzxtmagcva****",
      "resType": "fileBeat",
      "ownerId": "168520994880****",
      "configs": [
        {
          "fileName": "logCollector.yml"
        },
        {
          "fileName": "索引管理原則1的名稱"
        },
        {
          "fileName": "索引管理原則2的名稱"
        }
      ],
      "status": "active",
      "extendConfigs": [
        {
          "configType": "collectorTargetInstance",
          "instanceId": "es-cn-n6w1o1x0w001c****",
          "instanceType": "elasticsearch",
          "hosts": [
            "es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
          ],
          "protocol": "HTTP",
          "userName": "elastic",
          "enableMonitoring": false
        },
        {
          "configType": "collectorDeployMachine",
          "type": "ACKCluster",
          "instanceId": "c1b9fde5172b84f82b9928e825a7b****"
        },
        {
          "configType": "collectorElasticsearchForKibana",
          "instanceId": "es-cn-n6w1o1x0w001c****",
          "host": "es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601",
          "protocol": "HTTPS",
          "kibanaHost": "https://es-cn-n6w1o1x0w001c****.kibana.elasticsearch.aliyuncs.com:5601",
          "userName": "elastic"
        }
      ],
      "dryRun": false
    },
    {
      "gmtCreatedTime": "2020-09-25T10:27:02.000+0000",
      "gmtUpdateTime": "2020-09-25T10:27:02.000+0000",
      "name": "fileBeatOnECS",
      "resId": "ct-cn-6cro0lb0dn66c****",
      "resVersion": "6.8.5_with_community",
      "vpcId": "vpc-bp12nu14urf0upaf4****",
      "resType": "fileBeat",
      "ownerId": "168520994880****",
      "collectorPaths": [
        "/var/log/"
      ],
      "configs": [
        {
          "fileName": "fields.yml"
        },
        {
          "fileName": "filebeat.yml"
        }
      ],
      "status": "active",
      "extendConfigs": [
        {
          "configType": "collectorTargetInstance",
          "instanceId": "ls-cn-v0h1kzca****",
          "instanceType": "logstash",
          "hosts": [
            "10.7.xx.xx:8007"
          ],
          "protocol": "HTTP",
          "enableMonitoring": false
        },
        {
          "configType": "collectorDeployMachine",
          "type": "ECSInstanceId",
          "machines": [
            {
              "instanceId": "i-bp13y63575oypr9d****",
              "agentStatus": "heartOk"
            }
          ],
          "groupId": "default_ct-cn-6cro0lb0dn66c****"
        }
      ],
      "dryRun": false
    }
  ],
  "RequestId": "70338AB9-231F-412B-A8C0-239CD32F****",
  "Headers": {
    "X-Total-Count": 2
  }
}

    錯誤碼

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