管理接口

管理接口主要用于对搜索平台和数据进行管理、维护。调用管理接口之前必须要咨询管理员。

1. 应用管理

1.1 查询集群所有应用信息

URL HTTP 功能
/management/processes GET 返回集群中所有应用信息，按照服务器分组

请求参数

参数名 数据类型 可需 描述
format string 选填 返回数据的格式，支持json、xml、yaml，默认json；也可以在HTTP header accept参数中指定返回消息格式

返回结果

[
    {
        "state": "RUNNING",
        "pid": 9436,
        "host": "172.17.16.25",
        "sub_process_list": [
            {
                "now": 1466735898,
                "group": "Nginx",
                "description": "pid 9440, uptime 16 days, 16:22:22",
                "pid": 9440,
                "stderr_logfile": "/tmp/Nginx-stderr---supervisor-JzuopB.log",
                "stop": 0,
                "statename": "RUNNING",
                "start": 1465294556,
                "state": 20,
                "stdout_logfile": "/opt/search_platform/logs/supervisor/nginx.log",
                "logfile": "/opt/search_platform/logs/supervisor/nginx.log",
                "exitstatus": 0,
                "spawnerr": "",
                "name": "Nginx"
            },
            {
                "now": 1466735898,
                "group": "Webserver_8101",
                "description": "pid 9439, uptime 16 days, 16:22:22",
                "pid": 9439,
                "stderr_logfile": "/tmp/Webserver_8101-stderr---supervisor-P3ZB2Y.log",
                "stop": 0,
                "statename": "RUNNING",
                "start": 1465294556,
                "state": 20,
                "stdout_logfile": "/opt/search_platform/logs/supervisor/uwsgi_1.log",
                "logfile": "/opt/search_platform/logs/supervisor/uwsgi_1.log",
                "exitstatus": 0,
                "spawnerr": "",
                "name": "Webserver_8101"
            },
            {
                "now": 1466735898,
                "group": "Webserver_8103",
                "description": "pid 9441, uptime 16 days, 16:22:22",
                "pid": 9441,
                "stderr_logfile": "/tmp/Webserver_8103-stderr---supervisor-HuYQQB.log",
                "stop": 0,
                "statename": "RUNNING",
                "start": 1465294556,
                "state": 20,
                "stdout_logfile": "/opt/search_platform/logs/supervisor/uwsgi_2.log",
                "logfile": "/opt/search_platform/logs/supervisor/uwsgi_2.log",
                "exitstatus": 0,
                "spawnerr": "",
                "name": "Webserver_8103"
            },
            {
                "now": 1466735898,
                "group": "Webserver_8104",
                "description": "pid 9443, uptime 16 days, 16:22:22",
                "pid": 9443,
                "stderr_logfile": "/tmp/Webserver_8104-stderr---supervisor-FKzJwh.log",
                "stop": 0,
                "statename": "RUNNING",
                "start": 1465294556,
                "state": 20,
                "stdout_logfile": "/opt/search_platform/logs/supervisor/uwsgi_3.log",
                "logfile": "/opt/search_platform/logs/supervisor/uwsgi_3.log",
                "exitstatus": 0,
                "spawnerr": "",
                "name": "Webserver_8104"
            },
            {
                "now": 1466735898,
                "group": "Webserver_8105",
                "description": "pid 9442, uptime 16 days, 16:22:22",
                "pid": 9442,
                "stderr_logfile": "/tmp/Webserver_8105-stderr---supervisor-KbVuDG.log",
                "stop": 0,
                "statename": "RUNNING",
                "start": 1465294556,
                "state": 20,
                "stdout_logfile": "/opt/search_platform/logs/supervisor/uwsgi_4.log",
                "logfile": "/opt/search_platform/logs/supervisor/uwsgi_4.log",
                "exitstatus": 0,
                "spawnerr": "",
                "name": "Webserver_8105"
            }
        ]
    }
]

1.2 查询集群指定服务器上的应用信息

URL HTTP 功能
/management/processes/:host GET 返回给定的服务器上的应用信息

请求参数

参数名 数据类型 可需 描述
host string 必填 服务器IP地址
format string 选填 返回数据的格式，支持json、xml、yaml，默认json；也可以在HTTP header accept参数中指定返回消息格式

返回结果

