Querying General Information About a Graph (1.0.0)

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 (2.2.14)	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.

Request Parameters

None

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 code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
data	Object	Query results. This parameter is left blank when the request fails.

**Table 3** data parameter description
Parameter	Type	Description
vertexNum	Integer	Number of vertices in a graph
edgeNum	Integer	Number of edges in a graph
labelDetails (2.2.14)	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 execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.

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

Response example 1 of a successful request (The numbers of vertices and edges under each label are returned.)

Http Status Code: 200
{
    "data": {
        "vertexNum": 146,
        "labelDetails": {
            "labelInVertex": {
                "movie": 46,
                "user": 100
            },
            "labelInEdge": {
                "default": 450,
                "rate": 1209
            }
        },
        "edgeNum": 1659
    }
}

Response example 2 of a successful request (The numbers of vertices and edges under each label fail to be returned.)

Http Status Code: 200
{
    "data": {
        "vertexNum": 146,
        "labelDetails": {
            "errorMessage": "Label index in vertices is not found.Label index in edges is not found.",
            "errorCode": "GES.8017"
        },
        "edgeNum": 1659
    }
}

Example response 3 of a successful request (Only the number of vertices under each label is returned.)

Http Status Code: 200
{
    "data": {
        "vertexNum": 146,
        "labelDetails": {
            "errorMessage": "Label index in edges is not found.",
            "labelInVertex": {
                "movie": 46,
                "user": 100
            },
            "errorCode": "GES.8017"
        },
        "edgeNum": 1659
    }
}

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.