文档首页/ 图引擎服务 GES/ API参考/ 业务面API/ 内存版/ 元数据操作API/ 查询图元数据详情(1.0.0)
更新时间：2023-09-15 GMT+08:00
查看PDF
分享

查询图元数据详情(1.0.0)

功能介绍

查询图的元数据详情。

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema
表1 路径参数

参数

是否必选

类型

说明

project_id

是

String

项目ID。获取方法请参见获取项目ID。

graph_name

是

String

图名称。

请求参数

无

响应参数

表2 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

  • 执行成功时，字段可能为空。
  • 执行失败时，用于显示错误信息。

errorCode

String

系统提示信息。

  • 执行成功时，字段可能为空。
  • 执行失败时，用于显示错误码。

data

Object

查询结果。请求失败时字段为空。
表3 data参数说明

参数

类型

说明

schema

List

各label与关联的property字段定义。

请求示例

查询图的元数据详情。

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

SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例

状态码： 200

成功响应示例 
Http Status Code: 200

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

            {
                "label": "user",
                "type": "vertex",
                "properties": [
                    {
                        "name": "Name",
                        "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",
                "type": "edge",
                "properties": [
                    {
                        "name": "Score",
                        "type": "int",
                        "cardinality": "single"
                    },
                    {
                        "name": "Datetime",
                        "type": "date",
                        "cardinality": "single"
                    }
                ]
            }
        ]
    }
}

状态码： 400

失败响应示例

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

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题： 元数据操作API

相关文档