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

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

/openapi/logstashes

Sintaxe da requisição

GET /openapi/logstashes HTTP/1.1

Parâmetros da requisição

Parâmetro	Tipo	Posição	Obrigatório	Exemplo	Descrição
page	Integer	Query	Não	1	Número da página retornada. Valor padrão: 1.
size	Integer	Query	Não	10	Quantidade de entradas por página. Valor padrão: 20.
description	String	Query	Não	ls-cn-abc	Nome da instância. Especifique uma palavra-chave para corresponder a várias instâncias. Por exemplo, ao consultar uma instância chamada abc, o sistema pode retornar todas as instâncias com nomes abc, abcde, xyabc e xabcy.
instanceId	String	Query	Não	ls-cn-n6w1o5jq****	ID da instância.
version	String	Query	Não	5.5.3_with_X-Pack	Versão da instância.
resourceGroupId	String	Query	Não	rg-acfm2h5vbzd****	ID do grupo de recursos.
tags	String	Query	Não	[{"tagKey":"key1","tagValue":"value1"}]	Tag da instância. Valores válidos:

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	AC442F2F-5068-4434-AA21-E78947A9****	ID da requisição.
Headers	Object		Detalhes do cabeçalho da requisição.
X-Total-Count	Integer	10	Número de entradas retornadas por página.
Result	Array of Instance		Informações detalhadas das instâncias correspondentes.
paymentType	String	postpaid	Método de faturamento da instância. Valores válidos: prepaid (assinatura) e postpaid (pagamento conforme o uso).
nodeAmount	Integer	2	Quantidade de nós de dados.
description	String	ls-cn-abc	Nome da VPC.
createdAt	String	2018-07-13T03:58:07.253Z	Data e hora de criação da instância.
status	String	active	Estado da instância. Valores válidos: Normal, Active, Inactive e Invalid.
updatedAt	String	2018-07-18T10:10:04.484Z	Data e hora da última atualização da instância.
instanceId	String	ls-cn-n6w1o5jq****	ID da instância.
version	String	6.7.0_with_X-Pack	Versão da instância. Atualmente, apenas 6.7.0_with_X-Pack e 7.4.0_with_X-Pack são compatíveis.
Tags	Array of tags		Tag da instância. Valores válidos:
TagValue	String	dev	Valor da tag do disco em nuvem.
TagKey	String	env	Chave da tag do disco em nuvem.
nodeSpec	Object		Configure o nó de dados.
spec	String	logstash.n4.small	Tipo da instância ECS.
disk	Integer	50	Tamanho do disco do nó.
diskEncryption	Boolean	false	Indica se a criptografia de disco está ativada. Valores válidos: true: Ativa a consulta simultânea para consultas não agregadas. false: Desativa a consulta simultânea para consultas não agregadas.
diskType	String	cloud_ssd	Tipo do disco.
networkConfig	Object		Configurações de rede.
vpcId	String	vpc-abc	ID da VPC.
vsArea	String	cn-hangzhou-*	Zona onde o cluster reside.
type	String	vpc	Tipo de rede. Atualmente, apenas Virtual Private Cloud (VPC) é compatível.
vswitchId	String	vsw-def	ID do vSwitch.

Os dados retornados também incluem os seguintes parâmetros.

Parâmetro	Tipo	Exemplo	Descrição
enablePublic	Boolean	false	Indica se o acesso à internet está ativado. Valor padrão: false.
commodityCode	String	elasticsearch_logstash_post	Código do serviço.
endTime	Long	4749897600000	Data de expiração da instância por assinatura.
clusterTasks	Array	[]	Lista de tarefas da instância.
resourceGroupId	String	rg-acfm2h5vbzd****	ID do grupo de recursos ao qual a instância pertence.
zoneCount	Integer	1	Número de zonas onde o cluster Elasticsearch está implantado.
protocol	String	HTTP	Protocolo de acesso da instância.
zoneInfos	Array		Informações sobre as zonas.
└zoneId	String	cn-hangzhou-i	ID da zona do cluster.
└status	String	NORMAL	Status da zona. Valores válidos: ISOLATION (offline) e NORMAL (normal).
instanceType	String	logstash	Edição da instância.
inited	Boolean	true	Indica se a instância foi inicializada.
config	Array	[]	Configure instâncias ECS.
endpointList	Array		Informações do nó.
└host	String	172.16.xx.xx	Endereço IP do nó.
└port	Integer	9200	Porta de acesso do nó.
└zoneId	String	cn-hangzhou-i	ID da zona do nó.

Nota

└ indica um parâmetro filho.

Exemplos

Exemplos de requisições

GET /openapi/logstashes?page=1&size=10&description=ls-cn-abc&instanceId=ls-cn-n6w1o5jq****&version=5.5.3_with_X-Pack&resourceGroupId=rg-acfm2h5vbzd****&tags=[{"tagKey":"key1","tagValue":"value1"}] 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" : [ {
    "instanceId" : "ls-cn-n6w1o5jq****",
    "version" : "6.7.0_with_X-Pack",
    "description" : "test",
    "nodeAmount" : 1,
    "paymentType" : "postpaid",
    "status" : "active",
    "enablePublic" : false,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 20,
      "diskType" : "cloud_ssd"
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp16k1dvzxtmagcva****",
      "vswitchId" : "vsw-bp1k4ec6s7sjdbudw****",
      "vsArea" : "cn-hangzhou-i",
      "type" : "vpc"
    },
    "createdAt" : "2020-05-27T01:30:15.947Z",
    "updatedAt" : "2020-05-27T01:40:51.333Z",
    "commodityCode" : "elasticsearch_logstash_post",
    "extendConfigs" : [ ],
    "endTime" : 4746268800000,
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfm2h5vbzd****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-i",
      "status" : "NORMAL"
    } ],
    "instanceType" : "logstash",
    "inited" : true,
    "tags" : [ ],
    "config" : { },
    "endpointList" : [ {
      "host" : "172.16.**.**",
      "port" : 9600,
      "zoneId" : "cn-hangzhou-i"
    } ]
  } ],
  "RequestId" : "918C05D8-4689-4A79-B6D5-D2500991****",
  "Headers" : {
    "X-Total-Count" : 1
  }
}

Códigos de erro

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