文档首页> 图引擎服务 GES> API参考> 业务面API> 内存版> 通过导入文件更新点边的指定属性(2.2.13)
更新时间:2023-07-24 GMT+08:00

通过导入文件更新点边的指定属性(2.2.13)

功能介绍

通过导入文件更新点边的指定属性。

为防止系统重启时,不能正常恢复更新图数据,建议在使用图期间,不要删除存储在OBS中的数据。

URI

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

参数

是否必选

类型

说明

project_id

String

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

graph_name

String

图名称。

请求示例

导入文件更新点边的指定属性,点文件目录为datasets/movie/movie.csv,点数据集格式为csv,边文件目录为datasets/movie/ranking_edge.csv,边数据集格式为csv。

POST http://Endpoint/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-properties
{
  "vertexsetPath": "datasets/movie/movie.csv",
  "vertexsetFormat": "csv",
  "vertexProperties": [
    {
      "label": "movie",
      "properties": [
        "genres"
      ]
    }
  ],  
  "edgesetPath": "datasets/movie/ranking_edge.csv",
  "edgesetFormat": "csv",
  "edgeProperties": [
    {
      "label": "rate",
      "properties": [
        "Datetime"
      ]
    }
  ],
  "targetProperties": [
    {
      "label": "rate",
      "properties": [
        "Rating"
      ]
    }
  ],
  "delimiter": ",",
  "trimQuote": "\"",
  "obsParameters": {
	"accessKey": "XXXXXXX",
	"secretKey": "XXXXXXX"
  },
  "vertexFileContainLabel":  true
}

请求参数

导入文件更新属性的csv文件格式如下:

  • 点文件(包含label):点ID,label,property_1,…property_n
  • 点文件(不包含label):点ID,property_1,…property_n
  • 边文件:源点ID,目的点ID,label,边ID属性,property_1,…property_n
表2 Body参数说明

参数

是否必选

类型

说明

vertexsetPath

vertexsetPath和edgesetPath至少有一个

String

点文件目录或点文件名。

vertexsetFormat

String

点数据集格式。当前仅支持csv。

默认为csv。

vertexProperties

有vertexsetPath则必选

Object

点文件中点的label和待更新属性列表信息,JsonArray格式。请参见表3

edgesetPath

vertexsetPath和edgesetPath至少有一个

String

边文件目录或边文件名。

edgesetFormat

String

边数据集格式。当前仅支持csv。

默认为csv。

edgeProperties

有edgesetPath则必选

Object

边文件中边的label和待更新属性列表信息,JsonArray格式。请参见表4

targetProperties

有edgesetPath则必选

Object

边文件中用于区分重复边的属性信息,JsonArray格式。请参见表5

delimiter

Character

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

trimQuote

Character

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

obsParameters

String

OBS认证参数。请参见表6

vertexFileContainLabel

Boolean

点文件是否包含label信息。可选选项,默认值是true。

表3 vertexProperties参数说明

参数

是否必选

类型

说明

label

String

label名称。

properties

Object

待更新属性列表,需要与点文件中属性顺序一致,JsonArray格式。

表4 edgeProperties参数说明

参数

是否必选

类型

说明

label

String

label名称。

properties

Object

待更新属性列表,需要与边文件中属性顺序一致,JsonArray格式。

表5 targetProperties参数说明

参数

是否必选

类型

说明

label

String

label名称。

properties

Object

边ID属性信息,JsonArray格式。当前仅支持一个属性

表6 obsParameters参数说明

参数

是否必选

类型

说明

accessKey

string

ak值。

secretKey

string

sk值。

响应参数

表7 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

jobId

String

执行该异步任务的jobId。

说明:

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

响应示例

状态码: 200

成功响应示例
Http Status Code: 200
{
  "jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"
}

状态码: 400

失败响应示例

Http Status Code: 400
{
  "errorMessage": "parameter format error",
  "errorCode": "GES.8013"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码