Querying General Information About a Graph

Function

This API is used to query the general information about a graph, such as the numbers of vertices and edges.

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details={labelDetails}

**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_details	No	Boolean	Whether to return the number of vertices and edges under each label. The default value is false. If this parameter is set to true, the numbers of vertices and edges under each label are returned.

To return the count of vertices under different labels, when creating a vertex index, set the index type to GlobalCompositeVertexIndex, ensure that hasLabel is true, and keep the property list empty. Refer to Creating an Index for detailed instructions on how to create an index.
To return the count of edges under different labels, when creating an edge index, set the index type to GlobalCompositeEdgeIndex, ensure that hasLabel is true, and keep the property list empty. Refer to Creating an Index for detailed instructions on how to create an index.

Response Parameters

**Table 2** Response body parameter descriptions
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. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
jobId	String	ID of an asynchronous job The API for querying the job ID is called to check the task execution status and obtain the returned result. For details, see Querying Job Status on the Service Plane (1.0.0). For details about the calling result parameters, see Table 3.

**Table 3** data parameter descriptions
Parameter	Type	Description
vertexNum	Integer	Number of vertices in a graph. In multi-label scenarios, the value is repeatedly counted based on the number of label occurrences. To count the actual number of vertices, run the *match (n) where n is not null return count()** statement.
edgeNum	Integer	Number of edges in a graph
labelDetails	Object	Numbers of vertices and edges under each label. This parameter is available only when label_details in the URL is set to true.

**Table 4** Description of each element in labelDetails when the execution is successful
Parameter	Type	Description
labelInVertex	Object	Numbers of vertices under each label.
labelInEdge	Object	Numbers of edges under each label.
errorMessage	String	System prompt. When there is no vertex index or edge index, an error message is displayed. Otherwise, the field remains empty.
errorCode	String	System prompt. When there is no vertex index or edge index, an error code is displayed. Otherwise, the field remains empty.

Example Request

Query general information about a graph, such as the numbers of vertices and edges. The value true indicates that the numbers of vertices and edges of different labels are returned.

GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details=true

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
{
"jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
    "errorMessage": "Parameter error!",
    "errorCode": "GES.8005"
}

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.