本文介绍如何配置 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 用户名/密码是否正确,密码中特殊字符是否需转义。 |