AdminServiceServiceManagementApi¶

All URIs are relative to {INTERACTIVE_ENDPOINT}

Method	HTTP request	Description
getServiceStatus	GET /v1/service/status
restartService	POST /v1/service/restart
startService	POST /v1/service/start
stopService	POST /v1/service/stop

getServiceStatus¶

ServiceStatus getServiceStatus()

Get service status

Example¶

// Import classes:
import com.alibaba.graphscope.interactive.openapi.ApiClient;
import com.alibaba.graphscope.interactive.openapi.ApiException;
import com.alibaba.graphscope.interactive.openapi.Configuration;
import com.alibaba.graphscope.interactive.openapi.models.*;
import com.alibaba.graphscope.interactive.openapi.api.AdminServiceServiceManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("{INTERACTIVE_ENDPOINT}");

    AdminServiceServiceManagementApi apiInstance = new AdminServiceServiceManagementApi(defaultClient);
    try {
      ServiceStatus result = apiInstance.getServiceStatus();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AdminServiceServiceManagementApi#getServiceStatus");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

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¶

String restartService()

Start current service

Example¶

// Import classes:
import com.alibaba.graphscope.interactive.openapi.ApiClient;
import com.alibaba.graphscope.interactive.openapi.ApiException;
import com.alibaba.graphscope.interactive.openapi.Configuration;
import com.alibaba.graphscope.interactive.openapi.models.*;
import com.alibaba.graphscope.interactive.openapi.api.AdminServiceServiceManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("{INTERACTIVE_ENDPOINT}");

    AdminServiceServiceManagementApi apiInstance = new AdminServiceServiceManagementApi(defaultClient);
    try {
      String result = apiInstance.restartService();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AdminServiceServiceManagementApi#restartService");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

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¶

String startService(startServiceRequest)

Start service on a specified graph

Example¶

// Import classes:
import com.alibaba.graphscope.interactive.openapi.ApiClient;
import com.alibaba.graphscope.interactive.openapi.ApiException;
import com.alibaba.graphscope.interactive.openapi.Configuration;
import com.alibaba.graphscope.interactive.openapi.models.*;
import com.alibaba.graphscope.interactive.openapi.api.AdminServiceServiceManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("{INTERACTIVE_ENDPOINT}");

    AdminServiceServiceManagementApi apiInstance = new AdminServiceServiceManagementApi(defaultClient);
    StartServiceRequest startServiceRequest = new StartServiceRequest(); // StartServiceRequest | Start service on a specified graph
    try {
      String result = apiInstance.startService(startServiceRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AdminServiceServiceManagementApi#startService");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters¶

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

Return type¶

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¶

String stopService()

Stop current service

Example¶

// Import classes:
import com.alibaba.graphscope.interactive.openapi.ApiClient;
import com.alibaba.graphscope.interactive.openapi.ApiException;
import com.alibaba.graphscope.interactive.openapi.Configuration;
import com.alibaba.graphscope.interactive.openapi.models.*;
import com.alibaba.graphscope.interactive.openapi.api.AdminServiceServiceManagementApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("{INTERACTIVE_ENDPOINT}");

    AdminServiceServiceManagementApi apiInstance = new AdminServiceServiceManagementApi(defaultClient);
    try {
      String result = apiInstance.stopService();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AdminServiceServiceManagementApi#stopService");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

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	-