Listing HyG Graphs

Function

This API is used to list HyG graphs.

URI

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

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

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.
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
name	String	Graph name
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

List HyG graphs.

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

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": [
        {
            "name": "test",
            "inEdge": true,
            "idIndex": true,
            "policy": "oec",
"vertexNum": 0,
            "edgeNum": 0
        },
        {
            "name": "movie",
            "inEdge": true,
            "idIndex": false,
            "policy": "oec",
            "updateTime": "2023-11-15 18:11:00",
            "vertex": [],
            "edge": [],
            "vertexNum": 146,
            "edgeNum": 1659
        }
    ],
    "result": "success"
}

Status code: 400

Example response for a failed request

HttpStatusCode: 404
{
"errorMessage": "Not found. Please check the input parameters.",
"errorCode": "GES.8000"
}

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.