服务管理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	停止查询服务

获取服务状态¶

结果 getServiceStatus()

获取服务的当前状态。

示例¶

// 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());
    }
  }
}

参数¶

此端点不需要任何参数。

返回类型¶

结果<服务状态>

授权¶

无需授权

HTTP请求头¶

Content-Type: 未定义
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	操作成功	-

重启服务¶

Result restartService()

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

示例¶

// 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());
    }
  }
}

参数¶

此端点不需要任何参数。

返回类型¶

结果<String>

授权¶

无需授权

HTTP请求头¶

Content-Type: 未定义
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	操作成功	-

启动服务¶

Result startService(startServiceRequest)

在指定图上启动服务

示例¶

// 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());
    }
  }
}

参数¶

名称	类型	描述	备注
startServiceRequest	StartServiceRequest	在指定图上启动服务	[optional]

返回类型¶

结果<String>

授权¶

无需授权

HTTP请求头¶

内容类型: application/json
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	操作成功	-
500	内部错误	-

停止服务¶

结果 stopService()

停止查询服务。

示例¶

// 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());
    }
  }
}

参数¶

此端点不需要任何参数。

返回类型¶

结果<String>

授权¶

无需授权

HTTP请求头¶

Content-Type: 未定义
Accept: application/json

HTTP响应详情¶

状态码	描述	响应头
200	操作成功	-