Querying General Information About a HyG Graph

Function

This API is used to query general information about a HyG graph, such as the number of vertices, number of edges, properties, and partitioning policies.

URI

GET /ges/v1.0/{project_id}/hyg/{graph_name}/summary

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name

Request Parameters

None

Response Parameters

**Table 2** Response body parameters
Parameter	Type	Description
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.
data	Object	If the query is successful, the data field is returned. For details about the parameters, see Table 3.
status	String	Job status returned for a successful query. Possible values are waiting, running, and complete. This parameter is left blank when the query fails.
result	String	Execution results If the execution is successful, the value is success. If the execution fails, the value is failed.

**Table 3** data parameter description
Parameter	Type	Description
vertex	JSON	Vertex labels and properties
edge	JSON	Edge labels and properties
policy	String	Partitioning policy
inEdge	Boolean	Whether incoming edges are contained
idIndex	Boolean	Whether the vertex ID index is contained
updateTime	String	Time when a graph is updated
vertexNum	Integer	Number of vertices
edgeNum	Integer	Number of edges

Example Request

Query general information about a HyG graph.

GET http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/summary

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": {
        "inEdge": true,
        "idIndex": true,
        "policy": "oec",
        "updateTime": "2023-08-03 15:13:16",
        "vertex": [],
        "edge": [
            {
                "label": "rate",
                "property": [
                    "Rating"
                ]
            }
        ],
        "vertexNum": 150,
        "edgeNum": 1659
    },
    "result": "success"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
     "status": "complete",
     "errorCode": "GES.8011",
     "errorMessage": "graph [movie2] is not found",
     "result": "failed"
}

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.