文档首页/ 图引擎服务 GES/ API参考/ 业务面API/ 内存版/ 元数据操作API/ 查询Schema结构
更新时间：2023-06-30 GMT+08:00
查看PDF
分享

查询Schema结构

功能介绍

查询生成的schema结构（从OBS上读取）。

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure?detail={details}
表1 路径参数

参数

是否必选

类型

说明

project_id

是

String

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

graph_name

是

String

图名称。

details

否

String

可为SIMPLE或FULL，SIMPLE模式表示只返回点或边的label，FULL模式表示除点或边的label外，还有点或边的数量。若该字段不填，则默认为SIMPLE。

响应参数

表2 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

schema

Object

schema结构查询结果。详情请参见schema参数说明。
表3 schema参数说明

参数

类型

说明

vertices

String

点的结果集合。图为空时，vertices内容为空。详情请参见vertices参数说明。

edges

String

边的结果集合。图为空时，edges内容为空。详情请参见edges参数说明。
表4 vertices参数说明

参数

类型

说明

vertex

String

label名。

weight

String

具有该label的点的数量。
表5 edges参数说明

参数

类型

说明

source

String

起始点label名。

target

String

终点label名。

relation

String

关系label名

weight

String

具有该label的边的数量。

请求示例

查询生成的schema结构（从OBS上读取）。

GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure?detail=SIMPLE

响应示例

状态码： 200

成功响应示例

{
    "schema": {
        "vertices": [
            {
                "vertex": "user",
                "weight": 100
            },
            {
                "vertex": "movie",
                "weight": 46
            }
        ],
        "edges": [
            {
                "weight": 1209,
                "source": "user",
                "target": "movie",
                "relation": "rate"
            },
            {
                "weight": 450,
                "source": "user",
                "target": "user",
                "relation": "default"
            }
        ]
    }
}

状态码： 400

失败响应示例

Http Status Code: 400
{
    "errorMessage": "Bad Request, parameter [detail] cannot be null.",
    "errorCode": "GES.8813"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题： 元数据操作API

相关文档