Blame view

docs/搜索API对接指南-06-管理接口(Admin).md 1.12 KB
0342d897   tangwang   搜索API对接指南 拆分
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
  # 搜索API对接指南-06-管理接口(Admin)
  
  用于查看服务健康状态、获取租户配置与索引统计信息(原文第 6 章)。
  
  ## 管理接口
  
  ### 6.1 健康检查
  
  - **端点**: `GET /admin/health`
  - **描述**: 检查服务与依赖(如 Elasticsearch)状态。
  
  ```json
  {
    "status": "healthy",
    "elasticsearch": "connected",
    "tenant_id": "tenant1"
  }
  ```
  
  ### 6.2 获取配置
  
  - **端点**: `GET /admin/config`
  - **描述**: 返回当前租户的脱敏配置,便于核对索引及排序表达式。
  
  ```json
  {
    "tenant_id": "tenant1",
    "tenant_name": "Tenant1 Test Instance",
    "es_index_name": "search_tenant1",
    "num_fields": 20,
    "num_indexes": 4,
    "supported_languages": ["zh", "en", "ru"],
    "spu_enabled": false
  }
  ```
  
  ### 6.3 索引统计
  
  - **端点**: `GET /admin/stats`
  - **描述**: 获取指定租户索引文档数量与磁盘大小,方便监控。
  - **租户标识**:通过请求头 `X-Tenant-ID` 或 query 参数 `tenant_id` 传递(必填)。
  
  ```json
  {
    "tenant_id": "162",
    "index_name": "search_products_tenant_162",
    "document_count": 10000,
    "size_mb": 523.45
  }
  ```
  
  ---