文档首页/ 图引擎服务 GES/ API参考/ 业务面API/ 持久化版/ 元数据操作API/ 更新label
更新时间：2024-12-03 GMT+08:00
查看PDF
分享

更新label

功能介绍

持久化版版本更新label的方式为全量覆盖。更新label只影响之后创建的点边，不影响已存在的点边。

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName}
表1 路径参数

参数

是否必选

类型

说明

project_id

是

String

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

graph_name

是

String

图名称。

label_name

是

String

Label名称。

请求参数

表2 Body参数说明

参数

是否必选

类型

说明

type

否

String

Label类别，表示此label用于点或边，取值如下：

  • “vertex”：表示label用于点。
  • “edge”：表示label用于边。
  • “all”：表示label用于点和边。

默认值为all。

properties

是

Object

待更新的属性数组。具体数组内参数介绍表3。
表3 properties参数说明

参数

是否必选

类型

说明

property

否

Object

label的属性。具体参数介绍请见表4 property参数说明。
表4 property参数说明

参数

是否必选

类型

说明

name

是

String

属性名称。

  1. property name的长度不能超过256。
  2. property name不允许包含<, >, &, ascci码14,15和30。
  3. 同一个label下不允许存在相同的property。

cardinality

是

String

属性的复合类型，包括：

  • single
  • list
  • set

dataType

是

String

属性的数据类型。具体请参考持久化版规格说明中的元数据类型。

响应参数

表5 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

result

String

响应结果。成功时result值为success，失败时值为failed。

请求示例

更新label，label的名称为book。

POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName}
{
  "type": "vertex",
  "properties": [
    {
      "property": {
        "name": "Title",
        "cardinality": "single",
        "dataType": "string"
      }
    },
    {
      "property": {
        "name": "Version",
        "cardinality": "single",
        "dataType": "string"
      }
    }
  ]
}

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

响应示例

状态码： 200

成功响应示例

Http Status Code: 200
{
 "result": "success"
}

状态码： 400

失败响应示例 
Http Status Code: 400
{
  "errorMessage": "label : undefinedLabel not exist",
  "errorCode": "GES.8703",
  "result": "failed"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题： 元数据操作API

相关文档