GUI de ferramentas de desenvolvimento - : Central de Documentação do Alibaba Cloud

Lindorm Search Engine oferece uma interface gráfica do usuário (GUI) para envio de requisições de API RESTful ao Lindorm Search Engine. Este tópico descreve como usar o console do Lindorm para fazer login na UI e executar requisições de leitura e escrita.

Pré-requisitos

O tipo de serviço da sua instância deve ser Lindorm V1 ou Lindorm. Para verificar o tipo de serviço, consulte Visualizar a série do produto.
O LindormSearch deve estar ativado. Para mais informações, consulte Guia de ativação.
O endereço IP do seu cliente deve estar na lista de permissões do Lindorm. Para mais informações, consulte Configurar uma lista de permissões.

Importante
Se o seu cliente usar IPv6 por padrão, desative-o. Caso contrário, a verificação da lista de permissões falhará.

Procedimento

Fazer login na GUI

Faça login no console do Lindorm.
No canto superior esquerdo da página, selecione a região onde sua instância está localizada.
Na página Instances, clique em ID da instância desejada ou em View Instance Details na coluna Actions.
No painel de navegação à esquerda, clique em Search Engine.
Na seção UI Access, clique em Internet ou VPC para acessar o sistema de gerenciamento do cluster.
Na página de login, insira o Default Username e a Default Initial Password exibidos na seção UI Access.
Nota
- No primeiro acesso à UI, o carregamento dos recursos da página pode levar alguns instantes.
- No primeiro login, use obrigatoriamente o Default Username e a Default Initial Password para entrar na Search UI. Nos acessos seguintes, utilize outros usuários criados pelo usuário padrão para fazer login na Cluster Management UI .

Operações de leitura e escrita

Importante

A sintaxe das operações de leitura e escrita é compatível com a API 7.x do Elasticsearch (ES).

Ferramentas de desenvolvimento

Clique em ícone no canto superior esquerdo para abrir a barra lateral e, em seguida, clique em Management > Dev Tools.
Em Dev Tools, envie requisições de API RESTful para o Lindorm Search.

Visualizar todos os índices criados

Use a API cat para visualizar informações básicas sobre todos os índices no LindormSearch.

Adicione o parâmetro v ao caminho da requisição para exibir os cabeçalhos das colunas na resposta.

GET /_cat/indices?v

Resposta retornada:

health status index     uuid      pri rep docs.count docs.deleted store.size pri.store.size
green  open   test2     test2       2   0          0            0       416b           416b
green  open   test3     test3       2   0          1            0     16.8kb         16.8kb
green  open   test1     test1       1   0          0            0       208b           208b
green  open   .kibana_1 .kibana_1   1   0          1            0      5.1kb          5.1kb

Criar um índice

Use a API Create index para adicionar um novo índice.

No corpo da requisição, especifique as configurações **settings e os mapeamentos mappings** do índice.

**settings**: Definem a configuração do índice. Por exemplo, você pode especificar o número de shards (index.number_of_shards) e o intervalo de atualização (index.refresh_interval), que corresponde ao tempo máximo entre a indexação de um documento e o momento em que ele se torna pesquisável.

**mappings**: Representam o esquema do índice. Permitem definir os campos e seus respectivos tipos de dados.

PUT /test
{
  "settings": {
    "index.number_of_shards": 2,
    "index.refresh_interval": "10s"
  },
  "mappings": {
    "properties": {
      "firstName": {
        "type": "keyword"
      },
      "lastName": {
        "type": "keyword"
      }
    }
  }
}

Resposta retornada:

{
  "acknowledged": true,
  "shards_acknowledged": true,
  "index": "test"
}

Visualizar um índice específico

Use a API Get index para visualizar as configurações **settings e os mapeamentos mappings** de um índice.

GET /test

Resposta retornada:

{
  "test": {
    "aliases": {},
    "mappings": {
      "properties": {
        "firstName": {
          "type": "keyword"
        },
        "lastName": {
          "type": "keyword"
        }
      }
    },
    "settings": {
      "index": {
        "search": {
          "slowlog": {
            "level": "DEBUG",
            "threshold": {
              "fetch": {
                "warn": "1s",
                "trace": "200ms",
                "debug": "500ms",
                "info": "800ms"
              },
              "query": {
                "warn": "10s",
                "trace": "500ms",
                "debug": "1s",
                "info": "5s"
              }
            }
          }
        },
        "refresh_interval": "10s",
        "indexing": {
          "slowlog": {
            "level": "DEBUG",
            "threshold": {
              "index": {
                "warn": "10s",
                "trace": "500ms",
                "debug": "2s",
                "info": "5s"
              }
            }
          }
        },
        "number_of_shards": "2",
        "provided_name": "test4",
        "creation_date": "1722418296110",
        "number_of_replicas": "0",
        "uuid": "test4",
        "version": {
          "created": "136287927"
        }
      }
    }
  }
}

