Todos os produtos
Search

Este produto

    Elasticsearch:ListCollectors

    Central de documentação

    Elasticsearch:ListCollectors

    Última atualização: Jun 27, 2026

    Consulta uma lista de coletores.

    Depuração

    O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que gera dinamicamente códigos de exemplo para diferentes SDKs.

    Cabeçalho da requisição

    Esta operação utiliza apenas cabeçalhos de requisição comuns. Para mais informações, consulte Parâmetros comuns de requisição.

    Estrutura da requisição

    
     GET /openapi/collectors HTTP/1.1

    Parâmetros da requisição

    Parâmetro Tipo Posição Obrigatório Exemplo Descrição
    resId String Query Não ct-cn-77uqof2s7rg5c****

    ID do coletor.

    name String Query Não collectorName1

    Nome do coletor.

    instanceId String Query Não es-cn-nif1q8auz0003****

    ID da instância associada ao coletor.

    page Integer Query Não 1

    Número da página a retornar. Valor padrão: 1. Valores válidos: 1 a 200.

    size Integer Query Não 10

    Número de entradas por página. Valor padrão: 20. Valores válidos: 1 a 500.

    sourceType String Query Não ECS

    Tipo de máquina onde o coletor está implantado. Se este parâmetro estiver vazio, todos os tipos serão retornados. Valores válidos:

    • ECS: instâncias ECS
    • ACK: cluster ACK

    Parâmetros de resposta

    Parâmetro Tipo Exemplo Descrição
    Headers Struct

    Cabeçalho da resposta.

    X-Total-Count Integer 5

    Número total de entradas retornadas.

    RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

    ID da requisição.

    Result Array of Result

    Resultados retornados.

    collectorPaths List ["/var/log"]

    Caminhos de coleta do Filebeat.

    configs Array of configs

    Arquivos de configuração do coletor.

    content String - key: log\n title: Log file content\n description: >\n Contains log file lines.\n ....

    Conteúdo do arquivo de configuração.

    fileName String fields.yml

    Nome do arquivo de configuração.

    dryRun Boolean false

    Indica se o coletor foi criado em modo de simulação (dry-run). Valores válidos:

    • true: valida apenas, sem criar o coletor
    • false: valida e cria o coletor
    extendConfigs Array of extendConfigs

    Parâmetros estendidos.

    configType String collectorDeployMachine

    Tipo de configuração. Valores válidos:

    • collectorTargetInstance: instância de destino de saída do coletor
    • collectorDeployMachine: máquina de implantação do coletor
    • collectorElasticsearchForKibana: instância Elasticsearch que oferece suporte a painéis do Kibana
    enableMonitoring Boolean true

    Indica se o monitoramento está ativado. Retornado quando configType é collectorTargetInstance e instanceType é elasticsearch. Valores válidos:

    • true
    • false
    groupId String default_ct-cn-5i2l75bz4776****

    ID do grupo de máquinas. Retornado quando configType é collectorDeployMachine.

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

    Endpoint interno do Kibana. Retornado quando configType é collectorElasticsearchForKibana.

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

    Endereços de acesso da instância de destino de saída. Retornado quando configType é collectorTargetInstance.

    instanceId String es-cn-nif1z89fz003i****

    ID da instância associada ao coletor. Quando configType é collectorTargetInstance, este é o ID da instância de destino de saída. Quando configType é collectorDeployMachines e type é ACKCluster, este é o ID do cluster ACK.

    instanceType String elasticsearch

    Tipo da instância de destino de saída. Valores válidos: Elasticsearch e logstash. Retornado quando configType é collectorTargetInstance.

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

    Endpoint público do Kibana. Retornado quando configType é collectorElasticsearchForKibana.

    machines Array of machines

    Instâncias ECS onde o coletor está implantado. Retornado quando configType é collectorDeployMachines e type é ECSInstanceId.

    agentStatus String heartOk

    Status do coletor em cada instância ECS. Valores válidos:

    • heartOk: normal
    • heartLost: heartbeat perdido
    • uninstalled: não instalado
    • failed: falha na instalação
    instanceId String i-bp13y63575oypr9d****

    ID da instância ECS.

    protocol String HTTP

    Protocolo de transmissão, que deve corresponder ao protocolo de acesso da instância de destino de saída. Valores válidos: HTTP e HTTPS. Retornado quando configType é collectorTargetInstance.

    successPodsCount String 8

    Número de pods nos quais o coletor foi implantado com sucesso. Retornado quando configType é collectorDeployMachines e type é ACKCluster.

    totalPodsCount String 10

    Número total de pods no cluster ACK. Retornado quando configType é collectorDeployMachines e type é ACKCluster.

    type String ECSInstanceId

    Tipo de máquina de implantação. Retornado quando configType é collectorDeployMachine. Valores válidos:

    • ECSInstanceId: instância ECS
    • ACKCluster: cluster ACK
    userName String elastic

    Nome de usuário usado para acessar a instância de destino de saída. Valor padrão: elastic. Retornado quando configType é collectorTargetInstance ou collectorElasticsearchForKibana.

    gmtCreatedTime String 2020-08-18T02:06:12.000+0000

    Horário de criação do coletor.

    gmtUpdateTime String 2020-08-18T09:40:43.000+0000

    Horário da última atualização do coletor.

    name String FileBeat001

    Nome do coletor.

    ownerId String 168520994880****

    ID da conta Alibaba Cloud.

    resId String ct-cn-0v3xj86085dvq****

    ID do coletor.

    resType String fileBeat

    Tipo do coletor. Valores válidos: fileBeat, metricBeat, heartBeat e auditBeat.

    resVersion String 6.8.5_with_community

    Versão do coletor.

    status String active

    Status do coletor. Valores válidos:

    • activating: entrando em vigor
    • active: em vigor
    vpcId String vpc-bp16k1dvzxtma*****

    ID da VPC onde o coletor reside.

    extendConfigs possui três valores de configType: collectorTargetInstance, collectorElasticsearchForKibana e collectorDeployMachine. Os parâmetros retornados variam conforme o tipo de máquina de implantação. As combinações específicas são as seguintes:

    • 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

    Exemplos

    Exemplos de requisições

    
     GET /openapi/collectors?resId=ct-cn-77uqof2s7rg5c ****&page=1&size=10&sourceType=ECS HTTP/1.1 public request header

    Exemplos de respostas de sucesso

    Formato 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": "Name of index management policy 1" }, { "fileName": "Name of Index Management Policy 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 } }

    Códigos de erro

    Para obter uma lista de códigos de erro, visite a Central de Erros de API.