ListEcsInstances - Elasticsearch: Central de Documentação do Alibaba Cloud

Importante

Para chamar esta operação, crie a Aliyun Elasticsearch AccessingOOSRole e a função de serviço do sistema AliyunOOSAccessingECS 4ESRole. Isso permite que a conta de serviço do Elasticsearch obtenha as permissões de acesso às instâncias ECS da conta principal. Para mais informações, consulte

Coletar logs de serviço ECS

.

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. Para mais informações, consulte Cabeçalhos de requisição comuns.

Sintaxe da requisição

GET /openapi/ecs HTTP/1.1

Parâmetros da requisição

Parâmetro	Tipo	Localização	Obrigatório	Exemplo	Descrição
page	Integer	Query	Não	1	Número de páginas de resultados retornados. Valor máximo: 500.
size	Integer	Query	Não	10	Quantidade de resultados por página. Valor padrão: 10. Valor máximo: 500.
ecsInstanceIds	String	Query	Não	["i-bp13y63575oypr9d**","i-bp1gyhphjaj73jsr**"]	ID da instância ECS N. O valor pode ser um array JSON com até 100 IDs de instância. Separe os IDs das instâncias com vírgulas (,).
ecsInstanceName	String	Query	Não	test	Nome da instância ECS.
tags	String	Query	Não	[{ "tagKey":"a","tagValue":"b"}]	Tags da instância ECS. Devem conter: tagKey: chave da tag tagValue: valor da tag
vpcId	String	Query	Não	vpc-bp16k1dvzxtmagcva****	ID da VPC à qual a instância ECS pertence.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***	ID da requisição.
Headers	Object		Cabeçalho da resposta.
X-Total-Count	Integer	11	Número de registros retornados.
Result	Array of Result		Dados retornados.
cloudAssistantStatus	String	true	Status de instalação do Cloud Assistant. Valores válidos: true: o agente Prometheus foi instalado. false: o agente Prometheus não foi instalado.
ecsInstanceName	String	ecsTestName	Nome da instância ECS.
ecsInstanceId	String	i-bp14ncqge8wy3l3d****	ID da instância ECS.
tags	String	[ { "tagKey": "a", "tagValue": "b" } ]	Tags da instância ECS.
osType	String	linux	Tipo de sistema operacional da instância ECS. Valores válidos: windows: sistema operacional Windows linux: sistema operacional Linux
status	String	running	Status da instância ECS. Valores válidos: running: a instância principal está em execução starting stopping: a tarefa está sendo parada. stopped: o nó está parado.
ipAddress	Array of ipAddress		Endereço IP da instância ECS.
ipType	String	private	Tipo de endereço IP utilizado pela instância. Valores válidos: public: endpoint público private: endereço de rede privada
host	String	172.16.xx.xx	Endereço IP do endpoint.
collectors	Array of collectors		Coletores na instância ECS.
resId	String	ct-cn-0v3xj86085dvq****	ID da instância do coletor.
gmtUpdateTime	String	2020-06-20T07:26:47.000+0000	Hora da última atualização do coletor.
dryRun	Boolean	false	Indica se deve verifique e crie um rastreador. Valores válidos: true: apenas verifica, sem criar false: verifica e cria
ownerId	String	16852*488***	ID da conta Alibaba Cloud.
vpcId	String	vpc-bp16k1dvzxtm******	ID da Virtual Private Cloud à qual o coletor pertence.
resType	String	fileBeat	Tipo do coletor. Suporta FileBeat, metricBeat, heartBeat e auditBeat.
resVersion	String	6.8.5_with_community	Versão do coletor. Se o tipo de máquina do coletor for ECS, apenas a versão 6.8.5_with_community é suportada.
gmtCreatedTime	String	2020-06-20T07:26:47.000+0000	Momento em que o coletor de rastreamento foi criado.
status	String	activing	Status do coletor. Valores válidos: activating: o projeto está entrando em vigor. active: a instância entrou em vigor.
name	String	ct-testAbc	Nome do coletor.
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.
fileName	String	fields.yml	Nome do arquivo.
extendConfigs	Array of extendConfigs		Informações estendidas dos parâmetros.
enableMonitoring	Boolean	true	Indica se o Monitoramento está ativado. Este campo aparece quando o configType é collectorTargetInstance e o instanceType é Elasticsearch. Valores válidos: true false
groupId	String	default_ct-cn-5i2l75bz4776****	ID do grupo de hosts. Aparece quando o configType é collectorDeployMachine.
configType	String	collectorDeployMachine	Tipo de configuração. Valores válidos: collectorTargetInstance: Saída do Coletor collectorDeployMachine: Máquina de Implantação do Coletor Collector Elasticsearch ForKibana: Informações da instância Elasticsearch que suporta o painel Kibana
instanceType	String	elasticsearch	Tipo de instância especificado pela Saída do Coletor. Suporta Elasticsearch e Logstash. Aparece quando o configType é collectorTargetInstance.
protocol	String	HTTP	Protocolo de transmissão. Deve corresponder ao protocolo de acesso da instância especificada pela Saída. Valores válidos: HTTP e HTTPS. Aparece quando o configType é collectorTargetInstance.
userName	String	elastic	Nome de usuário para acessar a instância. O valor padrão é elastic. Aparece quando o configType é collectorTargetInstance ou collectorElasticsearchForKibana.
type	String	ECSInstanceId	Tipo de máquina onde o coletor está implantado. Aparece quando o configType é collectorDeployMachine. Valores válidos: ECSInstanceId:ECS ACKCluster: Container Kubernetes
instanceId	String	es-cn-nif1z89fz003i****	ID da instância associada ao coletor. Se o parâmetro configType estiver defina como collectorTargetInstance, o valor será o ID do coletor de saída. Se configType for collectorDeployMachines e type for ACKCluster, o valor corresponderá ao ID do cluster ACK.
machines	Array of machines		Lista de instâncias ECS onde o coletor está implantado. Aparece quando o configType é collectorDeployMachines e o type é ECSInstanceId.
agentStatus	String	heartOk	Status de cada rastreamento na instância ECS. Valores válidos: heartOk: o heartbeat está normal. heartLost: o heartbeat está anormal. uninstalled failed: a instalação falhou.
instanceId	String	i-bp13y63575oypr9d****	IDs das instâncias ECS.
hosts	Array of String	["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]	Endereços de acesso da instância especificada para a saída do coletor. Aparece quando o configType é collectorTargetInstance.
collectorPaths	Array of String	["/var/log"]	Caminho de coleta do Filebeat.

Exemplos

Exemplos de requisições

GET /openapi/ecs?page=1&size=10 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Exemplos de respostas de sucesso

Formato JSON

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

{
  "Result" : [ {
    "ecsInstanceId" : "i-bp1gyhphjaj73jsr****",
    "ecsInstanceName" : "test",
    "status" : "running",
    "ipAddress" : [ {
      "host" : "47.98.xx.xx",
      "ipType" : "public"
    }, {
      "host" : "172.16.xx.xx",
      "ipType" : "private"
    } ],
    "tags" : [ ],
    "collectors" : [ {
      "gmtCreatedTime" : "2020-12-30T08:04:32.000+0000",
      "gmtUpdateTime" : "2020-12-30T08:20:48.000+0000",
      "name" : "uptime-test",
      "resId" : "ct-cn-4135is2tj194p****",
      "resVersion" : "6.8.5_with_community",
      "vpcId" : "vpc-bp16k1dvzxtmagcva****",
      "resType" : "heartBeat",
      "ownerId" : "168520994880****",
      "configs" : [ {
        "fileName" : "fields.yml"
      }, {
        "fileName" : "heartbeat.yml"
      } ],
      "status" : "active",
      "extendConfigs" : [ {
        "configType" : "collectorTargetInstance",
        "instanceId" : "es-cn-n6w1o1x0w001c****",
        "instanceType" : "elasticsearch",
        "hosts" : [ "es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ],
        "protocol" : "HTTP",
        "userName" : "elastic",
        "enableMonitoring" : true
      }, {
        "configType" : "collectorDeployMachine",
        "type" : "ECSInstanceId",
        "machines" : [ {
          "instanceId" : "i-bp1gyhphjaj73jsr****",
          "agentStatus" : "heartOk"
        } ],
        "groupId" : "default_ct-cn-4135is2tj194p****"
      } ],
      "dryRun" : false
    } ],
    "osType" : "linux",
    "cloudAssistantStatus" : "true"
  } ],
  "RequestId" : "58E5DE98-33B0-4D9B-B5F6-E70A77C5933E",
  "Headers" : {
    "X-Total-Count" : 2
  }
}

Códigos de erro

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