Function

This API is used to export a graph.

URI

• URI format

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

• Parameter description

  Table 1 URI parameter description

  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

Request

• Request example

  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"
  }

• Parameter description

  Table 2 Request body parameter description

  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

  

  • For details about the value validity of the graphExportPath character strings, see the OBS Object Name Restrictions.

Response

• Parameter description

  Table 3 Parameter description

  Parameter	Mandatory	Type	Description
  errorMessage	No	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	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  job_id	No	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.

• Response example (successful request)

  Http Status Code: 200
  {
    "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
  }

• Response example (failed request)

  Http Status Code: 400
  {
    "errorCode": "GES.8011",
    "errorMessage": "Failed to export a graph."
  }

Return Value

• Normal

  200

• Abnormal

  Table 4 Return code for failed requests

  Return Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	No operation permission.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	Service unavailable.