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
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. You can specify only one vertex ID for a database edition graph. |
Request Parameters
Parameter |
Type |
Description |
---|---|---|
data |
List |
Vertex details you want to query. For details, see data parameters. |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
errorMessage |
String |
System prompt.
|
errorCode |
String |
System prompt.
|
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
![](https://support.huaweicloud.com/eu/api-ges/public_sys-resources/note_3.0-en-us.png)
SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.
Example Response
Status code: 200
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. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.