文档首页/图引擎服务 GES/API参考/业务面API/持久化版/图操作API/导入图
更新时间：2025-12-19 GMT+08:00
查看PDF
分享

导入图

URI

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

参数

是否必选

类型

说明

project_id

是

String

参数解释：

项目编号。获取方法，请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母和数字组成，且长度为[1-64]个字符。

默认取值：

不涉及。

graph_name

是

String

图名称。

请求参数

表2 Body参数说明

参数

是否必选

类型

说明

edgesetPath

否

String

edgesetPath、vertexsetPath、schemaPath三选一。

边文件目录或边文件名。

edgesetFormat

否

String

边数据集格式，当前支持csv和txt。

默认为csv。

vertexsetPath

否

String

edgesetPath、vertexsetPath、schemaPath三选一。

点文件目录或点文件名。

vertexsetFormat

否

String

点数据集格式，当前支持csv和txt。

默认为csv。

schemaPath

否

String

edgesetPath、vertexsetPath、schemaPath三选一。

新增数据的元数据文件OBS路径。

logDir

否

String

导入图日志存放目录，用于存储导入失败的数据和详细错误原因。

parallelEdge

否

Object

重复边处理。

action

否

String

重复边的处理方式，取值为override，表示覆盖之前的重复边，取值为ignore表示忽略重复边，即选择ignore时，当边已经存在，则会忽略，不会覆盖。

ignoreLabel

否

Boolean

重复边的定义，是否忽略Label。取值为false。

false 表示重复边定义包含Label，即用<源点，终点，Label>标记一条边。

delimiter

否

Character

csv格式文件字段分隔符，默认值为逗号（,）。list/set类型的字段内元素分隔符默认为分号（;）。

trimQuote

否

Character

csv格式文件字段包围符，默认值为双引号（"）。用来包围一个字段，如字段中含有分隔符或者换行等。

offline

否

Boolean

是否离线导入，取值为false。

false表示在线导入，相对离线导入，在线导入速度略慢，但导入过程中图并未锁定，可读不可写。

obsParameters

是

Object

Obs相关参数。2.4.17及以上版本图支持通过委托访问OBS，使用委托时该参数非必选，委托详情见创建OBS委托。

表3 parallelEdge参数类型

参数

是否必选

类型

说明

sortKeyColumn

否

Int/String

sortKey在边文件中的列数，sortKeyColumn从1开始，如果填“last Column”，则为最后一列。

可选值为：

  • 正整数 （Int类型）
  • “正整数”（String类型）
  • “lastColumn”
表4 obsParameters参数类型

参数

是否必选

类型

说明

accessKey

是

String

用户的accessKey。

secretKey

是

String

用户的secretKey。

响应参数

表5 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

jobId

String

执行该异步任务的jobId。

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

请求示例

进行导入图操作，边文件目录为testbucket/demo_movie/edges/，边数据集格式为csv，点文件目录为testbucket/demo_movie/vertices/，点数据集格式为csv，新增数据的元数据文件OBS路径为testbucket/demo_movie/incremental_data_schema.xml，日志存放目录为testbucket/importlogdir。

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-graph
{
  "edgesetPath": "testbucket/demo_movie/edges/",
  "edgesetFormat": "csv",
  "vertexsetPath": "testbucket/demo_movie/vertices/",
  "vertexsetFormat": "csv",
  "schemaPath": "testbucket/demo_movie/incremental_data_schema.xml",
  "logDir": "testbucket/importlogdir",
  "parallelEdge": {
    "action": "override",
    "ignoreLabel": false
  },
  "delimiter": ",",
  "trimQuote": "\"",
  "offline": false,
  "obsParameters": {
    "accessKey": "xxxxxx",
    "secretKey": "xxxxxx"
  }
}

响应示例

状态码： 200

成功响应示例

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

状态码： 400

失败响应示例

Http Status Code: 400
{
    "errorMessage": "Parameter error!",
    "errorCode": "GES.8005"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题：图操作API