Updated on 2025-03-05 GMT+08:00

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:

  1. Do not select Enable Dynamic Data Exchange Server Launch (not recommended).
  2. 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 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

obsParameters, accessKey, and secretKey are mandatory in OBS scenarios and optional in HDFS scenarios.

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
    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 (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.

Error Codes

See Error Codes.