导出图(1.0.5)
功能介绍
导出图。

持久化版自2.3.14版本起支持导出图功能。
URI
POST /v2/{project_id}/graphs/{graph_id}/export-graph
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目编号。获取方法,请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母和数字组成,且长度为[1-64]个字符。 默认取值: 不涉及。 |
graph_id | 是 | String | 参数解释: 图ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
graph_export_path | 是 | String | 参数解释: 图的导出OBS路径。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
edge_set_name | 是 | String | 参数解释: 导出边的文件夹名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
vertex_set_name | 是 | String | 参数解释: 导出点的文件夹名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
schema_name | 是 | String | 参数解释: 导出元数据文件名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
paginate | 否 | paginate object | 参数解释: 分页相关参数,内存版自2.3.11版本起导出图默认分页导出。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 | 参数类型 | 描述 |
|---|---|---|
job_id | String | 参数解释: 执行该异步任务的jobId。 取值范围: 不涉及。 |
状态码: 400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释: 系统提示信息。
取值范围: 不涉及。 |
error_msg | String | 参数解释: 系统提示信息。
取值范围: 不涉及。 |
请求示例
导出图,图的导出OBS路径为demo_movie/,导出边文件名为set_edge,导出点文件名为set_vertex,导出元数据文件名为set_schema.xml。
POST https://{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": "The export path cannot be empty.",
"error_code": "GES.7243"
} 状态码
返回值 | 说明 |
|---|---|
400 Bad Request | 请求错误 |
401 Unauthorized | 鉴权失败 |
403 Forbidden | 没有操作权限 |
404 Not Found | 找不到资源 |
500 Internal Server Error | 服务内部错误 |
503 Service Unavailable | 服务不可用 |
错误码
请参见错误码。

