批量删除边

功能介绍

根据批量边的起点、终点以及索引，删除这些边。

URI

• URI格式

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

• 参数说明

  表1 URI参数说明

  参数	是否必选	类型	说明
  project_id	是	String	项目编号，用于资源隔离。请参考获取项目ID。
  graph_name	是	String	图名称。

请求

• 请求样例

  POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete
  {
  	"edges": [
  		{
  			"source": "39631050_景观",
  			"target": "27803870_地标建筑"
  		},
  		{
  			"index": "0",
  			"source": "27803870_地标建筑",
  			"target": "27661363_北京九华山庄温泉"
  		}
  	],
  	"ignoreError": true
  }

  

  SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

• Body参数说明

  表2 Body参数说明

  参数	是否必选	类型	说明
  edges	是	Json	待删除的边数组。
  executionMode	否	String	sync表示同步，async表示异步，默认为“sync”同步模式。
  ignoreError	否	Boolean	是否忽略错误，比如待删除的边不存在；默认值为false，不忽略，注意Json格式错误不会忽略。

  表3 edges参数说明

  参数	是否必选	类型	说明
  source	是	String	边的source节点。
  target	是	String	边的target节点。
  index	否	String	边的index。
  label	否	String	边的label，当存在index参数时会被忽略，当index不存在时会尝试删除同时满足source/target/label条件的一条边。label不存在于schema中或同label的边不存在时不会删除任何边。

响应

• 同步模式

  表4 要素说明

  参数	是否必选	类型	说明
  errorMessage	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。
  errorCode	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。
  result	否	String	成功时result值为success。

• 请求成功样例

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

• 请求失败样例

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

• 异步模式

  表5 要素说明

  参数	是否必选	类型	说明
  errorMessage	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。
  errorCode	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。
  job_id	否	String	执行删除任务ID。请求失败时，字段为空。后续可以用此ID作为参数通过“查询Job状态”接口获取删除结果
  jobType	否	Integer	任务类型。请求失败时，字段为空。

• 请求成功样例

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

• 请求失败样例

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