GraphScope FLEX HTTP SERVICE API

This is a specification for GraphScope FLEX HTTP service based on the OpenAPI 3.0 specification. You can find out more details about specification at doc.

Some useful links:

More information: https://helloreverb.com
Contact Info: [email protected]
Version: 1.0.0
BasePath:/GRAPHSCOPE/flex-api/1.0.0
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Alert

DataSource

Deployment

Graph

Job

Service

StoredProcedure

Utils

Alert

Up 
post /api/v1/alert/receiver
(createAlertReceiver)
Create a new alert receiver

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateAlertReceiverRequest (required)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully created the alert receiver APIResponse

500

Server error Error
Up 
delete /api/v1/alert/rule/{rule_id}
(delete alert rule by ID)

Path parameters

rule_id (required)
Path Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully deleted the alert rule APIResponse

500

Server error Error
Up 
delete /api/v1/alert/message-collection
(deleteAlertMessageInBatch)
Delete alert message in batch

Query parameters

message_ids (required)
Query Parameter — A list of message id separated by comma, e.g. id1,id2,id3

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully deleted the alert message APIResponse

500

Server error Error
Up 
delete /api/v1/alert/receiver/{receiver_id}
(deleteAlertReceiverById)
Delete the alert receiver by ID

Path parameters

receiver_id (required)
Path Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully deleted the alert receiver APIResponse

500

Server error Error
Up 
get /api/v1/alert/message
(listAlertMessages)
List all alert messages

Query parameters

alert_type (optional)
Query Parameter —
status (optional)
Query Parameter —
severity (optional)
Query Parameter —
start_time (optional)
Query Parameter — format with "2023-02-21-11-56-30"
end_time (optional)
Query Parameter — format with "2023-02-21-11-56-30"
limit (optional)
Query Parameter — format: int32

Return type

array[GetAlertMessageResponse]

Example data

Content-Type: application/json
[ {
  "severity" : "warning",
  "trigger_time" : "trigger_time",
  "metric_type" : "node",
  "id" : "id",
  "message" : "message",
  "alert_name" : "alert_name",
  "target" : [ "target", "target" ],
  "status" : "unsolved"
}, {
  "severity" : "warning",
  "trigger_time" : "trigger_time",
  "metric_type" : "node",
  "id" : "id",
  "message" : "message",
  "alert_name" : "alert_name",
  "target" : [ "target", "target" ],
  "status" : "unsolved"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the alert messages

Example data

Content-Type: application/json
[{"id":"ALERT-MESSAGE-QWERTYUIOP-1","alert_name":"HighDiskUtilization","severity":"warning","metric_type":"node","target":["hostname-1"],"trigger_time":"2023-02-21T11:56:30.000Z","status":"unsolved","message":"Disk usage node1 85.12%, exceeds threshold"},{"id":"ALERT-MESSAGE-QWERTYUIOP-2","alert_name":"HighDiskUtilization","severity":"emergency","metric_type":"node","target":["hostname-1"],"trigger_time":"2023-02-21T11:56:30.000Z","status":"solved","message":"Disk usage node1 85.12%, exceeds threshold"},{"id":"ALERT-MESSAGE-QWERTYUIOP-3","alert_name":"HighDiskUtilization","severity":"warning","metric_type":"node","target":["hostname-1"],"trigger_time":"2023-02-21T11:56:30.000Z","status":"dealing","message":"Disk usage node1 85.12%, exceeds threshold"}]

500

Server error Error
Up 
get /api/v1/alert/receiver
(listAlertReceivers)
List all alert receivers

Return type

array[GetAlertReceiverResponse]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the alert receivers

Example data

Content-Type: application/json
[{"id":"RECEIVER-QWERTYUIOP-1","type":"webhook","webhook_url":"http://webhook.com","is_at_all":false,"at_user_ids":[111111,222222],"enable":false},{"id":"RECEIVER-QWERTYUIOP-2","type":"webhook","webhook_url":"http://webhook.com","is_at_all":false,"at_user_ids":[111111,222222],"enable":true,"message":"error message"}]

500

Server error Error
Up 
get /api/v1/alert/rule
(listAlertRules)
List all alert rules

Return type

array[GetAlertRuleResponse]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the alert rules

Example data

Content-Type: application/json
[{"id":"ALERTRULE-1","name":"HighDiskUtilization","severity":"warning","metric_type":"node","conditions_description":"disk usage >= 85","enable":true},{"id":"ALERTRULE-2","name":"GremlinServiceAvailable","severity":"emergency","metric_type":"node","conditions_description":"g.V().limit(1) failed","enable":false}]

500

Server error Error
Up 
put /api/v1/alert/rule/{rule_id}
(update alert rule by ID)

Path parameters

rule_id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateAlertRuleRequest (optional)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully updated the alert rule APIResponse

500

Server error Error
Up 
put /api/v1/alert/message-collection/status
(updateAlertMessageInBatch)
Update the message status in batch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UpdateAlertMessageStatusRequest (optional)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation APIResponse

500

Server error Error
Up 
put /api/v1/alert/receiver/{receiver_id}
(updateAlertReceiverById)
Update alert receiver by ID

Path parameters

receiver_id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateAlertReceiverRequest (optional)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully updated the alert receiver APIResponse

500

Server error Error

DataSource

Up 
post /api/v1/graph/{graph_id}/datasource
(bindDatasourceInBatch)
Bind data sources in batches

Path parameters

graph_id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SchemaMapping (required)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful bind the data sources APIResponse

400

Bad request Error

500

Server error Error
Up 
get /api/v1/graph/{graph_id}/datasource
(getDatasourceById)
Get data source by ID

Path parameters

graph_id (required)
Path Parameter —

Return type

SchemaMapping

Example data

Content-Type: application/json
{
  "edge_mappings" : [ {
    "inputs" : [ "inputs", "inputs" ],
    "source_vertex_mappings" : [ null, null ],
    "destination_vertex_mappings" : [ null, null ],
    "column_mappings" : [ null, null ],
    "type_triplet" : {
      "edge" : "edge",
      "source_vertex" : "source_vertex",
      "destination_vertex" : "destination_vertex"
    }
  }, {
    "inputs" : [ "inputs", "inputs" ],
    "source_vertex_mappings" : [ null, null ],
    "destination_vertex_mappings" : [ null, null ],
    "column_mappings" : [ null, null ],
    "type_triplet" : {
      "edge" : "edge",
      "source_vertex" : "source_vertex",
      "destination_vertex" : "destination_vertex"
    }
  } ],
  "vertex_mappings" : [ {
    "type_name" : "type_name",
    "inputs" : [ "file:///path/to/file.csv", "file:///path/to/file.csv" ],
    "column_mappings" : [ {
      "column" : {
        "name" : "name",
        "index" : 0
      },
      "property" : "property"
    }, {
      "column" : {
        "name" : "name",
        "index" : 0
      },
      "property" : "property"
    } ]
  }, {
    "type_name" : "type_name",
    "inputs" : [ "file:///path/to/file.csv", "file:///path/to/file.csv" ],
    "column_mappings" : [ {
      "column" : {
        "name" : "name",
        "index" : 0
      },
      "property" : "property"
    }, {
      "column" : {
        "name" : "name",
        "index" : 0
      },
      "property" : "property"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful returned all data sources SchemaMapping

Example data

Content-Type: application/json
{"vertex_mappings":[{"type_name":"person","inputs":["file:///path/to/person.csv"],"column_mappings":[{"column":{"index":0,"name":"id"},"property":"id"},{"column":{"index":1,"name":"name"},"property":"name"}]},{"type_name":"software","inputs":["file:///path/to/software.csv"],"column_mappings":[{"column":{"index":0,"name":"id"},"property":"id"},{"column":{"index":1,"name":"name"},"property":"name"}]}],"edge_mappings":[{"type_triplet":{"edge":"knows","source_vertex":"person","destination_vertex":"person"},"inputs":["file:///path/to/knows.csv"],"source_vertex_mappings":[{"column":{"index":0,"name":"id"},"property":"id"}],"destination_vertex_mappings":[{"column":{"index":1,"name":"id"},"property":"id"}],"column_mappings":[{"column":{"index":2,"name":"weight"},"property":"weight"}]},{"type_triplet":{"edge":"created","source_vertex":"person","destination_vertex":"software"},"inputs":["file:///path/to/created.csv"],"source_vertex_mappings":[{"column":{"index":0,"name":"id"},"property":"id"}],"destination_vertex_mappings":[{"column":{"index":1,"name":"id"},"property":"id"}],"column_mappings":[{"column":{"index":2,"name":"weight"},"property":"weight"}]}]}

500

Server error Error
Up 
delete /api/v1/graph/{graph_id}/datasource/edge/{type_name}
(unbindEdgeDatasource)
Unbind datas ource on an edge type

Path parameters

graph_id (required)
Path Parameter —
type_name (required)
Path Parameter —

Query parameters

source_vertex_type (required)
Query Parameter —
destination_vertex_type (required)
Query Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully unbind the data source APIResponse

500

Server error Error
Up 
delete /api/v1/graph/{graph_id}/datasource/vertex/{type_name}
(unbindVertexDatasource)
Unbind data source on a vertex type

Path parameters

graph_id (required)
Path Parameter —
type_name (required)
Path Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully unbind the data source APIResponse

500

Server error Error

Deployment

Up 
get /api/v1/deployment
(getDeploymentInfo)
Deployment information

Return type

RunningDeploymentInfo

Example data

Content-Type: application/json
{
  "creation_time" : "creation_time",
  "instance_name" : "instance_name",
  "engine" : "Hiactor",
  "cluster_type" : "HOSTS",
  "storage" : "MutableCSR",
  "version" : "version",
  "frontend" : "Cypher/Gremlin"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the deployment information RunningDeploymentInfo

Example data

Content-Type: application/json
{"cluster_type":"HOSTS","creation_time":"2024-01-01T00:00:00.000Z","instance_name":"demo","frontend":"Cypher/Gremlin","engine":"Hiactor","storage":"MutableCSR","version":"0.27.0"}

500

Server error Error
Up 
get /api/v1/deployment/status
(getDeploymentStatus)
Deployment status

Return type

RunningDeploymentStatus

Example data

Content-Type: application/json
{
  "nodes" : [ "", "" ],
  "cluster_type" : "HOSTS"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the deployment status RunningDeploymentStatus

Example data

Content-Type: application/json
{"cluster_type":"HOSTS","nodes":[{"name":"HOSTNAME-1","cpu_usage":83,"memory_usage":37.5,"disk_usage":97}]}

500

Server error Error

Graph

Up 
post /api/v1/graph/{graph_id}/schema/edge
(createEdgeType)
Create a edge type

Path parameters

graph_id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateEdgeType (optional)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful created the edge type APIResponse

400

Bad request Error

500

Server error Error
Up 
post /api/v1/graph
(createGraph)
Create a new graph

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateGraphRequest (required)
Body Parameter —

Return type

CreateGraphResponse

Example data

Content-Type: application/json
{
  "graph_id" : "graph_id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The graph was created CreateGraphResponse

400

Bad request Error

500

Server error Error
Up 
post /api/v1/graph/{graph_id}/schema/vertex
(createVertexType)
Create a vertex type

Path parameters

graph_id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateVertexType (required)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful created a vertex type APIResponse

400

Bad request Error

500

Server error Error
Up 
delete /api/v1/graph/{graph_id}/schema/edge/{type_name}
(deleteEdgeTypeByName)
Delete edge type by name

Path parameters

graph_id (required)
Path Parameter —
type_name (required)
Path Parameter —

Query parameters

source_vertex_type (required)
Query Parameter —
destination_vertex_type (required)
Query Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful deleted the edge type APIResponse

500

Server error Error
Up 
delete /api/v1/graph/{graph_id}
(deleteGraphById)
Delete graph by ID

Path parameters

graph_id (required)
Path Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully deleted the graph APIResponse

500

Server error Error
Up 
delete /api/v1/graph/{graph_id}/schema/vertex/{type_name}
(deleteVertexTypeByName)
Delete vertex type by name

Path parameters

graph_id (required)
Path Parameter —
type_name (required)
Path Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful deleted the vertex type APIResponse

500

Server error Error
Up 
get /api/v1/graph/{graph_id}
(getGraphById)
Get graph by ID

Path parameters

graph_id (required)
Path Parameter —

Return type

GetGraphResponse

Example data

Content-Type: application/json
{
  "creation_time" : "creation_time",
  "schema" : {
    "vertex_types" : [ "", "" ],
    "edge_types" : [ "", "" ]
  },
  "stored_procedures" : [ "", "" ],
  "name" : "name",
  "description" : "description",
  "schema_update_time" : "schema_update_time",
  "id" : "id",
  "store_type" : "mutable_csr",
  "data_update_time" : "data_update_time"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the graph GetGraphResponse

Example data

Content-Type: application/json
{"id":"GRAPHID","name":"demo","creation_time":"2024-01-01 00:00:00","schema_update_time":"2024-01-02 00:00:00","data_update_time":"2024-01-03 00:00:00","stored_procedures":[{"id":"STORED-PROCEDURE-ID","name":"stored_procedure_name","type":"cypher","query":"MATCH(a) return COUNT(a);","library":"/path/to/library","params":[{"name":"param1","type":{"string":{}}}],"returns":[{"name":"return1","type":{"PrimitiveType":"DT_SIGNED_INT64"}}],"bound_graph":"demo","runnable":true}],"schema":{"vertex_types":[{"type_id":0,"type_name":"person","properties":[{"property_id":0,"property_name":"id","property_type":{"string":{}}},{"property_id":1,"property_name":"name","property_type":{"string":{}}}],"primary_keys":["id"]},{"type_id":1,"type_name":"software","properties":[{"property_id":0,"property_name":"id","property_type":{"string":{}}},{"property_id":1,"property_name":"name","property_type":{"string":{}}}],"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","x_csr_params":{"edge_storage_strategy":"ONLY_IN"}}],"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":"MANY_TO_MANY","x_csr_params":{"edge_storage_strategy":"ONLY_IN"}}],"properties":[{"property_id":0,"property_name":"weight","property_type":{"primitive_type":"DT_DOUBLE"}}]}]}}

500

Server error Error
Up 
get /api/v1/graph/{graph_id}/schema
(getSchemaById)
Get graph schema by ID

Path parameters

graph_id (required)
Path Parameter —

Return type

GetGraphSchemaResponse

Example data

Content-Type: application/json
{
  "vertex_types" : [ "", "" ],
  "edge_types" : [ "", "" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the graph schema GetGraphSchemaResponse

Example data

Content-Type: application/json
{"vertex_types":[{"type_id":0,"type_name":"person","properties":[{"property_id":0,"property_name":"id","property_type":{"string":{}}},{"property_id":1,"property_name":"name","property_type":{"string":{}}}],"primary_keys":["id"]},{"type_id":1,"type_name":"software","properties":[{"property_id":0,"property_name":"id","property_type":{"string":{}}},{"property_id":1,"property_name":"name","property_type":{"string":{}}}],"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","x_csr_params":{"edge_storage_strategy":"ONLY_IN"}}],"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":"MANY_TO_MANY","x_csr_params":{"edge_storage_strategy":"ONLY_IN"}}],"properties":[{"property_id":0,"property_name":"weight","property_type":{"primitive_type":"DT_DOUBLE"}}]}]}

500

Server error Error
Up 
post /api/v1/graph/{graph_id}/schema
(importSchemaById)
Import graph schema

Path parameters

graph_id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateGraphSchemaRequest (required)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful imported the graph schema APIResponse

400

Bad request Error

500

Server error Error
Up 
get /api/v1/graph
(listGraphs)
List all graphs

Return type

array[GetGraphResponse]

Example data

Content-Type: application/json
[ {
  "creation_time" : "creation_time",
  "schema" : {
    "vertex_types" : [ "", "" ],
    "edge_types" : [ "", "" ]
  },
  "stored_procedures" : [ "", "" ],
  "name" : "name",
  "description" : "description",
  "schema_update_time" : "schema_update_time",
  "id" : "id",
  "store_type" : "mutable_csr",
  "data_update_time" : "data_update_time"
}, {
  "creation_time" : "creation_time",
  "schema" : {
    "vertex_types" : [ "", "" ],
    "edge_types" : [ "", "" ]
  },
  "stored_procedures" : [ "", "" ],
  "name" : "name",
  "description" : "description",
  "schema_update_time" : "schema_update_time",
  "id" : "id",
  "store_type" : "mutable_csr",
  "data_update_time" : "data_update_time"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned all graphs

Example data

Content-Type: application/json
[{"id":"GRAPHID","name":"demo","creation_time":"2024-01-01 00:00:00","schema_update_time":"2024-01-02 00:00:00","data_update_time":"2024-01-03 00:00:00","stored_procedures":[{"id":"STORED-PROCEDURE-ID","name":"stored_procedure_name","type":"cypher","query":"MATCH(a) return COUNT(a);","library":"/path/to/library","params":[{"name":"param1","type":{"string":{}}}],"returns":[{"name":"return1","type":{"PrimitiveType":"DT_SIGNED_INT64"}}],"bound_graph":"demo","runnable":true}],"schema":{"vertex_types":[{"type_id":0,"type_name":"person","properties":[{"property_id":0,"property_name":"id","property_type":{"string":{}}},{"property_id":1,"property_name":"name","property_type":{"string":{}}}],"primary_keys":["id"]},{"type_id":1,"type_name":"software","properties":[{"property_id":0,"property_name":"id","property_type":{"string":{}}},{"property_id":1,"property_name":"name","property_type":{"string":{}}}],"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","x_csr_params":{"edge_storage_strategy":"ONLY_IN"}}],"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":"MANY_TO_MANY","x_csr_params":{"edge_storage_strategy":"ONLY_IN"}}],"properties":[{"property_id":0,"property_name":"weight","property_type":{"primitive_type":"DT_DOUBLE"}}]}]}}]

500

Server error Error

Job

Up 
delete /api/v1/job/{job_id}
(deleteJobById)
Delete job by ID

Path parameters

job_id (required)
Path Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfuly cancelled the job APIResponse

500

Server error Error
Up 
get /api/v1/graph/{graph_id}/dataloading/config
(getDataloadingJobConfig)
Get the data loading configuration

Path parameters

graph_id (required)
Path Parameter —

Return type

DataloadingJobConfig

Example data

Content-Type: application/json
{
  "schedule" : "schedule",
  "loading_config" : {
    "format" : {
      "metadata" : "",
      "type" : "type"
    },
    "import_option" : "overwrite"
  },
  "vertices" : [ {
    "type_name" : "type_name"
  }, {
    "type_name" : "type_name"
  } ],
  "repeat" : "once",
  "edges" : [ {
    "type_name" : "type_name",
    "source_vertex" : "source_vertex",
    "destination_vertex" : "destination_vertex"
  }, {
    "type_name" : "type_name",
    "source_vertex" : "source_vertex",
    "destination_vertex" : "destination_vertex"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the dataloading job configuration DataloadingJobConfig

500

Server error Error
Up 
get /api/v1/job/{job_id}
(getJobById)
Get job status by ID

Path parameters

job_id (required)
Path Parameter —

Return type

JobStatus

Example data

Content-Type: application/json
{
  "start_time" : "start_time",
  "log" : "log",
  "end_time" : "end_time",
  "id" : "id",
  "detail" : "",
  "type" : "type",
  "status" : "RUNNING"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the job status JobStatus

500

Server error Error
Up 
get /api/v1/job
(listJobs)
List all jobs

Return type

array[JobStatus]

Example data

Content-Type: application/json
[ {
  "start_time" : "start_time",
  "log" : "log",
  "end_time" : "end_time",
  "id" : "id",
  "detail" : "",
  "type" : "type",
  "status" : "RUNNING"
}, {
  "start_time" : "start_time",
  "log" : "log",
  "end_time" : "end_time",
  "id" : "id",
  "detail" : "",
  "type" : "type",
  "status" : "RUNNING"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful returned all the jobs

Example data

Content-Type: application/json
[{"id":"JOB-QWERTYUIOPASDFGH-1","type":"DATA IMPORT","status":"RUNNING","start_time":"2024-02-24T00:00:00.000Z","log":"logging...","detail":{"graph_name":"demo"}},{"id":"JOB-QWERTYUIOPASDFGH-2","type":"DATA IMPORT","status":"CANCELLED","start_time":"2024-02-24T00:00:00.000Z","log":"logging...","detail":{"graph_name":"demo"}},{"id":"JOB-QWERTYUIOPASDFGH-3","type":"DATA IMPORT","status":"SUCCESS","start_time":"2024-02-24T00:00:00.000Z","end_time":"2024-02-24T12:00:00.000Z","detail":{"graph_name":"demo"}},{"id":"JOB-QWERTYUIOPASDFGH-4","type":"DATA IMPORT","status":"FAILED","start_time":"2024-02-24T00:00:00.000Z","end_time":"2024-02-24T12:00:00.000Z","log":"logging...","detail":{"graph_name":"demo"}},{"id":"JOB-QWERTYUIOPASDFGH-5","type":"DATA IMPORT","status":"WAITING","detail":{"graph_name":"demo"}}]

500

Server error Error
Up 
post /api/v1/graph/{graph_id}/dataloading
(submitDataloadingJob)
Submit a dataloading job

Path parameters

graph_id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body DataloadingJobConfig (required)
Body Parameter —

Return type

CreateDataloadingJobResponse

Example data

Content-Type: application/json
{
  "job_id" : "job_id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully submitted the job CreateDataloadingJobResponse

400

Bad request Error

500

Server error Error

Service

Up 
get /api/v1/graph/{graph_id}/service
(getServiceStatusById)
Get service status by graph ID

Path parameters

graph_id (required)
Path Parameter —

Return type

ServiceStatus

Example data

Content-Type: application/json
{
  "start_time" : "start_time",
  "graph_id" : "graph_id",
  "sdk_endpoints" : {
    "gremlin" : "gremlin",
    "cypher" : "cypher",
    "hqps" : "hqps",
    "grpc" : "grpc"
  },
  "status" : "Running"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the service status ServiceStatus

Example data

Content-Type: application/json
{"graph_id":"GRAPHID","status":"Running","sdk_endpoints":{"cypher":"neo4j://mock.api.cypher:7676","gremin":"ws://mock.api.gremlin/gremlin","hqps":"http://mock.api.hqps:10000"},"start_time":"2024-01-01 00:00:00"}

500

Server error Error
Up 
get /api/v1/service
(listServiceStatus)
List all service status

Return type

array[ServiceStatus]

Example data

Content-Type: application/json
[ {
  "start_time" : "start_time",
  "graph_id" : "graph_id",
  "sdk_endpoints" : {
    "gremlin" : "gremlin",
    "cypher" : "cypher",
    "hqps" : "hqps",
    "grpc" : "grpc"
  },
  "status" : "Running"
}, {
  "start_time" : "start_time",
  "graph_id" : "graph_id",
  "sdk_endpoints" : {
    "gremlin" : "gremlin",
    "cypher" : "cypher",
    "hqps" : "hqps",
    "grpc" : "grpc"
  },
  "status" : "Running"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned all service status

Example data

Content-Type: application/json
[{"graph_id":"GRAPHID","status":"Running","sdk_endpoints":{"cypher":"neo4j://mock.api.cypher:7676","gremin":"ws://mock.api.gremlin/gremlin","hqps":"http://mock.api.hqps:10000"},"start_time":"2024-01-01 00:00:00"}]

500

Server error Error
Up 
post /api/v1/service/restart
(restartService)
Restart current service

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully restarted the service APIResponse

500

Server error Error
Up 
post /api/v1/service/start
(startService)
Start service

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body StartServiceRequest (optional)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully started the service APIResponse

400

Bad request Error

500

Server error Error
Up 
post /api/v1/service/stop
(stopService)
Stop current service

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully stopped the service APIResponse

500

Server error Error

StoredProcedure

Up 
post /api/v1/graph/{graph_id}/storedproc
(createStoredProcedure)
Create a new stored procedure on a certain graph

Path parameters

graph_id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body CreateStoredProcRequest (required)
Body Parameter —

Return type

CreateStoredProcResponse

Example data

Content-Type: application/json
{
  "stored_procedure_id" : "stored_procedure_id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully created a stored procedure CreateStoredProcResponse

400

Bad request Error

500

Server error Error
Up 
delete /api/v1/graph/{graph_id}/storedproc/{stored_procedure_id}
(deleteStoredProcedureById)
Delete a stored procedure by ID

Path parameters

graph_id (required)
Path Parameter —
stored_procedure_id (required)
Path Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully deleted the stored procedure APIResponse

500

Server error Error
Up 
get /api/v1/graph/{graph_id}/storedproc/{stored_procedure_id}
(getStoredProcedureById)
Get a stored procedure by ID

Path parameters

graph_id (required)
Path Parameter —
stored_procedure_id (required)
Path Parameter —

Return type

GetStoredProcResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully returned the stored procedure GetStoredProcResponse

Example data

Content-Type: application/json
{"id":"STORED-PROCEDURE-ID","name":"stored_procedure_name","type":"cypher","query":"MATCH(a) return COUNT(a);","library":"/path/to/library","params":[{"name":"param1","type":{"string":{}}}],"returns":[{"name":"return1","type":{"PrimitiveType":"DT_SIGNED_INT64"}}],"bound_graph":"demo","runnable":true}

500

Server error Error
Up 
get /api/v1/graph/{graph_id}/storedproc
(listStoredProcedures)
List all stored procedures on a certain graph

Path parameters

graph_id (required)
Path Parameter —

Return type

array[GetStoredProcResponse]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[{"id":"STORED-PROCEDUREID-1","name":"stored_procedure_name_1","type":"cypher","query":"MATCH(a) return COUNT(a);","library":"/path/to/library","params":[{"name":"param1","type":{"string":{}}}],"returns":[{"name":"return1","type":{"PrimitiveType":"DT_SIGNED_INT64"}}],"bound_graph":"demo","runnable":true},{"id":"STORED-PROCEDUREID-2","name":"stored_procedure_name_2","type":"cypher","query":"MATCH(a) return COUNT(a);","library":"/path/to/library","params":[{"name":"param1","type":{"string":{}}}],"returns":[{"name":"return1","type":{"PrimitiveType":"DT_SIGNED_INT64"}}],"bound_graph":"demo","runnable":false}]

400

Bad request Error

500

Server error Error
Up 
put /api/v1/graph/{graph_id}/storedproc/{stored_procedure_id}
(updateStoredProcedureById)
Update a stored procedure by ID

Path parameters

graph_id (required)
Path Parameter —
stored_procedure_id (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UpdateStoredProcRequest (optional)
Body Parameter —

Return type

APIResponse

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully updated the stored procedure APIResponse

500

Server error Error

Utils

Up 
post /api/v1/file/uploading
(uploadFile)

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

filestorage (required)
Form Parameter — format: binary

Return type

UploadFileResponse

Example data

Content-Type: application/json
{
  "file_path" : "file_path"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation UploadFileResponse

500

Server error Error

Models

[ Jump to Methods ]

Table of Contents

  1. APIResponse
  2. AnyValue
  3. BaseEdgeType
  4. BaseEdgeType_vertex_type_pair_relations
  5. BaseEdgeType_x_csr_params
  6. BasePropertyMeta
  7. BaseVertexType
  8. BaseVertexType_x_csr_params
  9. ColumnMapping
  10. ColumnMapping_column
  11. CreateAlertReceiverRequest
  12. CreateAlertRuleRequest
  13. CreateDataloadingJobResponse
  14. CreateEdgeType
  15. CreateGraphRequest
  16. CreateGraphResponse
  17. CreateGraphSchemaRequest
  18. CreatePropertyMeta
  19. CreateStoredProcRequest
  20. CreateStoredProcResponse
  21. CreateVertexType
  22. DataloadingJobConfig
  23. DataloadingJobConfig_edges
  24. DataloadingJobConfig_loading_config
  25. DataloadingJobConfig_loading_config_format
  26. DataloadingJobConfig_vertices
  27. EdgeMapping
  28. EdgeMapping_type_triplet
  29. Error
  30. GSDataType
  31. GetAlertMessageResponse
  32. GetAlertReceiverResponse
  33. GetAlertRuleResponse
  34. GetEdgeType
  35. GetGraphResponse
  36. GetGraphSchemaResponse
  37. GetPropertyMeta
  38. GetStoredProcResponse
  39. GetVertexType
  40. JobStatus
  41. LongText
  42. NodeStatus
  43. Parameter
  44. PrimitiveType
  45. RunningDeploymentInfo
  46. RunningDeploymentStatus
  47. SchemaMapping
  48. ServiceStatus
  49. ServiceStatus_sdk_endpoints
  50. StartServiceRequest
  51. StoredProcedureMeta
  52. StringType
  53. UpdateAlertMessageStatusRequest
  54. UpdateStoredProcRequest
  55. UploadFileResponse
  56. VertexMapping
  57. file_uploading_body

APIResponse Up

AnyValue Up

BaseEdgeType Up

type_name
String
vertex_type_pair_relations
array[BaseEdgeType_vertex_type_pair_relations]
directed (optional)
Boolean
primary_keys (optional)
array[String]

BaseEdgeType_vertex_type_pair_relations Up

source_vertex
String
destination_vertex
String
relation
String
Enum:
MANY_TO_MANY
ONE_TO_MANY
MANY_TO_ONE
ONE_TO_ONE
x_csr_params (optional)
BaseEdgeType_x_csr_params

BaseEdgeType_x_csr_params Up

Used for storage optimization
edge_storage_strategy (optional)
String
Enum:
ONLY_IN
ONLY_OUT
BOTH_OUT_IN

BasePropertyMeta Up

property_name
String
property_type
GSDataType
nullable (optional)
Boolean
default_value (optional)
AnyValue
description (optional)
String

BaseVertexType Up

type_name
String
primary_keys
array[String]
x_csr_params (optional)
BaseVertexType_x_csr_params

BaseVertexType_x_csr_params Up

Used for storage optimization
max_vertex_num (optional)
Integer

ColumnMapping Up

column
ColumnMapping_column
property
String must align with the schema

ColumnMapping_column Up

index (optional)
Integer format: int32
name (optional)
String

CreateAlertReceiverRequest Up

type
String
Enum:
webhook
webhook_url
String
at_user_ids
array[String]
is_at_all
Boolean
enable
Boolean

CreateAlertRuleRequest Up

name
String
severity
String
Enum:
warning
emergency
metric_type
String
Enum:
node
service
conditions_description
String
frequency
Integer (mins)
enable
Boolean

CreateDataloadingJobResponse Up

job_id
String

CreateEdgeType Up

properties
array[CreatePropertyMeta]
description (optional)
String
type_name
String
vertex_type_pair_relations
array[BaseEdgeType_vertex_type_pair_relations]
directed (optional)
Boolean
primary_keys (optional)
array[String]

CreateGraphRequest Up

name (optional)
String
description (optional)
String
stored_procedures (optional)
array[CreateStoredProcRequest]
schema (optional)
CreateGraphSchemaRequest

CreateGraphResponse Up

graph_id
String

CreateGraphSchemaRequest Up

vertex_types
array[CreateVertexType]
edge_types
array[CreateEdgeType]

CreatePropertyMeta Up

property_name
String
property_type
GSDataType
nullable (optional)
Boolean
default_value (optional)
AnyValue
description (optional)
String

CreateStoredProcRequest Up

name
String
description (optional)
String
type
String
Enum:
cpp
cypher
query
String

CreateStoredProcResponse Up

stored_procedure_id
String

CreateVertexType Up

properties
array[CreatePropertyMeta]
description (optional)
String
type_name
String
primary_keys
array[String]
x_csr_params (optional)
BaseVertexType_x_csr_params

DataloadingJobConfig Up

loading_config
DataloadingJobConfig_loading_config
vertices
array[DataloadingJobConfig_vertices]
edges
array[DataloadingJobConfig_edges]
schedule (optional)
String format with '2023-02-21 11:56:30'
repeat (optional)
String
Enum:
once
day
week

DataloadingJobConfig_edges Up

type_name (optional)
String
source_vertex (optional)
String
destination_vertex (optional)
String

DataloadingJobConfig_loading_config Up

import_option (optional)
String
Enum:
init
overwrite
example: overwrite
format (optional)
DataloadingJobConfig_loading_config_format

DataloadingJobConfig_loading_config_format Up

type (optional)
String
metadata (optional)
map[String, Object]

DataloadingJobConfig_vertices Up

type_name (optional)
String

EdgeMapping Up

type_triplet
EdgeMapping_type_triplet
inputs
array[String]
source_vertex_mappings
array[ColumnMapping]
destination_vertex_mappings
array[ColumnMapping]
column_mappings (optional)
array[ColumnMapping]

EdgeMapping_type_triplet Up

source label -> [edge label] -> destination label
edge
String
source_vertex
String
destination_vertex
String

Error Up

code
Integer Error code format: int32
message
String Error message

GSDataType Up

GetAlertMessageResponse Up

id
String Generated in server side
alert_name
String
severity
String
Enum:
warning
emergency
metric_type
String
Enum:
node
service
target
array[String]
trigger_time
String
status
String
Enum:
unsolved
solved
dealing
message
String

GetAlertReceiverResponse Up

id
String
message
String Error message generated in server side
type
String
Enum:
webhook
webhook_url
String
at_user_ids
array[String]
is_at_all
Boolean
enable
Boolean

GetAlertRuleResponse Up

id
String
name
String
severity
String
Enum:
warning
emergency
metric_type
String
Enum:
node
service
conditions_description
String
frequency
Integer (mins)
enable
Boolean

GetEdgeType Up

type_id
Integer format: int32
properties
array[GetPropertyMeta]
description (optional)
String
type_name
String
vertex_type_pair_relations
array[BaseEdgeType_vertex_type_pair_relations]
directed (optional)
Boolean
primary_keys (optional)
array[String]

GetGraphResponse Up

id
String
name
String
description (optional)
String
store_type (optional)
String
Enum:
mutable_csr
creation_time
String
data_update_time
String
schema_update_time
String
stored_procedures (optional)
array[GetStoredProcResponse]
schema
GetGraphSchemaResponse

GetGraphSchemaResponse Up

vertex_types
array[GetVertexType]
edge_types
array[GetEdgeType]

GetPropertyMeta Up

property_id
Integer format: int32
property_name
String
property_type
GSDataType
nullable (optional)
Boolean
default_value (optional)
AnyValue
description (optional)
String

GetStoredProcResponse Up

bound_graph
String
runnable
Boolean
id
String
library
String
params
array[Parameter]
returns
array[Parameter]

GetVertexType Up

type_id
Integer format: int32
properties
array[GetPropertyMeta]
description (optional)
String
type_name
String
primary_keys
array[String]
x_csr_params (optional)
BaseVertexType_x_csr_params

JobStatus Up

id
String
type
String
status
String
Enum:
RUNNING
SUCCESS
FAILED
CANCELLED
WAITING
start_time (optional)
String
end_time (optional)
String
log (optional)
String logview URL or log string
detail (optional)
map[String, Object]

LongText Up

long_text
String

NodeStatus Up

name
String
cpu_usage
Double format: double
memory_usage
Double format: double
disk_usage
Double format: double

Parameter Up

name
String
type
GSDataType

PrimitiveType Up

primitive_type
String
Enum:
DT_SIGNED_INT32
DT_UNSIGNED_INT32
DT_SIGNED_INT64
DT_UNSIGNED_INT64
DT_BOOL
DT_FLOAT
DT_DOUBLE

RunningDeploymentInfo Up

instance_name
String
cluster_type
String
Enum:
HOSTS
KUBERNETES
version
String
creation_time
String
frontend
String
Enum:
Cypher/Gremlin
AnalyticalApps
engine
String
Enum:
Hiactor
Gaia
storage
String
Enum:
MutableCSR

RunningDeploymentStatus Up

cluster_type
String
Enum:
HOSTS
KUBERNETES
nodes
array[null]
items oneOf: NodeStatus   

SchemaMapping Up

vertex_mappings
array[VertexMapping]
edge_mappings
array[EdgeMapping]

ServiceStatus Up

graph_id
String
status
String
Enum:
Running
Stopped
sdk_endpoints (optional)
ServiceStatus_sdk_endpoints
start_time (optional)
String

ServiceStatus_sdk_endpoints Up

cypher (optional)
String
gremlin (optional)
String
hqps (optional)
String
grpc (optional)
String

StartServiceRequest Up

graph_id (optional)
String

StoredProcedureMeta Up

id
String
library
String
params
array[Parameter]
returns
array[Parameter]
name
String
description (optional)
String
type
String
Enum:
cpp
cypher
query
String

StringType Up

string
Object
oneOf: LongText   

UpdateAlertMessageStatusRequest Up

message_ids
array[String]
status
String
Enum:
unsolved
solved
dealing

UpdateStoredProcRequest Up

description
String

UploadFileResponse Up

file_path
String

VertexMapping Up

type_name
String
inputs
array[String]
column_mappings
array[ColumnMapping]

file_uploading_body Up

filestorage (optional)
byte[] format: binary