Querying Graph Metadata Details

Function

This API is used to query graph metadata details.

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema

**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

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
schema	List	Definitions of each label and associated property field

Example Request

Query metadata details of a graph.

GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Example Response

Status code: 200

Example response (successful request)

Http Status Code: 200
{
    "data": {
        "schema": [
            {
                "label": "rate",
                "type": "all",
                "properties": [
                    {
                        "name": "Rating",
                        "type": "int",
                        "cardinality": "single"
                    },
                    {
                        "name": "Datetime",
                        "type": "string",
                        "cardinality": "single"
                    }
                ]
            },
            {
                "label": "user",
                "type": "all",
                "properties": [
                    {
                        "name": "userid",
                        "type": "int",
                        "cardinality": "single"
                    },
                    {
                        "name": "gender",
                        "probableValue": [
                            "F",
                            "M"
                        ],
                        "type": "enum",
                        "cardinality": "single"
                    },
                    {
                        "name": "age",
                        "probableValue": [
                            "Under 18",
                            "18-24",
                            "25-34",
                            "35-44",
                            "45-49",
                            "50-55",
                            "56+"
                        ],
                        "type": "enum",
                        "cardinality": "single"
                    },
                    {
                        "name": "occupation",
                        "probableValue": [
                            "other or not specified",
                            "academic/educator",
                            "artist",
                            "clerical/admin",
                            "college/grad student",
                            "customer service",
                            "doctor/health care",
                            "executive/managerial",
                            "farmer",
                            "homemaker",
                            "K-12 student",
                            "lawyer",
                            "programmer",
                            "retired",
                            "sales/marketing",
                            "scientist",
                            "self-employed",
                            "technician/engineer",
                            "tradesman/craftsman",
                            "unemployed",
                            "writer"
                        ],
                        "type": "enum",
                        "cardinality": "single"
                    },
                    {
                        "name": "Zip-code",
                        "maxDataSize": 12,
                        "type": "char array",
                        "cardinality": "single"
                    }
                ]
            },
            {
                "label": "book",
                "type": "vertex",
                "properties": [
                    {
                        "name": "Title",
                        "type": "string",
                        "cardinality": "single"
                    },
                    {
                        "name": "Version",
                        "type": "string",
                        "cardinality": "single"
                    },
                    {
                        "name": "Category",
                        "probableValue": [
                            "science",
                            "literature"
                        ],
                        "type": "enum",
                        "cardinality": "single"
                    }
                ]
            },
            {
                "label": "default",
                "type": "all"
            },
            {
                "label": "movie",
                "type": "all",
                "properties": [
                    {
                        "name": "movieid",
                        "type": "int",
                        "cardinality": "single"
                    },
                    {
                        "name": "title",
                        "type": "string",
                        "cardinality": "single"
                    },
                    {
                        "name": "genres",
                        "type": "string",
                        "cardinality": "single"
                    }
                ]
            },
            {
                "label": "__DEFAULT__",
                "type": "all"
            }
        ]
    }
}

Status code: 400

Example response (failed request)

Http Status Code: 400
{
  "errorMessage": "graph [demo] is not found",
  "errorCode": "GES.8003"
}

Status Code

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authentication failed.
403 Forbidden	No operation permission.
404 Not Found	The requested resource was not found.
500 Internal Server Error	Internal service error.
503 Service Unavailable	Service unavailable.