Updated on 2024-01-04 GMT+08:00

Querying Edge Data in Batches

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

Parameter

Mandatory

Type

Description

edges

Yes

Object

Edge array to be queried

Table 3 edges parameter description

Parameter

Mandatory

Type

Description

source

Yes

String

Source vertex of an edge

target

Yes

String

Target vertex of an edge

index

No

String

Edge index

Response Parameters

Table 4 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 code.

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

Example Request

Query details about edges in batches based on the source vertex, target vertex, and index. The source nodes of the edges to be queried are 39631050_Landscape and 27803870_Landmark building.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query  
{
           "edges": [{
                "source": "39631050_Landscape",
                "target": "27803870_ Landmark building"
            },{
                "index": "0",
                "source": "27803870_Landmark building",
                "target": "27661363_ Jiuhua Hot Spring"
            }]
} 

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": [
            {
                "index": "24",
                "source": "39631050_Landscape",
                "label": "superclassOf",
                "properties": {
                    "popularity": [
                        0
                    ]
                },
                "target": "27803870_ Landmark building"
            },
            {
                "index": "0",
                "source": "27803870_Landmark building",
                "label": "superclassOf",
                "properties": {
                    "popularity": [
                        0
                    ]
                },
                "target": "27661363_ Jiuhua Hot Spring"
            }
        ]
    }
}

Status code: 400

Example response for a failed request
Http Status Code: 400
{
 "errorMessage":"parameter does not contain 'source'",
 "errorCode":"GES.8000"
}

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.

Error Codes

See Error Codes.