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

更新label

功能介绍

以覆盖的方式修改label，修改label只影响元数据，不影响已存在点边。已存在点边属性依然维持旧label格式，新添加（或覆盖）的点边以最新label格式写入。

URI

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

参数

是否必选

类型

说明

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

graph_name

是

String

图名称。

label

是

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参数说明。

注意：如果修改label打乱了原有属性的次序，比如在原属性列表中间插入新属性，或者删除属性，那么数据导出后，此label下的旧的点边依然以旧label的格式导出，与导出的scheam不匹配。无法再导入。如果在原label末尾新增属性，则所有导出数据皆可导入，不受影响。

表4 property参数说明

参数

是否必选

类型

说明

name

是

String

属性名称。

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

cardinality

是

String

属性的复合类型，当前仅支持single。

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 : book 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