Exporting a Graph

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
graphExportPath	Yes	String	OBS path to which a graph is exported
edgeSetName	Yes	String	Name of the exported edge data set
vertexSetName	Yes	String	Name of the exported vertex data set
schemaName	Yes	String	Name of the exported metadata file
obsParameters	Yes	String	OBS parameters
accessKey	Yes	String	User AK
secretKey	Yes	String	User SK

Response Parameters

**Table 3** Response body parameters
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 code. 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 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

Example request 2

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph
{
  "graphExportPath": "demo_movie/",
  "edgeSetName": "set_edge.csv",
  "vertexSetName": "set_vertex.csv",
  "schemaName": "set_schema.xml",
  "obsParameters": {
    "accessKey": "xxxxxx",
    "secretKey": "xxxxxx"
  }
}

Example Response

Status code: 200

Example response (successful request)

Http Status Code: 200
{
"jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
   "errorCode": "GES.8011",
   "errorMessage": "graph [movie2] is not found"
}

Status Codes

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.