Exporting a Graph

If you choose to export CSV files to your local host, the files are opened using the spreadsheet software by default. You are advised to open the files in a text editor. If the data contains special characters such as plus signs (+), minus signs (-), equal signs (=), and at signs (@), the data will be parsed into formulas by the software. To ensure system security, pay attention to the following when opening such files:

Do not select Enable Dynamic Data Exchange Server Launch (not recommended).
Do not select Enable or Yes if a dialog box indicating a security issue is displayed.

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 a graph is exported to
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
paginate	No	Object	Pagination parameters. For details, see paginate parameter description.
obsParameters	Yes	String	OBS parameters. For details, see obsParameters parameter description.
accessKey	Yes	String	User AK
secretKey	Yes	String	User SK

**Table 3** paginate parameter description
Parameter	Mandatory	Type	Description
rowCountPerFile	No	Integer	Maximum number of rows in each file when graphs are exported by page. The default value is 1000000.
numThread	No	Integer	Number of concurrent threads when graphs are exported by page. The default value is 8. The maximum value cannot exceed the number of kernels.
maxSizePerFile	No	Integer	Maximum size of each file when graphs are exported by page, in bytes. By default, the size cannot exceed the maximum size of the file that was imported.

**Table 4** obsParameters parameter description
Parameter	Mandatory	Type	Description
accessKey	Yes	string	AK
secretKey	Yes	string	SK

Response Parameters

**Table 5** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt code 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

Export a graph. The OBS path for exporting the graph is demo_movie/, the name of the exported edge data set is set_edge, the name of the exported vertex data set is set_vertex, and the name of the exported metadata file is set_schema.xml.

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

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",
  "vertexSetName": "set_vertex",
  "schemaName": "set_schema.xml",
  "obsParameters": {
    "accessKey": "xxxxxx",
    "secretKey": "xxxxxx"
  }
}

Example Response

Status code: 200

Example response for a 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.8301",
   "errorMessage": "Graph [10001-movie] does not exist, please check project_id and graph_name."
}

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.