Querying Vertex Data 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

• URI format

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

• 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

Request

• Request example

  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 Constraints of Using Service Plane APIs.

• Request body parameter description

  Table 2 Request body parameter description

  Parameter	Mandatory	Type	Description
  vertices	Yes	String	Vertex ID array to be queried

Response

• Parameter description

  Table 3 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	The data field is contained when the query is successful, and the data field contains the vertices query result.
  result	Yes	String	Query result. If the query is successful, the value is success. If the query fails, the value is failed.

• Response example (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" 
   }

• Response example (failed request)

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