Interfaz gráfica de herramientas de desarrollo - - Centro de documentación de Alibaba Cloud

Lindorm Search Engine ofrece una interfaz gráfica de usuario (GUI) que permite enviar solicitudes de API RESTful para acceder a Lindorm Search Engine. Este tema describe cómo utilizar la consola de Lindorm para iniciar sesión en la interfaz y ejecutar solicitudes de lectura y escritura.

Requisitos previos

El tipo de servicio de su instancia es Lindorm V1 o Lindorm. Para obtener información sobre cómo consultar el tipo de servicio, consulte View the product series.
LindormSearch está activado. Para más información, consulte Activation guide.
La dirección IP de su cliente se encuentra en la lista de permitidos de Lindorm. Para más información, consulte Configure a whitelist.

Importante
Si su cliente utiliza IPv6 de forma predeterminada, deshabilítelo. De lo contrario, la verificación de la lista de permitidos fallará.

Procedimiento

Iniciar sesión en la GUI

Log on to the Lindorm console.
In the upper-left corner of the page, select the region where your instance is located.
On the Instances page, click the ID of the target instance or click View Instance Details in the Actions column.
In the left-side navigation pane, click Search Engine.
In the UI Access section, click Internet or VPC to log on to the cluster management system.
En la página de inicio de sesión, introduzca el Default Username y la Default Initial Password que se muestran en la sección UI Access section.
Nota
- La primera vez que acceda a la interfaz, es posible que los recursos de la página tarden unos momentos en cargar.
- Para su primer inicio de sesión, debe utilizar el Default Username y la Default Initial Password para ingresar a la interfaz de búsqueda. En inicios de sesión posteriores, puede utilizar otros usuarios creados por el usuario predeterminado para acceder a la interfaz de gestión del clúster .

Operaciones de lectura y escritura

Importante

La sintaxis para las operaciones de lectura y escritura es compatible con la API 7.x de Elasticsearch (ES).

Herramientas de desarrollo

Haga clic en el icono en la esquina superior izquierda para abrir la barra lateral y, a continuación, haga clic en Management > Dev Tools.
En Dev Tools, puede enviar solicitudes de API RESTful a Lindorm Search.

Consultar todos los índices creados

Utilice la API cat para consultar información básica sobre todos los índices en LindormSearch.

Agregue el parámetro v a la ruta de la solicitud para mostrar los encabezados de columna en la respuesta.

GET /_cat/indices?v

Se devuelve la siguiente respuesta:

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

Crear un índice

Utilice la API Create index para agregar un nuevo índice.

En el cuerpo de la solicitud, puede especificar los valores de **settings y mappings** para el índice.

**settings**: La configuración del índice. Por ejemplo, puede especificar el número de shards (index.number_of_shards) y el intervalo de actualización (index.refresh_interval), que corresponde al tiempo máximo transcurrido desde que se indexa un documento hasta que está disponible para búsquedas.

**mappings**: El esquema del índice. Por ejemplo, puede definir los campos y sus tipos de datos.

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

Se devuelve la siguiente respuesta:

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

Consultar un índice específico

Utilice la API Get index para consultar los valores de **settings y mappings** de un índice.

GET /test

Se devuelve la siguiente respuesta:

{
  "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 consultar únicamente los valores de **settings o mappings**, puede utilizar la API Get index settings o la API Get mapping.

El siguiente ejemplo muestra cómo recuperar los valores de **settings** de un índice.

GET /test/_settings

Se devuelve la siguiente respuesta:

{
  "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"
        }
      }
    }
  }
}

Actualizar la configuración del índice

Utilice la API Update index settings para actualizar la configuración dinámica de un índice.

El siguiente ejemplo muestra cómo cambiar la configuración index.refresh_interval a 1s. Esto ajusta a 1 segundo el tiempo transcurrido desde que se indexa un documento hasta que está disponible para búsquedas. El intervalo mínimo es de 1 segundo.

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

Se devuelve la siguiente respuesta:

{
  "acknowledged": true
}

Escribir datos en un índice

Utilice la API Index para agregar o actualizar documentos en un índice.

Cuando utiliza el método PUT, debe especificar explícitamente un **id. Si el id** especificado ya existe en el índice, el nuevo documento sobrescribe al existente.

El siguiente ejemplo establece el **id** en 1:

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

Se devuelve la siguiente respuesta:

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

Cuando utiliza el método POST, puede omitir el **id. LindormSearch genera automáticamente un id** para el documento.

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

Se devuelve la siguiente respuesta:

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

LindormSearch genera automáticamente el **id** b_MsCJEB3g4To6JSOeF6 para el documento.

Utilice la API Update para actualizar campos específicos de un documento existente. El **id** del documento debe incluirse en la ruta de la solicitud, y el cuerpo de la solicitud debe contener el objeto doc.

El siguiente ejemplo actualiza el campo **firstName** a Lane para el documento con el **id** 1:
```
POST /test/_update/1
{
  "doc": {
    "firstName": "Lane"
  }
}
```
Se devuelve la siguiente respuesta:
```
{
  "_index": "test",
  "_type": "_doc",
  "_id": "1",
  "_version": 2,
  "result": "updated",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 1,
  "_primary_term": 1
}
```

Consultar datos en un índice

Utilice la API Search para consultar datos en un índice mediante la especificación de los criterios de búsqueda en el cuerpo de la solicitud.

El siguiente ejemplo busca documentos donde el valor de **lastName** es Smith:

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

Se devuelve la siguiente respuesta:

{
  "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"
        }
      }
    ]
  }
}

Utilice la API Get para recuperar un documento por su **id**.

El siguiente ejemplo recupera el documento con el **id** 1:

GET /test/_doc/1

Se devuelve la siguiente respuesta:

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

Eliminar datos de un índice

La API Delete elimina un documento de un índice según su **id**.

El siguiente ejemplo elimina el documento con el **id** 1:

DELETE /test/_doc/1

Se devuelve la siguiente respuesta:

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

En la respuesta, "successful": 1 indica que el documento se eliminó correctamente.