Adding an Edge (1.0.6)

Function

This API is used to add an edge.

URI

  • URI format
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges
  • 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

Request

  • Request example
    POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges
    
    {
         "source":"Lily",
         "target": "Rocky",
         "label": "rate",
         "properties": {"Score":[5],"Datetime":["2018-01-01 20:30:05"]},
         "parallelEdge": "override"
    }

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

  • Request body parameter description

    Parameter

    Mandatory

    Type

    Description

    source

    Yes

    String

    Source vertex name

    target

    Yes

    String

    Target vertex name

    label

    Yes

    String

    Label of a vertex. If no label exists, set it to __DEFAULT__.

    properties

    No

    Json

    Value of each property

    parallelEdge

    No

    String

    Processing mode of repetitive edges. The value can be allow, ignore, or override. allow indicates that repetitive edges are allowed. ignore indicates that subsequent repetitive edges are ignored. override indicates that the previous repetitive edges are overwritten. The default value is allow.

Response

  • 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.

    result

    No

    String

    If the execution is successful, the value of result is success.

  • Response example (successful request)
    Http Status Code: 200
    {
     "result":"success",
     "data":{"index":"0"}
    }
  • Response example (failed request)
    Http Status Code: 400
    {
     "errorMessage":"edge source vertex [Lily] does not exist",
     "errorCode":"GES.8000"
    }

Return Value

  • Normal

    200

  • Abnormal
    Table 2 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.