Dev tools GUI - - Alibaba Cloud Documentation Center

Lindorm Search Engine menyediakan antarmuka pengguna grafis (GUI) yang dapat digunakan untuk mengirim permintaan RESTful API guna mengakses Lindorm Search Engine. Topik ini menjelaskan cara menggunakan Lindorm console untuk login ke UI serta menjalankan permintaan baca dan tulis.

Prasyarat

Tipe layanan instans Anda adalah Lindorm V1 atau Lindorm. Untuk mengetahui cara melihat tipe layanan, lihat Lihat seri produk.
LindormSearch telah diaktifkan. Untuk informasi selengkapnya, lihat Panduan aktivasi.
Alamat IP klien Anda berada dalam daftar putih Lindorm. Untuk informasi selengkapnya, lihat Konfigurasi daftar putih.
Penting
Jika klien Anda menggunakan IPv6 secara default, nonaktifkan fitur tersebut. Jika tidak, verifikasi daftar putih akan gagal.

Prosedur

Login ke GUI

Login ke Lindorm console.
Di pojok kiri atas halaman, pilih wilayah tempat instans Anda berada.
Pada halaman Instances, klik ID instans target atau klik View Instance Details pada kolom Actions.
Di panel navigasi sebelah kiri, klik Search Engine.
Pada bagian UI Access, klik Internet atau VPC untuk login ke sistem manajemen kluster.
Pada halaman login, masukkan Default Username dan Default Initial Password yang ditampilkan pada bagian UI Access.
Catatan
- Saat pertama kali mengakses UI, mungkin diperlukan beberapa saat agar sumber daya halaman selesai dimuat.
- Untuk login pertama kali, Anda harus menggunakan Default Username dan Default Initial Password untuk login ke Search UI. Untuk login berikutnya, Anda dapat menggunakan pengguna lain yang dibuat oleh pengguna default untuk login ke Cluster Management UI.

Operasi baca dan tulis

Penting

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

Dev Tools

Klik ikon di pojok kiri atas untuk membuka sidebar, lalu klik Management > Dev Tools.
Di Dev Tools, Anda dapat mengirim permintaan RESTful API ke LindormSearch.

Lihat semua indeks yang telah dibuat

Gunakan cat API untuk melihat informasi dasar semua indeks di LindormSearch.

Tambahkan parameter v ke path permintaan untuk menampilkan header kolom dalam respons.

GET /_cat/indices?v

Respons berikut dikembalikan:

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

Gunakan Create index API untuk menambahkan indeks baru.

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

settings: Konfigurasi indeks. Misalnya, Anda dapat menentukan jumlah shard (index.number_of_shards) dan interval refresh (index.refresh_interval), yaitu waktu maksimum sejak dokumen diindeks hingga menjadi dapat dicari.

mappings: Skema indeks. Misalnya, Anda dapat mendefinisikan bidang dan tipe datanya.

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

Respons berikut dikembalikan:

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

Lihat indeks tertentu

Gunakan Get index API untuk melihat settings dan mappings suatu indeks.

GET /test

Respons berikut dikembalikan:

{
  "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 mengambil settings suatu indeks.

GET /test/_settings

Respons berikut dikembalikan:

{
  "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 pengaturan indeks

Gunakan Update index settings API untuk memperbarui pengaturan dinamis suatu indeks.

Contoh berikut menunjukkan cara mengubah pengaturan index.refresh_interval menjadi 1s. Hal ini mengubah waktu sejak dokumen diindeks hingga menjadi dapat dicari menjadi 1 detik. Interval minimum adalah 1 detik.

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

Respons berikut dikembalikan:

{
  "acknowledged": true
}

Tulis data ke indeks

Gunakan Index API untuk menambahkan atau memperbarui dokumen dalam suatu indeks.

Saat menggunakan metode PUT, Anda harus secara eksplisit menentukan id. Jika id yang ditentukan sudah ada dalam indeks, dokumen baru akan menimpa dokumen yang ada.

Contoh berikut menetapkan id menjadi 1:

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

Respons berikut dikembalikan:

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

Saat menggunakan metode POST, Anda dapat menghilangkan id. LindormSearch secara otomatis menghasilkan id untuk dokumen tersebut.

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

Respons berikut dikembalikan:

{
  "_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 secara otomatis menghasilkan id b_MsCJEB3g4To6JSOeF6 untuk dokumen tersebut.

Gunakan Update API untuk memperbarui bidang tertentu dari dokumen yang sudah ada. id dokumen harus disertakan dalam path permintaan, dan badan permintaan harus berisi objek doc.
Contoh berikut memperbarui bidang firstName menjadi Lane untuk dokumen dengan id 1:
```
POST /test/_update/1
{
  "doc": {
    "firstName": "Lane"
  }
}
```
Respons berikut dikembalikan:
```
{
  "_index": "test",
  "_type": "_doc",
  "_id": "1",
  "_version": 2,
  "result": "updated",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 1,
  "_primary_term": 1
}
```

Kueri data dalam indeks

Gunakan Search API untuk mengkueri data dalam suatu indeks dengan menentukan kriteria kueri dalam badan permintaan.

Contoh berikut mencari dokumen yang memiliki lastName bernilai Smith:

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

Respons berikut dikembalikan:

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

Gunakan Get API untuk mengambil dokumen berdasarkan id-nya.

Contoh berikut mengambil dokumen dengan id 1:

GET /test/_doc/1

Respons berikut dikembalikan:

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

Hapus data dari indeks

Delete API menghapus dokumen dari suatu indeks berdasarkan id-nya.

Contoh berikut menghapus dokumen dengan id 1:

DELETE /test/_doc/1

Respons berikut dikembalikan:

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

Dalam respons, "successful": 1 menunjukkan bahwa dokumen telah dihapus.