gs_interactive.AdminService服务管理API

所有URI均相对于{INTERACTIVE_ADMIN_ENDPOINT}

方法

HTTP请求

描述

GetServiceStatus

GET /v1/service/status

获取服务的状态和指标

RestartService

POST /v1/service/restart

重启当前运行图上的查询服务

StartService

POST /v1/service/start

在指定图上启动查询服务

StopService

POST /v1/service/stop

停止查询服务

获取服务状态

结果[ServiceStatus] get_service_status()

获取服务状态

示例

resp = sess.get_service_status()
assert resp.is_ok()
print("Current service status", resp)

参数

此端点不需要任何参数。

返回类型

结果[服务状态]

授权

无需授权

HTTP请求头

  • Content-Type: 未定义

  • Accept: application/json

HTTP响应详情

状态码

描述

响应头

200

操作成功

-

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]

重启服务

结果[str] restart_service()

启动当前服务

示例

resp = sess.restart_service()
assert resp.is_ok()
print("restart service result", resp)

参数

此端点不需要任何参数。

返回类型

结果[str]

授权

无需授权

HTTP请求头

  • Content-Type: 未定义

  • Accept: application/json

HTTP响应详情

状态码

描述

响应头

200

操作成功

-

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]

启动服务

结果[str] start_service(start_service_request=start_service_request)

在指定图上启动服务

示例

resp = sess.start_service(
    start_service_request=StartServiceRequest(graph_id=graph_id)
)
assert resp.is_ok()
print("restart service result: ", resp.get_value())

参数

名称

类型

描述

备注

start_service_request

StartServiceRequest

在指定图上启动服务

[optional]

返回类型

结果[str]

授权

无需授权

HTTP请求头

  • 内容类型: application/json

  • Accept: application/json

HTTP响应详情

状态码

描述

响应头

200

操作成功

-

500

内部错误

-

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]

停止服务

结果[str] stop_service(graph_id : str = None)

停止当前查询服务，同时管理服务继续运行。您可以指定一个graph_id来表明要停止哪个图的查询服务。由于同一时间只能运行一个图，graph_id将验证该图的查询服务是否处于活动状态。如果未提供graph_id，则查询服务将直接停止而无需此验证。

示例

stop_res = sess.stop_service(graph_id = '1')
assert stop_res.is_ok()
print("stop service result", stop_res)

参数

此端点不需要任何参数。

返回类型

结果[str]

授权

无需授权

HTTP请求头

  • Content-Type: 未定义

  • Accept: application/json

HTTP响应详情

状态码

描述

响应头

200

操作成功

-

[返回顶部] [返回API列表] [返回模型列表] [返回python_sdk]