[
    {
        "state": "RUNNING",
        "pid": 5589,
        "host": "172.17.8.199",
        "sub_process_list": [
            {
                "now": 1466736347,
                "group": "Measure",
                "description": "pid 5593, uptime 16 days, 14:22:25",
                "pid": 5593,
                "stderr_logfile": "/tmp/Measure-stderr---supervisor-UOKvsn.log",
                "stop": 0,
                "statename": "RUNNING",
                "start": 1465302202,
                "state": 20,
                "stdout_logfile": "/opt/search_platform/search_platform/logs/supervisor/measure.log",
                "logfile": "/opt/search_platform/search_platform/logs/supervisor/measure.log",
                "exitstatus": 0,
                "spawnerr": "",
                "name": "Measure"
            },
            {
                "now": 1466736347,
                "group": "MessageListener",
                "description": "pid 9230, uptime 5:26:40",
                "pid": 9230,
                "stderr_logfile": "/tmp/MessageListener-stderr---supervisor-90xyDw.log",
                "stop": 1466716746,
                "statename": "RUNNING",
                "start": 1466716747,
                "state": 20,
                "stdout_logfile": "/opt/search_platform/search_platform/logs/supervisor/listener.log",
                "logfile": "/opt/search_platform/search_platform/logs/supervisor/listener.log",
                "exitstatus": 0,
                "spawnerr": "",
                "name": "MessageListener"
            },
            {
                "now": 1466736347,
                "group": "Suggest",
                "description": "pid 5590, uptime 16 days, 14:22:25",
                "pid": 5590,
                "stderr_logfile": "/tmp/Suggest-stderr---supervisor-575TSu.log",
                "stop": 0,
                "statename": "RUNNING",
                "start": 1465302202,
                "state": 20,
                "stdout_logfile": "/opt/search_platform/search_platform/logs/supervisor/suggest.log",
                "logfile": "/opt/search_platform/search_platform/logs/supervisor/suggest.log",
                "exitstatus": 0,
                "spawnerr": "",
                "name": "Suggest"
            },
            {
                "now": 1466736347,
                "group": "Worker",
                "description": "pid 5592, uptime 16 days, 14:22:25",
                "pid": 5592,
                "stderr_logfile": "/tmp/Worker-stderr---supervisor-AQdvGV.log",
                "stop": 0,
                "statename": "RUNNING",
                "start": 1465302202,
                "state": 20,
                "stdout_logfile": "/opt/search_platform/search_platform/logs/supervisor/celery.log",
                "logfile": "/opt/search_platform/search_platform/logs/supervisor/celery.log",
                "exitstatus": 0,
                "spawnerr": "",
                "name": "Worker"
            }
        ]
    }
]

1.3 对指定服务器上的应用进行操作

URL HTTP 功能
/management/processes/operations/:operation/host/:host POST 对指定服务器上的应用进行操作

请求参数

参数名 数据类型 可需 描述
host string 必填 服务器IP地址
operation string 必填 对应用进行的操作，有：start（启动应用）、stop（停止应用）、restart（重启应用）、 clear_log（清除日志）、get_log（获取日志）

返回结果

无

1.4 对指定服务器上的某个应用进行操作

URL HTTP 功能
/management/processes/operations/:operation/host/:host/name/:app POST 对指定服务器上的某个应用进行操作

请求参数

参数名 数据类型 可需 描述
host string 必填 服务器IP地址
operation string 必填 对应用进行的操作，有：start（启动应用）、stop（停止应用）、restart（重启应用）、 clear_log（清除日志）、get_log（获取日志）
app string 必填 应用名称

返回结果

无

2. Suggest管理

2.1 查询某个用户的搜索建议词

URL HTTP 功能
/management/suggestterms/:adminId GET 查询用户的搜索建议词

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号
from int 选填 起始位置，默认为0
size int 选填 分页大小，默认为100，最大为200
format string 选填 返回数据的格式，支持json、xml、yaml，默认json；也可以在HTTP header accept参数中指定返回消息格式

返回结果

{
    "total": 6813,
    "root": [
        {
            "source_type": "自动分词",
            "hits": {
                "default": 26
            },
            "word": "香粉"
        },
        {
            "source_type": "自动分词",
            "hits": {
                "default": 173
            },
            "word": "包装"
        },
        {
            "source_type": "自动分词",
            "hits": {
                "default": 16
            },
            "word": "王致"
        },
        {
            "source_type": "自动分词",
            "hits": {
                "default": 20
            },
            "word": "味好美"
        }
    ]
}

2.2 添加某个用户的搜索建议词

URL HTTP 功能
/management/suggestterms/:adminId POST 为用户添加搜索建议词

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号

请求体

参数名 数据类型 可需 描述
word string或数组 必填 要添加的建议词，可以是单个建议词，也可以是多个建议词的数组

返回结果

创建成功的建议词

2.3 删除某个用户的搜索建议词

URL HTTP 功能
/management/suggestterms/:adminId/:word POST 删除用户的搜索建议词

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号
word string 必填 要删除的建议词

返回结果

无

2.4 初始化某个用户的搜索建议词

URL HTTP 功能
/management/suggestterms/:adminId/operations/init POST 初始化某个用户的搜索建议词

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号

