Querying Vertex Details

Function

This API is used to query the vertex information (such as the label and property) based on the vertex ID.

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds={vertex_ids}

**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
vertex_ids	Yes	String	IDs of the vertices to be queried. When multiple IDs are specified by vertexIds, separate the IDs with commas (,) in the URL.

Request Parameters

**Table 2** Request body parameter
Parameter	Type	Description
data	List	Vertex details you want to query. For details, see data parameters.

**Table 3** data parameter description
Parameter	Type	Description
vertices	List	Vertex result set. If no corresponding vertices are found, the value of vertices is empty.

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	Object	Query results.

Example Request

Query node information by node ID and return node details.

GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds=Ray

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": "Ray",
                "label": "user",
                "properties": {
                    "Occupation": [
                        "college/grad student"
                    ],
                    "Name": [
                       "Lei"
                    ],
                    "Zip-code": [
                        "90241"
                    ],
                    "Gender": [
                        "M"
                    ],
                    "Age": [
                        "18-24"
                    ]
                }
            }
        ]
    }
}

Status code: 400

Example response for a failed request

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

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.