Querying Edge Details

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

GET /ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&label={label}&sortKey={sortKey}&sortKeyType={sortKeyType}

**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

Request Parameters

**Table 2** Request body 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
sourceVertex	Yes	String	Source vertex of an edge
targetVertex	Yes	String	Target vertex of an edge
Label (for database edition)	No	String	Label of an edge
sortKey (for database edition)	No	String	Sort key value of duplicate edges.
sortKeyType (for database edition)	No	String	Sort key type of duplicate edges. The options include int, string, null, and varString. This parameter is mandatory when sortKey is set. It must be the same as that of sortKey set during graph creation, except null.

Response Parameters

**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. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
data	Object	Query results. If the query is successful, the query result will be returned. If the query fails, this parameter will be left blank.
result	String	Query result. If the query is successful, the value is success. If the query fails, the value is failed.

**Table 4** data parameter description
Parameter	Mandatory	Type	Description
edges	Yes	List	Edge result set. If no edge is found, this parameter will be left blank.

Example Request

Query details about an edge.

GET/ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail? source=46&&target=39&&label=rate&&sortKey=5&&sortKeyType=int

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

Example Response

Status code: 200

Example response for a successful request

{
    "data": {
        "edges": [
            {
                "source": "46",
                "target": "39",
                "label": "rate",
                "sortKey": 5,
                "properties": {
                    "Rating": [
                        5
                    ],
                    "Datetime": [
                        "2018-01-0120:30:05"
                    ]
                }
            }
        ]
    },
    "result": "success"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
"errorMessage":"graph [demo] is not found",
"errorCode":"GES.8107"
}

Status Codes

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.