Querying Graph Metadata Details

Function

This API is used to query graph metadata details.

URI

URI format

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

Parameter description

**Table 1** URI parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
graph_name	Yes	String	Graph name

Request

Request example
```
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 Constraints of Using Service Plane APIs.

Response

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
errorMessage	No	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	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
data	No	Json	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

Response example (successful request)

Http Status Code: 200

{
    "data": {
        "schema": [
            {
                "label": "__DEFAULT__"
            },
            {
                "label": "friends"
            },
            {
                "label": "movie",
                "properties": [
                    {
                        "name": "ChineseTitle",
                        "type": "string",
                        "cardinality": "single"
                    },
                    {
                        "name": "Year",
                        "type": "int",
                        "cardinality": "single"
                    },
                    {
                        "name": "Genres",
                        "type": "string",
                        "cardinality": "set"
                    }
                ]
            },

            {
                "label": "user",
                "properties": [
                    {
                        "name": "ChineseName",
                        "type": "string",
                        "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",
                        "type": "string",
                        "cardinality": "single"
                    },
                    {
                        "name": "Zip-code",
                        "type": "char array",
                        "cardinality": "single
"
                    }
                ]
            },
            {
                "label": "rate",
                "properties": [
                    {
                        "name": "Score",
                        "type": "int",
                        "cardinality": "single"
                    },
                    {
                        "name": "Datetime",
                        "type": "date",
                        "cardinality": "single"
                    }
                ]
            }
        ]
    }
}

Response example (failed request)

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

Return Value

Normal
200

Abnormal

**Table 4** Return code for failed requests
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.