文档首页/ 图引擎服务 GES/ API参考/ 管理面API（V2）/ 图管理API/ 清空图(2.1.2)
更新时间：2024-04-28 GMT+08:00
查看PDF
分享

清空图(2.1.2)

功能介绍

清空图中所有数据。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/graphs/{graph_id}/clear-graph

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

graph_id

是

String

图ID。
表2 Query参数

参数

是否必选

参数类型

描述

clear_metadata

否

Boolean

是否清空图关联的元数据，建议清空。取值为“true”或者“false”。默认为“false”。

  • true：表示清空
  • false：表示不清空

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

执行该异步任务的jobId。

说明：

可以查询jobId查看任务执行状态、获取返回结果，详情参考Job管理API。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

系统提示信息。

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

error_msg

String

系统提示信息。

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

请求示例

清空图中所有数据。

POST http://Endpoint/v2/{project_id}/graphs/{graph_id}/clear-graph?clear_metadata=true

{ }

响应示例

状态码： 200

成功响应示例

{
  "job_id" : "ff8080816025a0a1016025a5a2700007"
}

状态码： 400

失败响应示例

{
  "error_msg" : "graph [demo] is not found",
  "error_code" : "GES.8012"
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码。

父主题： 图管理API

相关文档