Todos os produtos
Search
Central de documentação

Elasticsearch:UpdateCollector

Última atualização: Jun 27, 2026

Modifica as configurações de um coletor.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação utiliza apenas cabeçalhos de requisição comuns.

Sintaxe da requisição

PUT /openapi/collectors/{ResId} HTTP/1.1

Parâmetros da requisição

Parâmetro

Tipo

Posição

Obrigatório

Exemplo

Descrição

ResId

String

Path

Sim

ct-cn-77uqof2s7rg5c****

ID do coletor.

ClientToken

String

Query

Não

5A2CFF0E-5718-45B5-9D4D-70B3FF****

Token de idempotência gerado pelo cliente. Deve ser único entre requisições. Aceita apenas caracteres ASCII, com até 64 caracteres.

String

Body

Não

{ "dryRun": false, "name": "fileBeat", "resVersion": "6.8.5_with_community", "extendConfigs": [ { "instanceId": "es-cn-sfd", "configType": "collectorElasticsearchForKibana", "hosts": [ "es-cn-abc.elasticsearch.aliyuncs.com:9200", "es-cn-abd.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "", "protocol": "https" }, { "instanceId": "ec-cn-targ", "instanceType": "elasticsearch", "configType": "collectorTargetInstance", "hosts": [ "es-cn-abc.elasticsearch.aliyuncs.com:9200", "es-cn-abd.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "", "protocol": "https" }, { "values": [ { "instanceId": "id1" }, { "instanceId": "id2" } ], "type": "ECSInstanceId", "configType": "collectorDeployMachine" } ], "resType": "fileBeat", "vpcId": "vpc-cn-abc", "configs": [ { "fileName": "filebeat.yml", "content": "filebeat.inputs:xxx" } ] }

Configurações atualizadas do coletor.

RequestBody

O RequestBody contém os seguintes parâmetros para configuração do coletor.

**

Campo

**

**

Tipo

**

**

Obrigatório

**

**

Exemplo

**

**

Descrição

**

dryRun

boolean

Sim

false

Define se deve executar uma simulação. Valores válidos: true (apenas validar) e false (validar e atualizar).

name

String

Sim

ct-test

Nome do coletor.

status

String

Sim

activing

Status do coletor. Valores válidos: activating e active.

resType

String

Sim

fileBeat

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

vpcId

String

Sim

vpc-bp16k1dvzxtma*

ID da VPC do coletor.

resVersion

String

Sim

6.8.5_with_community

Versão do coletor.

ownerId

String

Sim

16852099488*

ID da conta.

gmtCreatedTime

Date

Sim

2020-06-20T07:26:47.000+0000

Horário de criação do coletor.

gmtUpdateTime

Date

Sim

2020-06-20T07:26:47.000+0000

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

collectorPaths

List<String>

Não

["/var/log"]

Caminhos de coleta do Filebeat.

configs

List

Sim

Arquivos de configuração do coletor.

└fileName

String

Sim

filebeat.yml

Nome do arquivo.

└content

String

Sim

"filebeat.inputs:xxx"

Conteúdo do arquivo.

extendConfigs

Array

Sim

Configurações estendidas do coletor.

└configType

String

Sim

collectorElasticsearchForKibana

Tipo de configuração. Valores válidos: collectorTargetInstance (saída do coletor), collectorDeployMachine (máquina de implantação do coletor) e collectorElasticsearchForKibana (instância Elasticsearch compatível com Kibana Dashboard).

└type

String

Sim

ECSInstanceId

Tipo da máquina onde o coletor está implantado. Valores válidos: ECSInstanceId (ecs) e ACKCluster (Container Service for Kubernetes). Obrigatório quando configType é collectorDeployMachine.

└machines

Array

Não

Instâncias ecs onde o coletor está implantado. Obrigatório quando configType é collectorDeployMachines e type é ECSInstanceId.

└└instanceId

String

Não

i-bp13y63575oypr9d****

ID da instância ecs.

└└agentStatus

String

Não

failed

Status do coletor na instância ecs. Valores válidos: heartOk, heartLost, uninstalled e failed.

└groupId

String

default_ct-cn-5i2l75bz4776****

ID do grupo de máquinas. Obrigatório quando configType é collectorDeployMachine.

└instanceId

String

Sim

es-cn-nif1z89fz003i****

ID da instância associada. Se configType for collectorTargetInstance, este é o ID da instância de saída. Se configType for collectorDeployMachines e type for ACKCluster, este é o ID do cluster ACK.

└protocol

String

Sim

HTTP

Protocolo de transmissão. Deve corresponder ao protocolo de acesso da instância de saída. Valores válidos: http e https. Obrigatório quando configType é collectorTargetInstance.

└userName

String

Sim

elastic

Nome de usuário para acessar a instância. Valor padrão: elastic. Obrigatório quando configType é collectorTargetInstance ou collectorElasticsearchForKibana.

└enableMonitoring

Boolean

Sim

true

Define se o monitoramento deve ser ativado. Valores válidos: true e false. Obrigatório quando configType é collectorTargetInstance e instanceType é Elasticsearch.

└hosts

List<String>

Não

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

Endereços de acesso da instância de saída. Obrigatório quando configType é collectorTargetInstance.

└instanceType

String

Sim

elasticsearch

Tipo da instância de saída. Valores válidos: elasticsearch e logstash. Obrigatório quando configType é collectorTargetInstance.

└host

String

Não

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

Endpoint privado do Kibana. Obrigatório quando configType é collectorElasticsearchForKibana.

└kibanaHost

String

Não

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

Endpoint público do Kibana. Obrigatório quando configType é collectorElasticsearchForKibana.

Nota

└ indica um parâmetro filho.

Combinações do parâmetro extendConfigs

O parâmetro extendConfigs inclui três configTypes. Os parâmetros obrigatórios variam conforme o tipo de máquina de implantação:

  • 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 e protocol

    • ACK

      configType

  • collectorDeployMachine

    • ecs

      configType, type, machines e groupId

    • ACK

      configType, type, instanceId, totalPodsCount e successPodsCount

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

ID da requisição.

Result Object

Resultado retornado.

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

ID do coletor.

gmtUpdateTime String 2020-06-20T07:26:47.000+0000

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

dryRun Boolean false

Define se deve verificar e atualizar o coletor. Valores válidos:

  • true: apenas verifica, sem atualizar os dados.
  • false: verifica e atualiza os dados.
ownerId String 16852099488*****

ID da conta.

vpcId String vpc-bp16k1dvzxtma*****

ID da VPC 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.

gmtCreatedTime String 2020-06-20T07:26:47.000+0000

Horário de criação do coletor.

status String active

Status do coletor. Valores válidos:

  • activating: O coletor está sendo ativado.
  • active: O coletor está ativo.
name String ct-test

Nome do coletor.

configs Array of configs

Arquivos de configuração do coletor.

content String filebeat.inputs:xxx

Conteúdo do arquivo.

fileName String filebeat.yml

Nome do arquivo.

extendConfigs Array of extendConfigs

Configurações estendidas.

successPodsCount String 8

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

protocol String HTTP

Protocolo de transmissão. Valores válidos: http e https. Retornado quando configType é collectorTargetInstance.

userName String elastic

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

totalPodsCount String 10

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

type String ECSInstanceId

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

  • ECSInstanceId: ecs
  • ACKCluster: Container Service for Kubernetes
kibanaHost String https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601

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

enableMonitoring Boolean true

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

configType String collectorDeployMachine

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

  • collectorTargetInstance: saída do coletor
  • collectorDeployMachine: máquina de implantação do coletor
  • collectorElasticsearchForKibana: instância Elasticsearch compatível com Kibana Dashboard
instanceType String elasticsearch

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

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 privado do Kibana. Retornado quando configType é collectorElasticsearchForKibana.

instanceId String es-cn-nif1z89fz003i****

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

machines Array of machines

Máquinas de implantação.

Instâncias ecs ou clusters ACK onde o coletor está implantado.

agentStatus String heartOk

Status do coletor na instância ecs. Valores válidos:

  • heartOk: Heartbeat normal.
  • heartLost: Heartbeat anormal.
  • uninstalled: Coletor não instalado.
  • failed: Falha na instalação do coletor.
instanceId String i-bp13y63575oypr9d****

ID da instância ecs.

hosts Array of String ["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]

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

collectorPaths Array of String ["/var/log"]

Caminhos de coleta do Filebeat.

Exemplos

Exemplos de requisição

PUT /openapi/collectors/ct-cn-77uqof2s7rg5c**** HTTP/1.1
Common request headers

{
    "dryRun": false, 
    "name": "fileBeat", 
    "resVersion": "6.8.5_with_community", 
    "extendConfigs": [
        {
            "instanceId": "es-cn-sfd", 
            "configType": "collectorElasticsearchForKibana", 
            "hosts": [
                "es-cn-abc.elasticsearch.aliyuncs.com:9200", 
                "es-cn-abd.elasticsearch.aliyuncs.com:9200"
            ], 
            "userName": "elastic", 
            "password": "******", 
            "protocol": "https"
        }, 
        {
            "instanceId": "ec-cn-targ", 
            "instanceType": "elasticsearch", 
            "configType": "collectorTargetInstance", 
            "hosts": [
                "es-cn-abc.elasticsearch.aliyuncs.com:9200", 
                "es-cn-abd.elasticsearch.aliyuncs.com:9200"
            ], 
            "userName": "elastic", 
            "password": "******", 
            "protocol": "https"
        }, 
        {
            "values": [
                {
                    "instanceId": "id1"
                }, 
                {
                    "instanceId": "id2"
                }
            ], 
            "type": "ECSInstanceId", 
            "configType": "collectorDeployMachine"
        }
    ], 
    "resType": "fileBeat", 
    "vpcId": "vpc-cn-abc", 
    "configs": [
        {
            "fileName": "filebeat.yml", 
            "content": "filebeat.inputs:xxx"
        }
    ]
}

Exemplos de resposta de sucesso

Formato JSON

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

{
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***",
  "Result" : {
    "configs" : {
      "fileName" : "filebeat.yml",
      "content" : "filebeat.inputs:xxx"
    },
    "dryRun" : false,
    "resType" : "fileBeat",
    "ownerId" : "16852099488*****",
    "resId" : "ct-cn-0v3xj86085dvq****",
    "collectorPaths" : [ "/var/log" ],
    "gmtUpdateTime" : "2020-06-20T07:26:47.000+0000",
    "extendConfigs" : [ {
      "enableMonitoring" : true,
      "groupId" : "default_ct-cn-5i2l75bz4776****",
      "instanceType" : "elasticsearch",
      "type" : "ECSInstanceId",
      "userName" : "elastic",
      "configType" : "collectorDeployMachine",
      "protocol" : "HTTP",
      "instanceId" : "es-cn-nif1z89fz003i****",
      "host" : "es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601",
      "kibanaHost" : "https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601",
      "totalPodsCount" : 10,
      "successPodsCount" : 8
    }, {
      "machines" : {
        "agentStatus" : "heartOk",
        "instanceId" : "i-bp13y63575oypr9d****"
      }
    }, {
      "hosts" : [ "es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200" ]
    } ],
    "resVersion" : "6.8.5_with_community",
    "vpcId" : "vpc-bp16k1dvzxtma*****",
    "name" : "ct-test",
    "gmtCreatedTime" : "2020-06-20T07:26:47.000+0000",
    "status" : "active"
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.