更新时间:2023-07-19 GMT+08:00

批量删除边(2.1.9)

功能介绍

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

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete
表1 路径参数

参数

是否必选

类型

说明

project_id

String

项目ID。获取方法请参见获取项目ID

graph_name

String

图名称。

请求示例

批量删除边,边的起点分别为39631050_景观和27803870_地标建筑,边的终点分别为27803870_地标建筑和27661363_山庄温泉。

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使用限制

请求参数

表2 Body参数说明

参数

是否必选

类型

说明

edges

Object

待删除的边数组。

executionMode(2.2.14)

String

sync表示同步,async表示异步,默认为“sync”同步模式。

ignoreError(2.2.17)

Boolean

是否忽略错误,比如待删除的边不存在;默认值为false,不忽略,注意Json格式错误不会忽略。

表3 edges参数说明

参数

是否必选

类型

说明

source

String

边的source节点。

target

String

边的target节点。

index

String

边的index。

label(2.2.17)

String

边的label,当存在index参数时会被忽略,当index不存在时会尝试删除同时满足source/target/label条件的一条边。label不存在于schema中或同label的边不存在时不会删除任何边。

响应参数及示例

  • 同步模式
    表4 响应Body参数说明

    参数

    类型

    说明

    errorMessage

    String

    系统提示信息。

    • 执行成功时,字段可能为空。
    • 执行失败时,用于显示错误信息。

    errorCode

    String

    系统提示信息。

    • 执行成功时,字段可能为空。
    • 执行失败时,用于显示错误码。

    result

    String

    响应结果。成功时result值为success,失败时值为failed。

    状态码: 200

    成功响应示例
    Http Status Code: 200
    {
    "result": "success"
    }

    状态码: 400

    失败响应示例

    Http Status Code: 400
    {
     "errorMessage":"parameter does not contain 'source'",
     "errorCode":"GES.8000"
    }
  • 异步模式(2.2.14)
    表5 响应Body参数说明

    参数

    是否必选

    类型

    说明

    errorMessage

    String

    系统提示信息。

    • 执行成功时,字段可能为空。
    • 执行失败时,用于显示错误信息。

    errorCode

    String

    系统提示信息。

    • 执行成功时,字段可能为空。
    • 执行失败时,用于显示错误码。

    jobId

    String

    执行删除任务ID。

    请求失败时,该字段为空。后续可以用此ID作为参数通过“查询Job状态”接口获取删除结果。

    jobType

    Integer

    任务类型。请求失败时,该字段为空。

    状态码: 200

    成功响应示例

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

    状态码: 400

    失败响应示例

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

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码