Antarmuka pengguna visual -

Lindorm Search Engine menyediakan antarmuka pengguna visual yang memungkinkan Anda mengakses mesin pencarian Lindorm melalui RESTful API. Topik ini menjelaskan cara login ke antarmuka pengguna (UI) konsol Lindorm serta menjalankan operasi baca dan tulis.

Prasyarat

Tipe layanan instans harus berupa Lindorm atau Lindorm_V2. Untuk informasi selengkapnya tentang cara melihat tipe layanan, lihat Lihat seri produk.
Mesin pencarian Lindorm telah diaktifkan. Untuk informasi selengkapnya, lihat Panduan Aktivasi.
Alamat IP klien Anda harus ditambahkan ke daftar putih Lindorm. Untuk informasi selengkapnya, lihat Konfigurasi daftar putih.
Penting
Jika klien Anda menggunakan protokol IPv6 secara default, Anda harus menonaktifkannya. Jika tidak, otentikasi daftar putih akan gagal.

Prosedur

Login ke UI

Login ke konsol Lindorm.
Di pojok kiri atas halaman, pilih wilayah tempat instans Anda berada.
Pada halaman Instances, klik ID instans target atau, pada kolom Actions, klik View Instance Details.
Di panel navigasi sebelah kiri, klik Search Engine.
Pada bagian UI Access, klik Internet atau VPC untuk masuk ke UI.
Pada halaman login, masukkan Default Username dan Default Initial Password dari bagian UI Access.
Catatan
- Pertama kali mengakses UI, Anda mungkin perlu menunggu hingga sumber daya halaman dimuat.
- Untuk login pertama kali, gunakan Default Username dan Default Initial Password untuk login ke UI pencarian. Untuk login berikutnya, gunakan akun pengguna lain yang dibuat oleh pengguna default.

Operasi baca dan tulis

Penting

Sintaks untuk operasi baca dan tulis kompatibel dengan Elasticsearch (ES) API 7.x.

Buka Dev Tools

Klik ikon di pojok kiri atas UI untuk membuka sidebar, lalu klik Management > Dev Tools.
Di Dev Tools, Anda dapat mengakses mesin pencarian Lindorm melalui RESTful API.

Lihat semua indeks yang telah dibuat

Anda dapat menggunakan cat API untuk melihat informasi dasar semua indeks yang telah dibuat di mesin pencarian.

Tambahkan parameter v ke path untuk menampilkan nama kolom di bagian atas.

GET /_cat/indices?v

Nilai kembali:

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

Buat indeks

Anda dapat menggunakan Create index API untuk membuat indeks.

Pada badan permintaan, Anda dapat menentukan settings dan mappings untuk indeks tersebut.

settings: Menentukan konfigurasi indeks, seperti jumlah shard (`index.number_of_shards`) dan interval refresh (`index.refresh_interval`).

mappings: Menentukan struktur indeks, seperti bidang dalam indeks dan tipe data setiap bidang.

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

Nilai kembali:

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

Lihat informasi tentang indeks tertentu

Anda dapat menggunakan Get index API untuk melihat informasi tentang indeks tertentu, termasuk settings dan mappings-nya.

GET /test

Nilai kembali:

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

Untuk melihat hanya settings atau mappings, Anda dapat menggunakan Get index settings API atau Get mapping API.

Contoh berikut menunjukkan cara mendapatkan settings.

GET /test/_settings

Nilai kembali:

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

Perbarui konfigurasi indeks

Anda dapat menggunakan Update index settings API untuk memperbarui item konfigurasi indeks yang dapat dimodifikasi secara dinamis.

Contoh berikut mengubah pengaturan index.refresh_interval menjadi 1 detik. Hal ini mengatur interval antara penulisan data dan saat data menjadi terlihat menjadi 1 detik. Interval minimum adalah 1 detik.

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

Nilai kembali:

{
  "acknowledged": true
}

Tulis data ke indeks

Anda dapat menggunakan Index API untuk menulis data ke indeks.

Jika Anda menggunakan metode PUT, Anda harus menentukan id. Jika dokumen dengan id yang ditentukan sudah ada, dokumen yang ada akan ditimpa.

Contoh berikut menentukan id sebesar 1:

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

Nilai kembali:

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

Jika Anda menggunakan metode POST, Anda tidak perlu menentukan id. Mesin pencarian Lindorm secara otomatis menghasilkan id untuk data tersebut.

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

Nilai kembali:

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

Mesin pencarian Lindorm secara otomatis menghasilkan id untuk data tersebut: b_MsCJEB3g4To6JSOeF6.

Gunakan Update API untuk memperbarui bidang tertentu dari data yang sudah ada. Sertakan id dokumen dalam parameter path dan parameter doc dalam badan permintaan.

Contoh berikut menetapkan id menjadi 1 dan memperbarui firstName menjadi Lane:

POST /test/_update/1
{
  "doc": {
    "firstName": "Lane"
  }
}

Nilai kembali:

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

Lihat data indeks

Anda dapat menggunakan Search API untuk melihat data dalam indeks. Anda dapat menentukan kondisi kueri dalam badan permintaan.

Contoh berikut menentukan lastName sebesar Smith:

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

Nilai kembali:

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

Anda dapat menggunakan Get API untuk melihat data dengan id tertentu.

Contoh berikut menentukan id sebesar 1:

GET /test/_doc/1

Nilai kembali:

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

Hapus data indeks

Anda dapat menggunakan Delete API untuk menghapus data dengan id tertentu dari indeks.

Contoh berikut menentukan id sebesar 1:

DELETE /test/_doc/1

Nilai kembali:

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

Nilai kembali successful sebesar 1 menunjukkan bahwa data yang ditentukan berhasil dihapus.