Querying Labels

Function

This API is used to query labels.

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName}

**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
label_name	Yes	String	Label name

Response Parameters

**Table 2** Response parameters
Parameter	Type	Description
data	data Object	Query result. This parameter is left blank when the request fails.
result	String	Request result. The value is success for a successful request and failed for a failed request.
errorMessage	String	System prompt If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code.

**Table 3** data
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 for a 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 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.