RESTful API Documentation¶
Introduction¶
Welcome to the GraphScope Interactive RESTful API documentation. This guide is tailored for developers and administrators seeking to manage the Interactive service more efficiently. Here, we delve into the intricate workings of the RESTful HTTP interfaces provided by the Interactive Admin service, offering a comprehensive toolkit for real-time service management. This document is crucial for those looking to customize or enhance their GraphScope Interactive experience.
API Overview¶
The table below provides an overview of the available APIs:
API name |
Method and URL |
Explanation |
|---|---|---|
ListGraphs |
GET /v1/graph |
Get all graphs in current interactive service, the schema for each graph is returned. |
GetGraphStatistics |
GET /v1/graph/{graph}/statistics |
Get the statistics for the specified graph. |
GetGraphSchema |
GET /v1/graph/{graph}/schema |
Get the schema for the specified graph. |
CreateGraph |
POST /v1/graph |
Create an empty graph with the specified schema. |
DeleteGraph |
DELETE /v1/graph/{graph} |
Delete the specified graph. |
ImportGraph |
POST /v1/graph/{graph}/dataloading |
Import data to graph. |
CreateProcedure |
POST /v1/graph/{graph}/procedure |
Create a new stored procedure bound to a graph. |
ShowProcedures |
GET /v1/graph/{graph}/procedure |
Get all procedures bound to the specified graph. |
GetProcedure |
GET /v1/graph/{graph}/procedure/{proc_name} |
Get the metadata of the procedure. |
DeleteProcedure |
DELETE /v1/graph/{graph}/procedure/{proc_name} |
Delete the specified procedure. |
UpdateProcedure |
PUT /v1/graph/{graph}/procedure/{proc_name} |
Update some metadata for the specified procedure, i.e. update description, enable/disable. |
StartService |
POST /v1/service/start |
Start the service on the graph specified in request body. |
RestartService |
POST /v1/service/restart |
Restart the service on the current running graph. |
StopService |
GET /v1/service/stop |
Stop the query service |
ServiceStatus |
GET /v1/service/status |
Get current service status. |
SystemMetrics |
GET /v1/node/status |
Get the system metrics of current host/pod, i.e. CPU usage, memory usages. |
GetJobById |
GET /v1/job/{job_id} |
Get the metadata for the specified job. |
GetAllJobs |
GET /v1/job/ |
Get all jobs’s metadata. |
CancelJob |
DELETE /v1/job/{job_id} |
Cancel the job with the specified job_id. |
Detailed API Documentation¶
For each API, the documentation will include a detailed description, request format, example curl command, expected response format and body, and status codes. Here’s an example for one of the APIs:
ListGraphs API (GraphManagement Category)¶
Description¶
This API lists all graphs currently managed by the Interactive service, providing detailed schema information for each.
HTTP Request¶
Method: GET
Endpoint:
/v1/graphContent-type:
application/json
Curl Command Example¶
curl -X GET -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/graph"
Expected Response¶
Format:
application/jsonBody:
[
{
"name": "modern_graph",
"schema": {
"vertex_types": [
{
"type_id": "0",
"type_name": "person",
"properties": [
{
"property_id": "0",
"property_name": "id",
"property_type": {
"primitive_type": "DT_SIGNED_INT64"
}
},
{
"property_id": "1",
"property_name": "name",
"property_type": {
"string":{
"long_text": {}
}
}
},
{
"property_id": "2",
"property_name": "age",
"property_type": {
"string":{
"long_text": {}
}
}
}
],
"primary_keys": [
"id"
]
},
{
"type_id": "1",
"type_name": "software",
"properties": [
{
"property_id": "0",
"property_name": "id",
"property_type": {
"primitive_type": "DT_SIGNED_INT64"
}
},
{
"property_id": "1",
"property_name": "name",
"property_type": {
"string":{
"long_text": {}
}
}
},
{
"property_id": "2",
"property_name": "lang",
"property_type": {
"string":{
"long_text": {}
}
}
}
],
"primary_keys": [
"id"
]
}
],
"edge_types": [
{
"type_id": "0",
"type_name": "knows",
"vertex_type_pair_relations": [
{
"source_vertex": "person",
"destination_vertex": "person",
"relation": "MANY_TO_MANY",
}
],
"properties": [
{
"property_id": "0",
"property_name": "weight",
"property_type": {
"primitive_type": "DT_DOUBLE"
}
}
]
},
{
"type_id": "1",
"type_name": "created",
"vertex_type_pair_relations": [
{
"source_vertex": "person",
"destination_vertex": "software",
"relation": "ONE_TO_MANY",
}
],
"properties": [
{
"property_id": "0",
"property_name": "weight",
"property_type": {
"primitive_type": "DT_DOUBLE"
}
}
]
}
]
}
}
]
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
GetGraphStatistics API (GraphManagement Category)¶
Description¶
This API retrieves the statistical data(enumerating the count of vertices and edges corresponding to each label) for the actively running graph. If at the time of the request, no graph is in service, the service will respond with a NOT FOUND status.
HTTP Request¶
Method: GET
Endpoint:
/v1/graph/{graph_id}/statisticsContent-type:
application/json
Curl Command Example¶
curl -X GET -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/graph/{graph_id}/statistics"
Expected Response¶
Format:
application/jsonBody:
{
"edge_type_statistics": [
{
"type_id": 0,
"type_name": "knows",
"vertex_type_pair_statistics": [
{
"count": 5,
"destination_vertex": "person",
"source_vertex": "person"
}
]
}
],
"total_edge_count": 5,
"total_vertex_count": 6,
"vertex_type_statistics": [
{
"count": 4,
"type_id": 0,
"type_name": "person"
},
{
"count": 2,
"type_id": 1,
"type_name": "software"
}
]
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not Found: No graph is serving or the queried graph is not the running graph.
CreateGraph (GraphManagement Category)¶
Description¶
This API create a new graph according to the specified schema in request body.
HTTP Request¶
Method: POST
Endpoint:
/v1/graphContent-type:
application/jsonBody:
{
"name": "modern",
"schema": {
"vertex_types": [
{
"type_id": 0,
"type_name": "person",
"properties": [
{
"property_id": 0,
"property_name": "id",
"property_type": {
"primitive_type": "DT_SIGNED_INT64"
}
},
{
"property_id": 1,
"property_name": "name",
"property_type": {
"string":{
"long_text": {}
}
}
},
{
"property_id": 2,
"property_name": "age",
"property_type": {
"string":{
"long_text": {}
}
}
}
],
"primary_keys": [
"id"
]
},
{
"type_id": 1,
"type_name": "software",
"properties": [
{
"property_id": 0,
"property_name": "id",
"property_type": {
"primitive_type": "DT_SIGNED_INT64"
}
},
{
"property_id": 1,
"property_name": "name",
"property_type": {
"string":{
"long_text": {}
}
}
},
{
"property_id": 2,
"property_name": "lang",
"property_type": {
"string":{
"long_text": {}
}
}
}
],
"primary_keys": [
"id"
]
}
],
"edge_types": [
{
"type_id": 0,
"type_name": "knows",
"vertex_type_pair_relations": [
{
"source_vertex": "person",
"destination_vertex": "person",
"relation": "MANY_TO_MANY",
}
],
"properties": [
{
"property_id": 0,
"property_name": "weight",
"property_type": {
"primitive_type": "DT_DOUBLE"
}
}
]
},
{
"type_id": 1,
"type_name": "created",
"vertex_type_pair_relations": [
{
"source_vertex": "person",
"destination_vertex": "software",
"relation": "ONE_TO_MANY",
}
],
"properties": [
{
"property_id": 0,
"property_name": "weight",
"property_type": {
"primitive_type": "DT_DOUBLE"
}
}
]
}
]
}
}
Curl Command Example¶
curl -X POST -H "Content-Type: application/json" -d @path/to/yourfile.json "http://{INTERACTIVE_ENDPOINT}/v1/graph"
Expected Response¶
Format:
application/jsonBody:
{
"message": "message"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not Found: Graph not found
DeleteGraph (GraphManagement Category)¶
Description¶
Delete a graph by name, including schema, indices and stored procedures.
HTTP Request¶
Method: DELETE
Endpoint:
/v1/graph/{graph_id}Content-type:
application/json
Curl Command Example¶
curl -X DELETE -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/graph/{graph_id}"
Expected Response¶
Format: application/json
Body:
{
"message": "message"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
GetGraphSchema (GraphManagement Category)¶
Description¶
Get the schema for the specified graph.
HTTP Request¶
Method: GET
Endpoint:
/v1/graph/{graph_id}/schemaContent-type:
application/json
Curl Command Example¶
curl -X GET -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/graph/{graph_id}/schema"
Expected Response¶
Format:
application/jsonBody:
{
"vertex_types": [
{
"type_id": 0,
"type_name": "person",
"properties": [
{
"property_id": 0,
"property_name": "id",
"property_type": {
"primitive_type": "DT_SIGNED_INT64"
}
},
{
"property_id": 1,
"property_name": "name",
"property_type": {
"string":{
"long_text": {}
}
}
},
{
"property_id": 2,
"property_name": "age",
"property_type": {
"string":{
"long_text": {}
}
}
}
],
"primary_keys": [
"id"
]
},
{
"type_id": 1,
"type_name": "software",
"properties": [
{
"property_id": 0,
"property_name": "id",
"property_type": {
"primitive_type": "DT_SIGNED_INT64"
}
},
{
"property_id": 1,
"property_name": "name",
"property_type": {
"string":{
"long_text": {}
}
}
},
{
"property_id": 2,
"property_name": "lang",
"property_type": {
"string":{
"long_text": {}
}
}
}
],
"primary_keys": [
"id"
]
}
],
"edge_types": [
{
"type_id": 0,
"type_name": "knows",
"vertex_type_pair_relations": [
{
"source_vertex": "person",
"destination_vertex": "person",
"relation": "MANY_TO_MANY",
}
],
"properties": [
{
"property_id": 0,
"property_name": "weight",
"property_type": {
"primitive_type": "DT_DOUBLE"
}
}
]
},
{
"type_id": 1,
"type_name": "created",
"vertex_type_pair_relations": [
{
"source_vertex": "person",
"destination_vertex": "software",
"relation": "ONE_TO_MANY",
}
],
"properties": [
{
"property_id": 0,
"property_name": "weight",
"property_type": {
"primitive_type": "DT_DOUBLE"
}
}
]
}
]
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not Found: Graph not found
GetGraphMeta (GraphManagement Category)¶
Description¶
Get the schema for the specified graph.
HTTP Request¶
Method: GET
Endpoint:
/v1/graph/{graph_id}Content-type:
application/json
Curl Command Example¶
curl -X GET -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/graph/{graph_id}"
Expected Response¶
Format:
application/jsonBody:
{
"id" : "123",
"name" : "example_graph",
"description": "A test description",
"store_type" : "mutable_csr",
"creation_time" : 11223444,
"data_update_time" : 11123445,
"data_import_config" : {},
"stored_procedures" : {},
"vertex_types": [
{
"type_id": 0,
"type_name": "person",
"properties": [
{
"property_id": 0,
"property_name": "id",
"property_type": {
"primitive_type": "DT_SIGNED_INT64"
}
},
{
"property_id": 1,
"property_name": "name",
"property_type": {
"string":{
"long_text": {}
}
}
},
{
"property_id": 2,
"property_name": "age",
"property_type": {
"string":{
"long_text": {}
}
}
}
],
"primary_keys": [
"id"
]
},
{
"type_id": 1,
"type_name": "software",
"properties": [
{
"property_id": 0,
"property_name": "id",
"property_type": {
"primitive_type": "DT_SIGNED_INT64"
}
},
{
"property_id": 1,
"property_name": "name",
"property_type": {
"string":{
"long_text": {}
}
}
},
{
"property_id": 2,
"property_name": "lang",
"property_type": {
"string":{
"long_text": {}
}
}
}
],
"primary_keys": [
"id"
]
}
],
"edge_types": [
{
"type_id": 0,
"type_name": "knows",
"vertex_type_pair_relations": [
{
"source_vertex": "person",
"destination_vertex": "person",
"relation": "MANY_TO_MANY",
}
],
"properties": [
{
"property_id": 0,
"property_name": "weight",
"property_type": {
"primitive_type": "DT_DOUBLE"
}
}
]
},
{
"type_id": 1,
"type_name": "created",
"vertex_type_pair_relations": [
{
"source_vertex": "person",
"destination_vertex": "software",
"relation": "ONE_TO_MANY",
}
],
"properties": [
{
"property_id": 0,
"property_name": "weight",
"property_type": {
"primitive_type": "DT_DOUBLE"
}
}
]
}
]
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not Found: Graph not found
ImportGraph (GraphManagement Category)¶
Description¶
Import data to empty graph. This is a non-blocking API as it will directly return the job id after the bulk loading job is created. Client can use the returned job_id to query the status of job or cancel a runing job.
HTTP Request¶
Method: POST
Endpoint:
/v1/graph/{graph_id}/dataloadingContent-type:
application/jsonBody:
{
"graph": "graph",
"loading_config": {
"data_source": {
"scheme": "file",
"location": "path_to_file",
},
"format": {
"metadata": {
"key": "metadata"
},
"type": "type"
},
"import_option": "init"
},
"edge_mappings": [
{
"column_mappings": [
{
"column": {
"index": 0,
"name": "name"
},
"property": "property"
},
{
"column": {
"index": 0,
"name": "name"
},
"property": "property"
}
],
"destination_vertex_mappings": [
{
"column": {
"index": 0,
"name": "name"
}
},
{
"column": {
"index": 0,
"name": "name"
}
}
],
"inputs": [
"inputs",
"inputs"
],
"source_vertex_mappings": [
{
"column": {
"index": 0,
"name": "name"
}
},
{
"column": {
"index": 0,
"name": "name"
}
}
],
"type_triplet": {
"destination_vertex": "destination_vertex",
"edge": "edge",
"source_vertex": "source_vertex"
}
},
{
"column_mappings": [
{
"column": {
"index": 0,
"name": "name"
},
"property": "property"
},
{
"column": {
"index": 0,
"name": "name"
},
"property": "property"
}
],
"destination_vertex_mappings": [
{
"column": {
"index": 0,
"name": "name"
}
},
{
"column": {
"index": 0,
"name": "name"
}
}
],
"inputs": [
"inputs",
"inputs"
],
"source_vertex_mappings": [
{
"column": {
"index": 0,
"name": "name"
}
},
{
"column": {
"index": 0,
"name": "name"
}
}
],
"type_triplet": {
"destination_vertex": "destination_vertex",
"edge": "edge",
"source_vertex": "source_vertex"
}
}
],
"vertex_mappings": [
{
"column_mappings": [
{
"column": {
"index": 0,
"name": "name"
},
"property": "property"
},
{
"column": {
"index": 0,
"name": "name"
},
"property": "property"
}
],
"inputs": [
"inputs",
"inputs"
],
"type_name": "type_name"
},
{
"column_mappings": [
{
"column": {
"index": 0,
"name": "name"
},
"property": "property"
},
{
"column": {
"index": 0,
"name": "name"
},
"property": "property"
}
],
"inputs": [
"inputs",
"inputs"
],
"type_name": "type_name"
}
]
}
Curl Command Example¶
curl -X POST -H "Content-Type: application/json" -d @path/to/json "http://{INTERACTIVE_ENDPOINT}/v1/graph/{graph_id}/dataloading"
Expected Response¶
Format:
application/jsonBody:
{
"message": "message"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not Found: Graph not found.
CreateProcedure (ProcedureManagement Category)¶
Description¶
Create a new stored procedure.
HTTP Request¶
Method: POST
Endpoint:
/v1/graph/{graph_id}/procedureContent-type:
application/jsonBody:
{
"bound_graph": "bound_graph",
"description": "description",
"enable": true,
"name": "name",
"query" : "MATCH(n) return COUNT(n);",
"type": "cypher"
}
Curl Command Example¶
curl -X POST -H "Content-Type: application/json" -d @/path/to/json "http://{INTERACTIVE_ENDPOINT}/v1/graph/{graph_id}/procedure"
Expected Response¶
Format: application/json
Body:
{
"message": "message"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not FOund: Graph not found.
ListAllProcedure (ProcedureManagement Category)¶
Description¶
List all procedures bound to a graph.
HTTP Request¶
Method: GET
Endpoint:
/v1/graph/{graph_id}/procedureContent-type:
application/json
Curl Command Example¶
curl -X GET -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/graph/{graph_id}/procedure"
Expected Response¶
Format: application/json
Body:
[
{
"bound_graph": "bound_graph",
"description": "description",
"enable": true,
"name": "name",
"params": [
{
"name": "name",
"type": "type"
},
{
"name": "name",
"type": "type"
}
],
"query": "query",
"returns": [
{
"name": "name",
"type": "type"
},
{
"name": "name",
"type": "type"
}
],
"type": "cpp"
}
]
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not Found: Graph not found
GetProcedure (ProcedureManagement Category)¶
Description¶
Get a single procedure’s metadata.
HTTP Request¶
Method: GET
Endpoint:
/v1/graph/{graph_id}/procedure/{procedure_id}Content-type:
application/json
Curl Command Example¶
curl -X GET -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/graph/{graph_id}/procedure/{procedure_id}"
Expected Response¶
Format: application/json
Body:
{
"bound_graph": "bound_graph",
"description": "description",
"enable": true,
"name": "name",
"params": [
{
"name": "name",
"type": "type"
},
{
"name": "name",
"type": "type"
}
],
"query": "query",
"returns": [
{
"name": "name",
"type": "type"
},
{
"name": "name",
"type": "type"
}
],
"type": "cpp"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
UpdateProcedure (ProcedureManagement Category)¶
Description¶
Update a procedure’s metadata, enable/disable status, description. The procedure’s name cannot be modified.
HTTP Request¶
Method: PUT
Endpoint:
/v1/graph/{graph_id}/procedure/{procedure_id}Content-type:
application/jsonBody:
{
"description": "description",
"enable": true,
}
Curl Command Example¶
curl -X PUT -H "Content-Type: application/json" -d @/path/to/json "http://{INTERACTIVE_ENDPOINT}//v1/graph/{graph_id}/procedure/{procedure_id}"
Expected Response¶
Format:
application/jsonBody:
{
"bound_graph": "bound_graph",
"description": "description",
"enable": true,
"name": "name",
"params": [
{
"name": "name",
"type": "type"
},
{
"name": "name",
"type": "type"
}
],
"query": "query",
"returns": [
{
"name": "name",
"type": "type"
},
{
"name": "name",
"type": "type"
}
],
"type": "cpp"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not Found: Graph or procedure not found.
DeleteProcedure (ProcedureManagement Category)¶
Description¶
Delete a procedure bound to the graph.
HTTP Request¶
Method: DELETE
Endpoint:
/v1/graph/{graph_id}/procedure/{procedure_id}Content-type:
application/json
Curl Command Example¶
curl -X DELETE -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/graph/{graph_id}/procedure/{procedure_id}"
Expected Response¶
Format: application/json
Body:
{
"message": "message"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not Found: Graph or procedure not found.
StartService (ServiceManagement Category)¶
Description¶
Start the query service on a graph. The graph_id param can be empty, indicating restarting on current running graph.
After the AdminService receives this request, the current actor scope for query actors will be cancelled.
During the scope cancellation process of the query actors or after scope cancellation is completed, all requests sent to the query_service will fail and be rejected. The response of the http request will be like
{
"code": 500,
"message" : "Unable to send message, the target actor has been canceled!"
}
After the previous graph is closed and new graph is opened, the new query actors will be available in a new scope.
The query service is now ready to serve requests on the new graph.
HTTP Request¶
Method: POST
Endpoint:
/v1/service/startContent-type:
application/jsonBody:
{
"graph_id": "modern_graph"
}
Curl Command Example¶
curl -X POST -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/service/start"
Expected Response¶
Format: application/json
Body:
{
"message": "message"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
RestartService (ServiceManagement Category)¶
Description¶
Restart the graph query service on current running graph.
HTTP Request¶
Method: POST
Endpoint:
/v1/service/restartContent-type:
application/jsonBody: EmptyBody.
Curl Command Example¶
curl -X POST "http://{INTERACTIVE_ENDPOINT}/v1/service/restart"
Expected Response¶
Format: application/json
Body:
"Successfully started service"
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
StopService (ServiceManagement Category)¶
Description¶
Stop the graph query service. Note that after service is stopped, the query server is still running, you still can submit queries to the endpoint, but you will receive the following error message to each request:
{
"code": 500,
"message" : "Unable to send message, the target actor has been canceled!"
}
HTTP Request¶
Method: POST
Endpoint:
/v1/service/stopContent-type:
application/jsonBody: EmptyBody.
Curl Command Example¶
curl -X POST "http://{INTERACTIVE_ENDPOINT}/v1/service/stop"
Expected Response¶
Format: application/json
Body:
Successfully stop service
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
ServiceStatus¶
Description¶
Get the status of current service.
HTTP Request¶
Method: GET
Endpoint:
/v1/service/statusContent-type:
application/json
Expected Response¶
Format: application/json
Body:
{
"graph_id": "graph_id",
"query_port": 6,
"status": "running"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
SystemMetrics (NodeMetrics Category)¶
Description¶
Get node status.
HTTP Request¶
Method: GET
Endpoint:
/v1/node/statusContent-type:
application/json
Curl Command Example¶
curl -X GET -H "Content-Type: application/json" "http://{INTERACTIVE_ENDPOINT}/v1/node/status"
Expected Response¶
Format: application/json
Body:
{
"cpu_usage": "0.2",
"memory_usage": "0.3"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
GetJobById (JobManagement Category)¶
Description¶
Get the metadata of a job with a unique job id. The job id is received when you launch a bulk loading job
HTTP Request¶
Method: GET
Endpoint:
/v1/job/{job_id}Content-type:
application/jsonBody : EmptyBody
Curl Command Example¶
curl -X GET "http://{INTERACTIVE_ENDPOINT}/v1/job/{job_id}"
Expected Response¶
Format: application/json
Body:
{
"detail": {
"graph_id": "graph_id"
},
"job_id": "job_{graph_id}_{create_timestamp}_{process_id}",
"log": "line1\nlin2...\n",
"start_time": 1706786404768, // create_timestamp
"status": "CANCELLED/RUNNING/SUCCESS/FAILED",
"type": "bulk_loading"
}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.404 Not Found: Job not found
GetAllJobs (JobManagement category)¶
Description¶
Get the metadata of all running/cancelled/success/failed jobs.
HTTP Request¶
Method: GET
Endpoint:
/v1/job/Content-type:
application/jsonBody : EmptyBody
Curl Command Example¶
curl -X GET "http://{INTERACTIVE_ENDPOINT}/v1/job/"
Expected Response¶
Format: application/json
Body:
[
{
"detail": {
"graph_id": "graph_id"
},
"job_id": "job_{graph_id}_{create_timestamp}_{process_id}",
"log": "line1\nlin2...\n",
"start_time": 1706786404768, // create_timestamp
"status": "CANCELLED/RUNNING/SUCCESS/FAILED",
"type": "bulk_loading"
}
]
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
CancelJobById (JobManagement category)¶
Description¶
Cancel a job according to the give job_id.
HTTP Request¶
Method: DELETE
Endpoint:
/v1/job/{job_id}Content-type:
application/jsonBody : EmptyBody
Curl Command Example¶
curl -X DELETE "http://{INTERACTIVE_ENDPOINT}/v1/job/{job_id}"
Expected Response¶
Format: application/json
Body:
Fail:
Job is not running, can not cancel: {job_id}
Success
Successfully cancelled job: {job_id}
Status Codes¶
200 OK: Request successful.500 Internal Error: Server internal Error.
Enable AdminService in development¶
To start admin service in development, use the command line argument --enable-admin-service true. ${ENGINE_CONFIG} specifies the configuration for interactive query engine, see engine-configuration. ${WORKSPACE} points to the directory where interactive related data is maintaned.
./bin/interactive_server -c ${ENGINE_CONFIG} -w ${WORKSPACE} --enable-admin-service true
Start Compiler Service¶
The Compiler service could be started as a subprocess of the AdminService. This ensures that when switching graphs in the AdminService, the Compiler service also switches to the corresponding graph’s schema. This is the default behavior in the current Interactive.
./bin/interactive_server -c ${ENGINE_CONFIG} -w ${WORKSPACE} --enable-admin-service true --start-compiler true
Http error code¶
Internally we use StatusCode to record the runtime errors.
The mapping between statusCode and http code is shown in the following table.
Code |
HTTP Code |
|---|---|
gs::StatusCode::OK |
200 |
gs::StatusCode::InValidArgument |
400 |
gs::StatusCode::UnsupportedOperator |
400 |
gs::StatusCode::AlreadyExists |
409 |
gs::StatusCode::NotExists |
404 |
gs::StatusCode::CodegenError |
500 |
gs::StatusCode::UninitializedStatus |
500 |
gs::StatusCode::InvalidSchema |
400 |
gs::StatusCode::PermissionError |
403 |
gs::StatusCode::IllegalOperation |
400 |
gs::StatusCode::InternalError |
500 |
gs::StatusCode::InvalidImportFile |
400 |
gs::StatusCode::IOError |
500 |
gs::StatusCode::NotFound |
404 |
gs::StatusCode::QueryFailed |
500 |
default |
500 |