Querying Labels
Function
This API is used to query a label.
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 |
label_name |
Yes |
String |
Label name |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
data |
data Object |
Query results. This parameter is left blank when the request fails. |
result |
String |
Request result. If the request is successful, the value is success. If the request fails, the value is failed. |
errorMessage |
String |
System prompt
|
errorCode |
String |
System prompt code
|
Parameter |
Type |
Description |
---|---|---|
properties |
Object |
Property array. |
type |
String |
Label type, indicating that the label is used for vertices or edges. |
Example Request
Query labels.
GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName}

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.
Example Response
Status code: 200
Example response (successful request)
Http Status Code: 200 { "data": { "type": "vertex", "properties": [ { "name": "Rating", "type": "int", "cardinality": "single" }, { "name": "Datetime", "type": "string", "cardinality": "single" } ] }, "result": "success" }
Status code: 400
Example response (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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot