更新时间:2022-04-12 GMT+08:00
分享

清空图(2.1.1)

URI

  • URI格式
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph
  • URI格式(一千亿边(公测版))
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph&clear-metadata=true
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

    项目编号,用于资源隔离。请参考获取项目ID

    graph_name

    String

    图名称。

请求

  • 请求样例
    POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph
    {
             "clearMetadata": true
    }
    表2 Body参数说明

    参数

    是否必选

    类型

    说明

    clearMetadata

    Bool

    是否需要清空schema数据,默认为false

响应

表3 要素说明

参数

是否必选

类型

说明

errorMessage

String

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

errorCode

String

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

job_id

String

执行该异步任务的jobId。

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

  • 请求成功样例
    Http Status Code: 200
    {
    "jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"
    }
  • 请求失败样例
    Http Status Code: 400
    {
       "errorCode": "GES.8012",
       "errorMessage": "graph [movie2] is not found"
    }

返回值

  • 正常

    200

  • 异常
    表4 异常返回值说明

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

close