Para visualizar apenas as configurações **settings ou os mapeamentos mappings**, use a API Get index settings ou a API Get mapping.

O exemplo abaixo demonstra como recuperar as configurações **settings** de um índice.

GET /test/_settings

Resposta retornada:

{
  "test": {
    "settings": {
      "index": {
        "search": {
          "slowlog": {
            "level": "DEBUG",
            "threshold": {
              "fetch": {
                "warn": "1s",
                "trace": "200ms",
                "debug": "500ms",
                "info": "800ms"
              },
              "query": {
                "warn": "10s",
                "trace": "500ms",
                "debug": "1s",
                "info": "5s"
              }
            }
          }
        },
        "refresh_interval": "10s",
        "indexing": {
          "slowlog": {
            "level": "DEBUG",
            "threshold": {
              "index": {
                "warn": "10s",
                "trace": "500ms",
                "debug": "2s",
                "info": "5s"
              }
            }
          }
        },
        "number_of_shards": "2",
        "provided_name": "test4",
        "creation_date": "1722418296110",
        "number_of_replicas": "0",
        "uuid": "test4",
        "version": {
          "created": "136287927"
        }
      }
    }
  }
}

Atualizar configurações do índice

Use a API Update index settings para modificar as configurações dinâmicas de um índice.

O exemplo a seguir altera a configuração index.refresh_interval para 1s. Isso ajusta o tempo entre a indexação de um documento e sua disponibilidade para pesquisa para 1 segundo. O intervalo mínimo permitido é de 1 segundo.

PUT /test/_settings
{
  "index": {
    "refresh_interval": "1s"
  }
}

Resposta retornada:

{
  "acknowledged": true
}

Gravar dados em um índice

Use a API Index para adicionar ou atualizar documentos em um índice.

Ao utilizar o método PUT, especifique explicitamente um **id. Se o id** informado já existir no índice, o novo documento substituirá o existente.

O exemplo abaixo define o **id** como 1:

PUT /test/_doc/1
{
  "firstName": "John",
  "lastName": "Smith"
}

Resposta retornada:

{
  "_index": "test",
  "_type": "_doc",
  "_id": "1",
  "_version": 1,
  "result": "created",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 0,
  "_primary_term": 1
}

Ao utilizar o método POST, você pode omitir o campo **id. O LindormSearch gera automaticamente um id** para o documento.

POST /test/_doc
{
  "firstName": "Frank",
  "lastName": "Brown"
}

Resposta retornada:

{
  "_index": "test",
  "_type": "_doc",
  "_id": "b_MsCJEB3g4To6JSOeF6",
  "_version": 1,
  "result": "created",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 0,
  "_primary_term": 1
}

O LindormSearch gerou automaticamente o **id** b_MsCJEB3g4To6JSOeF6 para o documento.

Use a API Update para modificar campos específicos de um documento existente. Inclua o **id** do documento no caminho da requisição e adicione o objeto doc no corpo da requisição.

O exemplo a seguir atualiza o campo **firstName** para Lane no documento com **id** 1:
```
POST /test/_update/1
{
  "doc": {
    "firstName": "Lane"
  }
}
```
Resposta retornada:
```
{
  "_index": "test",
  "_type": "_doc",
  "_id": "1",
  "_version": 2,
  "result": "updated",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 1,
  "_primary_term": 1
}
```

Consultar dados em um índice

Use a API Search para consultar dados em um índice, definindo os critérios de busca no corpo da requisição.

O exemplo abaixo busca documentos cujo campo **lastName** seja Smith:

GET /test/_search
{
  "query": {
    "match": {
      "lastName": "Smith"
    }
  }
}

Resposta retornada:

{
  "took": 4,
  "timed_out": false,
  "_shards": {
    "total": 2,
    "successful": 2,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 1,
      "relation": "eq"
    },
    "max_score": 0.18232156,
    "hits": [
      {
        "_index": "test",
        "_id": "1",
        "_score": 0.18232156,
        "_source": {
          "firstName": "Lane",
          "lastName": "Smith"
        }
      }
    ]
  }
}

Use a API Get para recuperar um documento pelo seu **id**.

O exemplo a seguir recupera o documento com **id** 1:

GET /test/_doc/1

Resposta retornada:

{
  "_index": "test",
  "_id": "1",
  "_version": 2,
  "_seq_no": 1,
  "_primary_term": 1,
  "found": true,
  "_source": {
    "firstName": "Lane",
    "lastName": "Smith"
  }
}

Excluir dados de um índice

A API Delete remove um documento de um índice com base no seu **id**.

O exemplo a seguir exclui o documento com **id** 1:

DELETE /test/_doc/1

Resposta retornada:

{
  "_index": "test",
  "_type": "_doc",
  "_id": "1",
  "_version": 3,
  "result": "deleted",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 2,
  "_primary_term": 1
}

Na resposta, o campo "successful": 1 indica que o documento foi excluído com sucesso.