Help Center/ Graph Engine Service/ API Reference/ Service Plane APIs/ Database Edition/ Vertex Operation APIs/ Querying Vertices in Batches
Updated on 2024-01-04 GMT+08:00
View PDF

Querying Vertices in Batches

Function

This API is used to query the vertex data (such as the labels and properties) in batches based on the vertex IDs.

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/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

vertices

Yes

String

Vertex IDs you use to query the vertices

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

The data field is contained when the query is successful, and the data field contains the vertices query result.

result

String

Query results. If the request is successful, the value is success. If the request fails, the value is failed.

Example Request

Query nodes in batches by node ID. The vertex IDs to be queried are 27003509_Station Building and 39636392_Badaling Great Wall.

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-query  
{
  "vertices":
 ["27003509_Station Building",
 "39636392_Badaling Great Wall"]
}

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

Http Status Code: 200
{
    "data": {
        "vertices": [
            {
                "id": "27003509_Station Building",
                "label": "tag",
                "properties": {
                    "popularity": [
                        0
                    ],
                    "name": [
                        "Station Building"
                    ],
                    "alias": [
                        "Guanghua Road Office",
                        "Headquarters",
                        "Giant Underpants",
                        "Headquarters Building"
                    ]
                }
            },
            {
                "id": "39636392_Badaling Great Wall",
                "label": "tag",
                "properties": {
                    "popularity": [
                        0
                    ],
                    "name": [
                       "Badaling Great Wall"
                    ],
                    "alias": [
                        "Great Wall"
                    ]
                }
            }
        ]
    },
     "result": "success" 
 }

Status code: 400

Example response for a failed request

Http Status Code: 400
{
  "errorMessage": " Bad Request, parameter vertices cannot be null",
  "errorCode": "GES.8214"
}

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.

Parent topic: Vertex Operation APIs