Batch Querying Edges

Function

This API is used to query the detailed information about edges in batches based on the source vertices, target vertices, and indexes of the edges. Information about edges and properties is returned.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query

**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 parameter description
Parameter	Mandatory	Type	Description
edges	Yes	List	Edge array to be queried

**Table 3** edges parameter descriptions
Parameter	Mandatory	Type	Description
source	Yes	String	Source vertex of an edge
target	Yes	String	Target vertex of an edge
label	No	String	Edge label
sortKey	No	String	Sort key of duplicate edges. The options are Integer, String, and varString. If this parameter is set, label must also be set. The type must be the same as that of sortKey set during graph creation, except when null is assigned.

Response Parameters

**Table 4** Response body parameter descriptions
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	String	The data field is contained when the query is successful, and the data field contains the edges query result.
result	String	Query result. If the query is successful, the value is success. If the query fails, the value is failed.

Example Request

Query details about edges in batches based on the source vertex, target vertex, and index. The source vertex of the edges to be queried is Vivian.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query  
{
    "edges": [
           {
               "source": "Vivian",
               "target": "Lethal Weapon",
               "label": "rate"
           },
           {
               "source": "Vivian",
               "target": "Raising Arizona"
           }
       ]
}

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": "Vivian",
                "target": "Raising Arizona",
                "label": "rate",
                "sortKeyType":"abc",
                "properties": {
                    "Score": [
                        4
                    ],
                    "Datetime": [
                        "2000-12-27 23:51:42"
                    ]
                }
            },
            {
                "source": "Vivian",
                "target": "Lethal Weapon",
                "label": "rate",
                "sortKeyType":"bbb",
                "properties": {
                    "Score": [
                        5
                    ],
                    "Datetime": [
                        "2000-12-27 23:44:41"
                    ]
                }
            }
        ]
    },
    "result": "success"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
    "errorMessage": "parameter [source] does not exist",
    "errorCode": "GES.8000",
    "result": "failed"
}

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.