Exporting Filtered Vertices

Function

This API is used to export the vertex set that meets the filter criteria.

URI

URI format

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

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_name	Yes	String	Graph name

Request

Request example (Only the asynchronous mode is supported.)

POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=export
  {
	"labels": [
		"movies",
		"user"
	],
	"vertexFilters": [
		{
			"propertyName": "Age",
			"predicate": "=",
			"values": [
				"18-24"
			]
		}
	],
	"exportPath": "demo_movie/",
	"fileName": "export_movie_and_user.csv",
	"obsParameters": {
		"accessKey": "XXXX",
		"secretKey": "XXXX"
	}
  }

Parameter description

**Table 2** Request body parameter description
Parameter	Mandatory	Type	Description
labels	Either labels or vertexFilters is mandatory.	String	Filter criteria of the vertex type
vertexFilters	Either labels or vertexFilters is mandatory.	Json	Filter criteria, in JSONArray format. Vertices are filtered by property. For details, see Table 4.
exportPath	Yes	String	Export path
fileName	No	String	Name of the exported file
obsParameters	Yes	String	OBS authentication parameters. For details, see Table 3.

Response

**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 the edge query 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": "03e774f5-29ea-4187-9508-5435f3892ead016886200",
  "jobType": 1
}

Response example (failed request)

Http Status Code: 400
{
  "errorMessage": "Bad Request, parameter labels and vertexFilters cannot all be null",
  "errorCode": "GES.8203"
}

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	Service internal error.
503 Service Unavailable	Service unavailable.