GUI - - Alibaba Cloud ドキュメントセンター

Lindorm 検索エンジンはビジュアルユーザーインターフェースを提供します。このインターフェースを使用して、RESTful API 経由で Lindorm 検索エンジンにアクセスできます。本トピックでは、Lindorm コンソールからユーザーインターフェース（UI）にログインし、読み取りおよび書き込み操作を実行する方法について説明します。

前提条件

インスタンスのサービスタイプは Lindorm または Lindorm_V2 である必要があります。サービスタイプの確認方法については、「プロダクトシリーズの確認」をご参照ください。
Lindorm 検索エンジンが有効化されました。詳細については、「アクティベーションガイド」をご参照ください。
ご利用のクライアントの IP アドレスが Lindorm ホワイトリストに追加されている必要があります。詳細については、「ホワイトリストの設定」をご参照ください。
重要
ご利用のクライアントがデフォルトで IPv6 プロトコルを使用している場合、無効化する必要があります。無効化しないと、ホワイトリスト認証が失敗します。

手順

UI へのログイン

Lindorm コンソールにログインします。
ページ左上隅で、ご利用のインスタンスが配置されているリージョンを選択します。
Instances ページで、対象インスタンスの ID をクリックするか、Actions 列で View Instance Details をクリックします。
左側のナビゲーションウィンドウで、Search Engine をクリックします。
[UI アクセス] セクションで、Internet または VPC をクリックして UI にログインします。
ログインページで、[UI アクセス] セクションに記載されている Default Username および デフォルトの初期パスワード を入力します。
説明
- UI に初めてアクセスする際は、ページリソースの読み込み完了まで待機する必要がある場合があります。
- 初回ログイン時は、Default Username および デフォルトの初期パスワード を使用して検索 UI にログインしてください。2 回目以降のログインには、デフォルトユーザーが作成した他のユーザーアカウントを使用します。

読み取りおよび書き込み操作

重要

読み取りおよび書き込み操作の構文は、Elasticsearch (ES) API 7.x と互換性があります。

開発者ツールを開く

UI の左上隅にあるアイコンをクリックしてサイドバーを開き、[管理] > [Dev Tools] をクリックします。
[Dev Tools] では、RESTful API 経由で Lindorm 検索エンジンにアクセスできます。

作成済みのすべてのインデックスを表示

cat API を使用して、検索エンジン内に作成済みのすべてのインデックスに関する基本情報を表示できます。

パスに v パラメーターを追加すると、列名が上部に表示されます。

GET /_cat/indices?v

戻り値：

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

インデックスの作成

Create index API を使用してインデックスを作成できます。

リクエストボディで、インデックスの settings および mappings を指定できます。

settings：シャード数（`index.number_of_shards`）や更新間隔（`index.refresh_interval`）など、インデックスの設定項目を指定します。

mappings：インデックス内のフィールドや各フィールドのデータの型など、インデックスの構造を指定します。

PUT /test  // インデックスを作成するために Create index 操作を呼び出します。
{
  "settings": { // インデックスの設定
    "index.number_of_shards": 2, // インデックス シャードの数
    "index.refresh_interval": "10s" // 書き込み操作とデータ表示の最大間隔
  },
  "mappings": { // インデックスの構造
    "properties": { // インデックス内のフィールド
      "firstName": { // firstName フィールド
        "type": "keyword" // firstName フィールドのデータ型
      },
      "lastName": { // lastName フィールド
        "type": "keyword" // lastName フィールドのデータ型
      }
    }
  }
}

戻り値：

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

特定のインデックスに関する情報を表示する

Get index API を使用して、特定のインデックスに関する情報（settings および mappings を含む）を表示できます。

GET /test

戻り値：

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

settings または mappings のみを表示する場合は、Get index settings API または Get mapping API を使用できます。

以下の例は、settings を取得する方法を示しています。

GET /test/_settings

戻り値：

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

インデックス設定の更新

Update index settings API を使用して、インデックスの動的に変更可能な設定項目を更新できます。

以下の例では、index.refresh_interval 設定を 1 秒に変更します。これにより、データが書き込まれてから可視になるまでの間隔が 1 秒になります。最小間隔は 1 秒です。

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

戻り値：

{
  "acknowledged": true
}

インデックスにデータを書き込む

Index API を使用して、インデックスにデータを書き込むことができます。

PUT メソッドを使用する場合、id を指定する必要があります。指定された id を持つドキュメントがすでに存在する場合、既存のドキュメントが上書きされます。
以下の例では、id として 1 を指定しています：
```
PUT /test/_doc/1
{
  "firstName": "John",
  "lastName": "Smith"
}
```
戻り値：
```
{
  "_index": "test",
  "_type": "_doc",
  "_id": "1",
  "_version": 1,
  "result": "created",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 0,
  "_primary_term": 1
}
```

POST メソッドを使用する場合、id を指定する必要はありません。Lindorm 検索エンジンが自動的にデータ用の id を生成します。

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

戻り値：

{
  "_index": "test",
  "_type": "_doc",
  "_id": "b_MsCJEB3g4To6JSOeF6", // LindormSearch が自動的に生成した id 値
  "_version": 1,
  "result": "created",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 0,
  "_primary_term": 1
}

Lindorm 検索エンジンがデータ用に自動的に id を生成しました：b_MsCJEB3g4To6JSOeF6。

Update API を使用して、既存データの特定のフィールドを更新できます。パスパラメーターにドキュメントの id を含め、リクエストボディに doc パラメーターを含めてください。
以下の例では、id を 1 に設定し、firstName を Lane に更新しています：
```
POST /test/_update/1
{
  "doc": {
    "firstName": "Lane"
  }
}
```
戻り値：
```
{
  "_index": "test",
  "_type": "_doc",
  "_id": "1",
  "_version": 2,
  "result": "updated",
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 1,
  "_primary_term": 1
}
```

インデックスデータの表示

Search API を使用して、インデックス内のデータを表示できます。リクエストボディでクエリ条件を指定できます。

以下の例では、lastName として Smith を指定しています：

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

戻り値：

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

Get API を使用して、指定された id のデータを表示できます。

以下の例では、id として 1 を指定しています：

GET /test/_doc/1

戻り値：

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

インデックスデータを削除する

Delete API を使用して、インデックスから指定された id のデータを削除できます。

以下の例では、id として 1 を指定しています：

DELETE /test/_doc/1

戻り値：

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

successful の戻り値が 1 であることは、指定されたデータが正常に削除されたことを示します。