調用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
  }
}

錯誤碼

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