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

Use a API DescribeXpackMonitorConfig para obter as configurações de monitoramento do X-Pack de uma instância Logstash.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. Use o OpenAPI Explorer para pesquisar operações de API, chamá-las e gerar dinamicamente códigos de exemplo do SDK.

Cabeçalho da requisição

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

Sintaxe da requisição

GET /openapi/logstashes/[InstanceId]/xpack-monitor-config HTTPS|HTTP

Parâmetros da requisição

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
InstanceId	String	Sim	ls-cn-oew1qbgl****	ID da instância Logstash.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	ID da requisição.
Result	Struct		Resultados retornados.
ative	Boolean	true	Indica se o monitoramento do X-Pack está ativado. Valores válidos: true: ativado false: desativado
endpoints	List	["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]	Lista de endereços de acesso do X-Pack para a instância Elasticsearch associada ao monitoramento.
esInstanceId	String	es-cn-n6w1o1x0w001c****	ID da instância X-Pack associada à tarefa de monitoramento do Elasticsearch.
pipelineIds	List	[]	Lista de pipelines do X-Pack gerenciados pela instância Kibana associada para monitoramento.
userName	String	elastic	Nome de usuário do X-Pack usado para acessar a instância Elasticsearch associada à tarefa de monitoramento.

Exemplos

Exemplos de requisição

GET /openapi/logstashes/ls-cn-oew1qbgl****/xpack-monitor-config HTTP/1.1 
common request header

Exemplos de resposta de sucesso

Sintaxe JSON

{
    "Result": {
        "esInstanceId": "es-cn-n6w1o1x0w001c****",
        "endpoints": [
            "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
        ],
        "pipelineIds": [],
        "userName": "elastic",
        "enable": true
    },
    "RequestId": "9EC7377A-60D7-4AB2-ADE3-983E1D0D****"
}

Códigos de erro

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