Adding a Vertex Label

Updated on 2025-03-05 GMT+08:00

View PDF

This API is used to add a vertex label.

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name
vertex_id	Yes	String	Vertex ID

**Table 2** Request body parameter
Parameter	Mandatory	Type	Description
label	Yes	String	Vertex label

**Table 3** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.

Add a vertex label named user.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels
{
    "label":"user"
}

NOTE:

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Status code: 200

Example response (successful request)

Http Status Code: 200
{
}

Status code: 400

Example response (failed request)

Http Status Code: 400
{
 "errorMessage": "Same label [user] already exists",
 "errorCode": "GES.8213"
}

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authentication failed.
403 Forbidden	No operation permission.
404 Not Found	The requested resource was not found.
500 Internal Server Error	Internal service error.
503 Service Unavailable	Service unavailable.