文档首页/ 图引擎服务 GES/ API参考/ 管理面API（V2）/ 图管理API/ 导出图(1.0.5)
更新时间：2024-05-23 GMT+08:00
查看PDF
分享

导出图(1.0.5)

功能介绍

导出图。

持久化版自2.3.14版本起支持导出图功能。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

graph_id

是

String

图ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

参数

是否必选

参数类型

描述

graph_export_path

是

String

图的导出OBS路径。

edge_set_name

是

String

导出边的文件夹名称。

vertex_set_name

是

String

导出点的文件夹名称。

schema_name

是

String

导出元数据文件名。

paginate

否

paginate object

分页相关参数，内存版自2.3.11版本起导出图默认分页导出。
表4 paginate

参数

是否必选

参数类型

描述

enable

否

Boolean

是否开启分页，默认为true，不需要开启分页时，需显示声明为false。

说明：

持久化版暂不支持该参数。

row_count_per_file

否

Integer

按页导出时，每个文件最大行数，默认10000000。

num_thread

否

Integer

按页导出时，并行线程数，默认为8。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

job_id

String

执行该异步任务的jobId。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

系统提示信息。

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

error_msg

String

系统提示信息。

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

请求示例

导出图，图的导出OBS路径为demo_movie/，导出边文件名为set_edge，导出点文件名为set_vertex，导出元数据文件名为set_schema.xml。

POST http://Endpoint/v2/{project_id}/graphs{graph_id}/export-graph

{
  "graph_export_path" : "demo_movie/",
  "edge_set_name" : "set_edge",
  "vertex_set_name" : "set_vertex",
  "schema_name" : "set_schema.xml"
}

响应示例

状态码： 200

响应成功示例

{
  "job_id" : "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

状态码： 400

响应失败示例

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

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码。

父主题： 图管理API

相关文档