ServiceManagementApi¶

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> getServiceStatus()

Get service’s current status.

Example¶

// Import classes:
import com.alibaba.graphscope.interactive.client.Driver;
import com.alibaba.graphscope.interactive.client.Session;
import com.alibaba.graphscope.interactive.client.common.Result;
import com.alibaba.graphscope.interactive.models.ServiceStatus;

public class Example {
  public static void main(String[] args) {
    Driver driver = Driver.connect();
    Session session = driver.session();

    //get service status
    Result<ServiceStatus> status = session.getServiceStatus();
    if (!status.isOk()) {
      System.out.println("Failed to get service status: " + status.getStatusMessage());
    } else {
      System.out.println("Service status: " + status.getValue());
    }
  }
}

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	-

RestartService¶

Result<String> restartService()

Restart query service on current running graph.

Example¶

// Import classes:
import com.alibaba.graphscope.interactive.client.Driver;
import com.alibaba.graphscope.interactive.client.Session;
import com.alibaba.graphscope.interactive.client.common.Result;
import com.alibaba.graphscope.interactive.models.ServiceStatus;

public class Example {
  public static void main(String[] args) {
    Driver driver = Driver.connect();
    Session session = driver.session();

    Result<String> restart = session.restartService();
    if (!restart.isOk()) {
      System.out.println("Failed to restart service: " + restart.getStatusMessage());
      return;
    } else {
      System.out.println("Service restarted: " + restart.getValue());
    }
  }
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

Result<String>

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	-

StartService¶

Result<String> startService(startServiceRequest)

Start service on a specified graph

Example¶

// Import classes:
import com.alibaba.graphscope.interactive.client.Driver;
import com.alibaba.graphscope.interactive.client.Session;
import com.alibaba.graphscope.interactive.client.common.Result;
import com.alibaba.graphscope.interactive.models.StartServiceRequest;

public class Example {
  public static void main(String[] args) {
    Driver driver = Driver.connect();
    Session session = driver.session();

    Result<String> start = session.startService(new StartServiceRequest().graphId("1"));
    if (!start.isOk()) {
      System.out.println("Failed to start service: " + start.getStatusMessage());
    } else {
      System.out.println("Service started: " + start.getValue());
    }
  }
}

Parameters¶

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

Return type¶

Result<String>

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	-

StopService¶

Result<String> stopService()

Stop query service.

Example¶

// Import classes:
import com.alibaba.graphscope.interactive.client.Driver;
import com.alibaba.graphscope.interactive.client.Session;
import com.alibaba.graphscope.interactive.client.common.Result;
import com.alibaba.graphscope.interactive.models.StartServiceRequest;

public class Example {
  public static void main(String[] args) {
    Driver driver = Driver.connect();
    Session session = driver.session();

    Result<String> stop = session.stopService();
    if (!stop.isOk()) {
      System.out.println("Failed to stop service: " + stop.getStatusMessage());
      return;
    } else {
      System.out.println("Service stopped: " + stop.getValue());
    }
  }
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

Result<String>

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	-