更新时间:2024-05-23 GMT+08:00

HyG图数据同步

功能介绍

将图数据库的更新信息同步到HyG计算引擎。

URI

POST /ges/v1.0/{project_id}/hyg/{graph_name}/sync
表1 路径参数

参数

是否必选

类型

说明

project_id

String

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

graph_name

String

图名称。

请求参数

表2 Body参数说明

参数

是否必选

类型

说明

vertex

Json

点属性列表,如果列表为空,则不会同步点属性。参数详见vertex、edge参数说明

首次执行数据同步时,该参数生效,后续执行数据同步,该参数默认跟首次指定的保持一致。

edge

Json

边属性列表,如果列表为空,则不会同步边属性。参数详见vertex、edge参数说明

首次执行数据同步时,该参数生效,后续执行数据同步,该参数默认跟首次指定的保持一致。

表3 vertex、edge参数说明

参数

是否必选

类型

说明

label

String

label名称。

property

Array of strings

属性名称,属性要隶属于该标签。

响应参数

表4 要素说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

jobId

String

执行该异步任务的jobId。

说明:

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

图数据库中的悬空边(边存在,但是边的source节点或target节点不存在)不会同步到HyG引擎。

请求示例

图数据库的更新信息同步到HyG计算引擎,点属性列表为空,边属性列表的属性名称为“Rating”、label名称为“rate”。

POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/sync
{
    "vertex": [],
    "edge": [
        {
            "property": [
                "Rating"
            ],
            "label": "rate"
        }
    ]
}

SERVER_URL:图的访问地址,取值请参考业务面API使用限制

响应示例

状态码: 200

成功响应示例

Http Status Code: 200
{
   "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

状态码: 400

失败响应示例

Http Status Code: 400
{
    "errorCode": "GES.8011",
    "errorMessage": "graph : movie2 is not exist"
}

状态码

返回

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码