Help Center> Graph Engine Service> API Reference> Service Plane APIs> Vertex Operation APIs> Adding a Vertex Label (1.1.6)
View PDF

Adding a Vertex Label (1.1.6)

Function

This API is used to add a vertex label.

URI

  • URI format 
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels
  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.

    graph_name

    Yes

    String

    Graph name

    vertex_id

    Yes

    String

    Vertex name

Request

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

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

  • Parameter description
    Table 2 Request body parameter description

    Parameter

    Mandatory

    Type

    Description

    label

    Yes

    String

    Vertex label

Response

  • Parameter description
    Table 3 Parameter description

    Parameter

    Mandatory

    Type

    Description

    errorMessage

    No

    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

    No

    String

    System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  • Response example (successful request) 
    Http Status Code: 200
{
}
  • Response example (failed request) 
    Http Status Code: 400
{
 "errorMessage": "Same label [user] already exists",
 "errorCode": "GES.8213"
}

Return Value

  • Normal

    200

  • Abnormal
Table 4 Return code for failed requests

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.
Parent topic: Vertex Operation APIs