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

Nota

Para ativar o monitoramento X-Pack no Logstash, configure uma instância Elasticsearch. Após a configuração, monitore a instância Logstash no Kibana da instância Elasticsearch correspondente.

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 gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação não possui cabeçalhos específicos e utiliza apenas os cabeçalhos comuns. Para mais informações, consulte a documentação dos parâmetros de requisição comuns.

Sintaxe da requisição

POST /openapi/logstashes/{InstanceId}/validate-connection HTTP/1.1

Parâmetros da requisição

Parâmetro	Tipo	Posição	Obrigatório	Exemplo	Descrição
InstanceId	String	Path	Sim	ls-cn-oew1qbgl****	O ID do cluster Logstash.
ClientToken	String	Query	Não	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Garante a idempotência da requisição. Use o cliente para gerar o token e assegure que ele seja único entre diferentes requisições. O token aceita apenas caracteres ASCII e tem limite de 64 caracteres.
	String	Body	Não	{ "endpoints": [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "xxxx" }	Informações sobre a instância Elasticsearch à qual se conectar.

RequestBody

Configure os seguintes parâmetros no corpo da requisição para especificar as informações do cluster Elasticsearch associado.

Nota

As instâncias Logstash e Elasticsearch devem atender aos requisitos de compatibilidade. Para mais informações, consulte

Compatibilidade de produtos

.

Cabeçalho	Tipo	Obrigatório	Exemplo	Descrição
endpoints	List<String\>	Sim	["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]	Endereço de acesso da instância Elasticsearch com X-Pack a ser monitorada.
userName	String	Sim	elastic	Nome de usuário para acessar o cluster Elasticsearch.
password	String	Sim	xxx	Senha para acessar o cluster Elasticsearch.

Veja o exemplo de código abaixo.

{
    "endpoints": [
        "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
    ],
    "userName": "elastic",
    "password": "xxxx"
}

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

Result

Boolean

true

Indica se a conectividade está normal. Valores válidos:

true
false

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

ID da requisição.

Exemplos

Exemplos de requisições

POST /openapi/logstashes/ls-cn-oew1qbgl****/validate-connection HTTP/1.1
Common request headers
{
    "endpoints": [
        "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
    ],
    "userName": "elastic",
    "password": "xxxx"
}

Exemplos de respostas de sucesso

Formato JSON

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

{
  "Result" : true,
  "RequestId" : "D5B41051-FE06-4986-9D87-3779E627****"
}

Códigos de erro

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