gs_interactive.AdminServiceServiceManagementApi¶

All URIs are relative to {INTERACTIVE_ADMIN_ENDPOINT}

Method	HTTP request	Description
GetServiceStatus	GET /v1/service/status	Get the status and metrics of service
RestartService	POST /v1/service/restart	Restart the query service on the current running graph
StartService	POST /v1/service/start	Start the query service on the specified graph
StopService	POST /v1/service/stop	Stop the query service

GetServiceStatus¶

Result[ServiceStatus] get_service_status()

Get service status

Example¶

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

Parameters¶

This endpoint does not need any parameter.

Return type¶

Result[ServiceStatus]

Authorization¶

No authorization required

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to python_sdk]

RestartService¶

Result[str] restart_service()

Start current service

Example¶

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

Parameters¶

This endpoint does not need any parameter.

Return type¶

Result[str]

Authorization¶

No authorization required

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to python_sdk]

StartService¶

Result[str] start_service(start_service_request=start_service_request)

Start service on a specified graph

Example¶

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

Parameters¶

Name	Type	Description	Notes
start_service_request	StartServiceRequest	Start service on a specified graph	[optional]

Return type¶

Result[str]

Authorization¶

No authorization required

HTTP request headers¶

Content-Type: application/json
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	successful operation	-
500	Internal Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to python_sdk]

StopService¶

Result[str] stop_service(graph_id : str = None)

Stop the current query service while the admin service continues to operate. You can specify a graph_id to indicate which graph’s service to stop. Since only one graph can run at a time, the graph_id will verify if the query service is active on that graph. If no graph_id is provided, the query service will be stopped without this verification.

Example¶

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

Parameters¶

This endpoint does not need any parameter.

Return type¶

Result[str]

Authorization¶

No authorization required

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to python_sdk]