Updated on 2024-05-23 GMT+08:00

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

labelDetails

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.

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.

Response Parameters

Table 2 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.

  • 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 description

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) return count(*) statement.

edgeNum

Integer

Number of edges in a graph

labelDetails

Object

Numbers of vertices and edges under each label. To properly display this parameter, create vertex and edge indexes based on Table 4.

Table 4 Description of each element in labelDetails when the execution is successful

Parameter

Type

Description

labelInVertex

Object

Number of vertices under each label. If the number of vertices under a label is 0, the label is not displayed.

To include this parameter in the response, create an index by referring to Creating an Index (1.1.6). During index creation, set indexType to GlobalCompositeVertexIndex, set hasLabel to true, and leave indexProperty blank.

labelInEdge

Object

Number of edges under different labels. If the number of edges under a label is 0, the label is not displayed.

To include this parameter in the response, create an index by referring to Creating an Index (1.1.6). During index creation, set indexType to GlobalCompositeEdgeIndex, set hasLabel to true, and leave indexProperty blank.

errorMessage

String

System prompt

  • If the execution is successful, this parameter is empty.
  • If the execution fails, this parameter is used to display the error message.

errorCode

String

System prompt code

  • If the execution is successful, this parameter is empty.
  • If the execution fails, this parameter is used to display the error code.

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": "graph [demo] is not found",
    "errorCode": "GES.8001"
}

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.