本文介紹如何配置 PolarDB-X智能搜尋引擎執行個體的訪問憑證(帳號、白名單、公網),並通過 REST API、官方用戶端或 OpenSearch Dashboards 串連搜尋節點。
配置白名單
訪問搜尋節點前,需要將您的業務環境IP加入白名單。
在 访问配置 標籤頁中,定位到 白名单 區塊。
單擊 新增白名单分组 按鈕,在彈出的對話方塊中填寫:
分组名称:用於區分不同來源(如 office / app-prod)。
组内白名单:允許訪問的 IP 位址或 CIDR 網段,多個用英文逗號分隔。
提交後,白名單列表新增一行,顯示 名称、IP、操作(修改 / 删除)。
公網訪問務必配置白名單,避免未授權訪問。
配置訪問帳號
REST API 訪問需要 Basic Auth 使用者名稱 + 密碼。在 账号管理 區塊管理帳號。
建立帳號
單擊 新建账号 按鈕。
在表單中填寫:
账号名称:帳號名稱(字母/數字組合)。
密码:密碼長度為8~32個字元,且必須包含至少一個大寫字母、一個小寫字母、一個數字和一個特殊字元。同時,密碼不得包含連續字元(例如
123、abc)或常見的弱模式。确认密码:再次輸入密碼確認。
提交後帳號即可用於 REST API 認證。
重設密碼
在帳號列表對應行單擊 重置密码,按密碼複雜度要求填寫 新密码 並提交。
刪除帳號
在帳號列表對應行單擊 删除,確認後即從訪問憑證中移除。
查看串連資訊
在 连接信息 區塊,展示以下端點資訊:
欄位 | 說明 |
内网地址 | 用於 VPC 內部訪問 REST API 的私網網域名稱。 |
内网端口 | 私網 REST API 連接埠(固定為 9200)。 |
公网地址 | 公網網域名稱,需要先開通公網訪問。 |
公网端口 | 公網 REST API 端(固定為 9200)。 |
Dashboard 内网地址 | OpenSearch Dashboards 私網地址。 |
Dashboard 内网端口 | OpenSearch Dashboards 私網連接埠。 |
Dashboard 公网地址 | OpenSearch Dashboards 公網地址。 |
Dashboard 公网端口 | OpenSearch Dashboards 公網連接埠。 |
使用HTTPS协议 | 根據實際業務情境,確認是否需要開啟HTTPS協議,預設為HTTP協議。 |
開通/關閉公網訪問
公網訪問預設 未开通。需要時單擊 立即开通,即可開通公網網域名稱。開通後可單擊 关闭公网 關閉公網。
公網訪問會暴露在公網中,務必同時維護白名單和強密碼帳號。
命令列串連(curl)
基本串連驗證
# 叢集健康狀態
curl -XGET "http://<API端點>:<port>/_cluster/health?pretty" -u "<使用者名稱>:<密碼>"
# 節點資訊
curl -XGET "http://<API端點>:<port>/_cat/nodes?v" -u "<使用者名稱>:<密碼>"
# 索引列表
curl -XGET "http://<API端點>:<port>/_cat/indices?v" -u "<使用者名稱>:<密碼>"常用管理命令
# 叢集設定
curl -XGET "http://<API端點>:<port>/_cluster/settings?include_defaults=true&pretty" -u "<使用者名稱>:<密碼>"
# 索引詳情
curl -XGET "http://<API端點>:<port>/<索引名>?pretty" -u "<使用者名稱>:<密碼>"
# 節點資源使用
curl -XGET "http://<API端點>:<port>/_cat/nodes?v&h=name,heap.percent,ram.percent,cpu,disk.used_percent" \
-u "<使用者名稱>:<密碼>"OpenSearch 官方用戶端
智能搜尋執行個體完全相容 OpenSearch 官方用戶端:
語言 | 用戶端 | 參考文檔 |
Java | opensearch-java | |
Python | opensearch-py | https://opensearch.org/docs/latest/clients/python-low-level/ |
Go | opensearch-go | |
Node.js | opensearch-js | https://opensearch.org/docs/latest/clients/javascript/index/ |
.NET / Ruby / Rust / PHP | opensearch-net / -ruby / -rs / -php |
串連配置要點:
Host:串連資訊中的內網/公網地址
Port:控制台顯示的連接埠號碼(預設 9200)
協議:根據實際業務情境,確認是否需要開啟HTTPS協議,預設為HTTP協議。
認證:Basic Auth(使用者名稱 + 密碼,通過帳號管理建立)。
OpenSearch Dashboards
Dashboards 是 OpenSearch 內建的可視化管理主控台,提供:
Dev Tools:互動式查詢控制台,調試 REST API 請求。
Discover:瀏覽和搜尋索引中的資料。
Visualize:建立資料視覺效果圖表。
Dashboard:組合多個可視化組件為儀錶盤。
訪問方式
在 连接信息 中擷取 Dashboards 內網或公網地址。
在瀏覽器中開啟該地址,使用帳號管理中建立的使用者名稱+密碼登入。
使用 Dev Tools 執行查詢
GET _cluster/health
PUT /test-index
{ "settings": { "number_of_shards": 1 } }
POST /test-index/_search
{ "query": { "match_all": {} } }串連故障排查
問題 | 可能原因 | 解決方案 |
Connection refused | 連接埠不通 / 公網未開通 |
|
Connection timeout | 網路不可達 / VPC 路由不通 | 確認用戶端與執行個體在同一 VPC,或通過公網訪問。 |
401 Unauthorized | 認證失敗 | 檢查 Basic Auth 使用者名稱/密碼是否正確,密碼中特殊字元是否需轉義。 |