Exporting a Graph (1.0.5)

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 parameter descriptions
Parameter	Mandatory	Type	Description
graphExportPath	Yes	String	OBS path to which a graph is exported
edgeSetName	Yes	String	Name of the folder where the edges are exported
vertexSetName	Yes	String	Name of the folder where the vertices are exported
schemaName	Yes	String	Name of the exported metadata file
paginate(2.3.11)	No	Object	Pagination-related parameters. In version 2.3.11 or later, graphs are exported on multiple pages by default.
obsParameters	Yes	String	OBS parameters
accessKey	Yes	String	User AK
secretKey	Yes	String	User SK

**Table 3** Elements of the paginate parameter
Parameter	Mandatory	Type	Description
enable	No	Bool	Whether to enable pagination. The default value is true. If pagination is not required, set this parameter to false.
rowCountPerFile	No	Int	Maximum number of rows in each file when graphs are exported by page. The default maximum value is 10000000.
numThread	No	Int	Number of concurrent threads when graphs are exported by page. The default value is 8.
maxSizePerFile	No	Int	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.

Response Parameters

**Table 4** Response body parameter descriptions
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.
jobType	Integer	Job type. This parameter is left blank if the request fails.

Example Request

Example request 1: Export a graph. The OBS path for exporting the graph is demo_movie/, the name of the folder where the edges are exported is set_edge, the name of the folder where the vertices are exported 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":16,
    "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 (successful request)

Http Status Code: 200
{
    "jobId": "9874990c-b2c5-4e8b-96f3-10a9c46fe3a6000003836",
    "jobType": 1
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
 "errorMessage": "Not found. Please check the input parameters.",
 "errorCode": "GES.8000"
}

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.