Help Center/ Graph Engine Service/ API Reference (Kuala Lumpur Region)/ Management Plane APIs/ Graph Management APIs/ Exporting a Graph
Updated on 2022-08-09 GMT+08:00
View PDF
Share

Exporting a Graph

Function

This API is used to export a graph.

URI

POST /v1.0/{project_id}/graphs/{graph_id}/action

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.

graph_id

Yes

String

Graph ID
Table 2 Query parameters

Parameter

Mandatory

Type

Description

action_id

Yes

String

Graph action ID

The value can be:

  • export-graph

Request Parameters

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

graphExportPath

Yes

String

OBS path to which a graph is exported

edgeSetName

Yes

String

Exported edge file name

vertexSetName

Yes

String

Exported vertex file name

schemaName

Yes

String

Name of the exported metadata file

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Type

Description

errorMessage

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.

errorCode

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.

jobId

String

ID of an asynchronous job

NOTE:

You can view the job execution status and obtain the return result by querying the job ID. For details, see Job Management APIs.

Example Request

POST http://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=export-graph

{
  "graphExportPath" : "demo_movie/",
  "edgeSetName" : "set_edge.csv",
  "vertexSetName" : "set_vertex.csv",
  "schemaName" : "set_schema.xml"
}

Example Response

Status code: 200

OK

{
  "jobId" : "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

Status code: 400

Bad Request

{
  "errorMessage" : "graph [demo] is not found",
  "errorCode" : "GES.8011"
}

Status Code

Status Code

Description

200

OK

400

Bad Request
Parent topic: Graph Management APIs