Deleting Edges in Batches

Function

This API is used to delete edges in batches based on the source vertices, target vertices, and indexes of the edges.

URI

• URI format

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete

• 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

  POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete
  {
  	"edges": [
  		{
                  "source": "39631050_Landscape",
                  "target": "27803870_ Landmark building"
  		},
  		{
  			"index": "0",
                  "source": "27803870_Landmark building",
  			"target": "27661363_Beijing Jiuhua Hot Spring"
  		}
  	],
  	"ignoreError": true
  }

  

  SERVER_URL: Address for accessing a graph. For details about its value, see Constraints of Using Service Plane APIs.

• Request body parameter description

  Table 2 Request body parameter description

  Parameter	Mandatory	Type	Description
  edges	Yes	Json	Edge array to be deleted
  executionMode	No	String	sync indicates the synchronous mode, and async indicates the asynchronous mode. The default value is sync.
  ignoreError	No	Boolean	Whether to ignore errors, for example, the edge to delete does not exist. The default value is false, indicating that errors will not be ignored. Errors in JSON format cannot be ignored.

  Table 3 edges parameter description

  Parameter	Mandatory	Type	Description
  source	Yes	String	Source vertex of an edge
  target	Yes	String	Target vertex of an edge
  index	No	String	Edge index
  label	No	String	Label of an edge. If the index parameter is set, this parameter is ignored. If the index parameter is not set, an edge that meets the source, target, and label conditions is deleted. If the specified label value does not exist in the schema or the edge with the same label does not exist, no edge will be deleted.

Response

• Sync mode

  Table 4 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.
  result	No	String	If the execution is successful, the value of result is success.

• Response example (successful request)

  Http Status Code: 200
  {
  "result": "success"
  }

• Response example (failed request)

  Http Status Code: 400
  {
   "errorMessage":"parameter does not contain 'source'",
   "errorCode":"GES.8000"
  }

• Async mode

  Table 5 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 deletion job. This parameter is left blank when the request fails. This ID can be used as a parameter to obtain the deletion result through the API for querying the job status.
  jobType	No	Integer	Job type. This parameter is left blank when the request fails.

• Response example (successful request)

  Http Status Code: 200
   {
   "jobId": "500dea8f-9651-41fe-8299-c20f13a032ea",
   "jobType": 3
   }

• Response example (failed request)

  Http Status Code: 400
   {
   "errorMessage": "graph [test_117d] is not found",
   "errorCode": "GES.8402"
   }