文档首页/ 图引擎服务 GES/ API参考/ 业务面API/ 内存版/ 图操作API/ 导出图（1.0.5）
更新时间：2023-09-15 GMT+08:00
查看PDF
分享

导出图（1.0.5）

如果将导出的CSV文件下载到本地，默认会用系统的Excel软件打开（推荐使用文本编辑器打开）。如果数据中包含“+”、“-”、“=”、“@”等特殊字符，会被Excel解析为公式。为了保证系统安全，请打开文件时注意以下事项：
  1. 不要启用“启用动态数据交换服务器启动（不推荐）”配置。
  2. 打开CSV文件弹窗提醒安全问题时，不要选择“启用”或者“是”。

URI

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

参数

是否必选

类型

说明

project_id

是

String

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

graph_name

是

String

图名称。

请求参数

表2 Body参数说明

参数

是否必选

类型

说明

graphExportPath

是

String

图的导出OBS路径。

edgeSetName

是

String

导出边数据集名称。

vertexSetName

是

String

导出点数据集名称。

schemaName

是

String

导出元数据文件名。

paginate(2.3.11)

否

Object

分页相关参数，自2.3.11版本起导出图默认分页导出。

obsParameters

是

String

Obs相关参数。

accessKey

是

String

用户的accessKey。

secretKey

是

String

用户的secretKey。
表3 参数paginate中各要素说明

参数

是否必选

类型

说明

enable

否

Bool

是否开启分页，默认为true。

不需要开启分页时，需输入值为false。

rowCountPerFile

否

Int

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

numThread

否

Int

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

maxSizePerFile

否

Int

按页导出时每个文件大小的最大值，单位是byte，默认不超过导入时最大文件约束。

响应参数

表4 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

jobId

String

执行该异步任务的jobId。

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

请求示例

  • 请求示例1，进行导出图操作，图的导出OBS路径为demo_movie/，导出边数据集名称为set_edge，导出点数据集名称为set_vertex，导出元数据文件名为set_schema.xml。 
    POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph
{
  "graphExportPath": "demo_movie/",
  "edgeSetName": "set_edge",
  "vertexSetName": "set_vertex",
  "schemaName": "set_schema.xml",
  "paginate":{
    "numThread":16,
    "rowCountPerFile":1000000
},
  "obsParameters": {
    "accessKey": "xxxxxx",
    "secretKey": "xxxxxx"
  }
}
  • 请求示例2 
    POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph
{
  "graphExportPath": "demo_movie/",
  "edgeSetName": "set_edge.csv",
  "vertexSetName": "set_vertex.csv",
  "schemaName": "set_schema.xml",
  "obsParameters": {
    "accessKey": "xxxxxx",
    "secretKey": "xxxxxx"
  }
}

响应示例

状态码： 200

成功响应示例

Http Status Code: 200
{
"jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"
}

状态码： 400

失败响应示例 
Http Status Code: 400
{
   "errorCode": "GES.8011",
   "errorMessage": "graph [movie2] is not found"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题： 图操作API

相关文档