Help Center> Graph Engine Service> API Reference> Service Plane APIs> Edge Operation APIs> Querying Edge Details (1.0.0)
View PDF

Querying Edge Details (1.0.0)

Function

This API is used to query the detailed information about an edge based on the source vertex, target vertex, and index of the edge. Information about edges and properties is returned.

URI

  • URI format 
    GET /ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&index={index}
  • 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

    sourceVertex

    Yes

    String

    Source vertex of an edge

    targetVertex

    Yes

    String

    Target vertex of an edge

    index

    No

    Integer

    Edge index. If this parameter is not set, all edges between the source and target vertices are queried

Request

  • Request example 
    GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source=Ray&target=Rocky&index=6

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

Response

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

data

No

Json

Query results. This parameter is left blank when the query fails.
Table 3 data parameter description

Parameter

Mandatory

Type

Description

edges

Yes

List

Edge result set. If no corresponding edges are found, the value of edges is empty.
  • Response example (successful request) 
    Http Status Code: 200

{
    "data": {
        "edges": [
            {
                "index": "6",
                "source": "Ray",
                "label": "rate",
                "properties": {
                    "Score": [
                        3
                    ],
                    "Datetime": [
                        "2000-11-22 19:23:05"
                    ]
                },
                "target": "Rocky"
            }
        ]
    }
}
  • Response example (failed request) 
    Http Status Code: 400
{
"errorMessage":"graph [demo] is not found",
"errorCode":"GES.8107"
}

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: Edge Operation APIs