返回结果

无

3. 签约用户管理

3.1 查询所有的签约用户AdminId

URL HTTP 功能
/management/vip/adminIds GET 返回所有的签约用户的AdminId

请求参数

参数名 数据类型 可需 描述
format string 选填 返回数据的格式，支持json、xml、yaml，默认json；也可以在HTTP header accept参数中指定返回消息格式

返回结果

[
    "A000000",
    "A1000044",
    "A1050240",
    "A1053578",
    "A1089956",
    "A1090070",
    "A1121480",
    "A1129180",
    "A1137251",
    "A1165778",
    "A1168544",
    "A1183167",
    "A1223785",
    "A1225870",
    "A1228224",
    "A1229266",
    "A1229833",
    "A1231036",
    "A1232659",
    "A1232995",
    "A1233639",
    "A1233705",
    "A1235613",
    "A1238535",
    "A1238986",
    "A1239524",
    "A1240500",
    "A1240909",
    "A1240918",
    "A1243634",
    "A1243941"
]

3.2 检查指定的用户是否是VIP用户

URL HTTP 功能
/management/vip/adminIds/:adminId GET 检查指定的用户是否是VIP用户

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号
format string 选填 返回数据的格式，支持json、xml、yaml，默认json；也可以在HTTP header accept参数中指定返回消息格式

返回结果

3.3 添加用户为VIP用户

URL HTTP 功能
/management/vip/adminIds/:adminId POST 将用户添加为VIP用户

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号

返回结果

无

3.4 将用户从VIP用户中删除

URL HTTP 功能
/management/vip/adminIds/:adminId DELETE 将用户从VIP用户中删除

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号

返回结果

无

3.5 将用户从体验用户升级到VIP用户

URL HTTP 功能
/management/vip/adminIds/:adminId/operations/upgrade POST 将用户从体验用户升级到VIP用户，涉及到数据在两个集群中的搬迁

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号

返回结果

无

4. 集群管理

4.1 查询用户的消息队列

URL HTTP 功能
/management/clusters/msg_qos/metrics/queue/:adminId GET 返回用户的消息队列

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号
from int 选填 起始位置，默认为0
size int 选填 分页大小，默认为100，最大为200
format string 选填 返回数据的格式，支持json、xml、yaml，默认json；也可以在HTTP header accept参数中指定返回消息格式

4.2 查询用户的失败消息队列

URL HTTP 功能
/management/clusters/msg_qos/metrics/redo_queue/:adminId GET 返回用户的失败消息队列

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号
from int 选填 起始位置，默认为0
size int 选填 分页大小，默认为100，最大为200
format string 选填 返回数据的格式，支持json、xml、yaml，默认json；也可以在HTTP header accept参数中指定返回消息格式

4.3 查询最终失败消息队列

URL HTTP 功能
/management/clusters/msg_qos/metrics/final_queue GET 返回最终失败消息队列

请求参数

参数名 数据类型 可需 描述
from int 选填 起始位置，默认为0
size int 选填 分页大小，默认为100，最大为200
format string 选填 返回数据的格式，支持json、xml、yaml，默认json；也可以在HTTP header accept参数中指定返回消息格式

4.4 查询失败ResutFul请求队列

URL HTTP 功能
/management/clusters/rest_qos/metrics/redo_queue GET 返回失败ResutFul请求队列

请求参数

参数名 数据类型 可需 描述
from int 选填 起始位置，默认为0
size int 选填 分页大小，默认为100，最大为200
format string 选填 返回数据的格式，支持json、xml、yaml，默认json；也可以在HTTP header accept参数中指定返回消息格式

4.5 清空用户的消息队列

URL HTTP 功能
/management/clusters/msg_qos/metrics/queue/:adminId DELETE 清空用户的消息队列

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号

4.6 清空用户的失败消息队列

URL HTTP 功能
/management/clusters/msg_qos/metrics/redo_queue/:adminId DELETE 清空用户的失败消息队列

请求参数

参数名 数据类型 可需 描述
adminId string 必填 用户A编号

4.7 清空最终失败消息队列

URL HTTP 功能
/management/clusters/msg_qos/metrics/final_queue DELETE 清空最终失败消息队列

请求参数

无

4.8 切换Elasticsearch集群

URL HTTP 功能
/management/clusters/es/operations/failover POST 切换Elasticsearch集群

请求体

参数名 数据类型 可需 描述
target string 必填 切换对象，可选值vip、experience、both，

4.9 回切Elasticsearch集群

URL HTTP 功能
/management/clusters/es/operations/failback POST 回切Elasticsearch集群

请求体

参数名 数据类型 可需 描述
target string 必填 切换对象，可选值vip、experience、both，

results matching ""

    No results matching ""