查询Schema结构

功能介绍

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

URI

• URI 格式

  GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure/structure?detail={details}

• 参数说明

  表1 URI参数说明

  参数	是否必选	类型	说明
  project_id	是	String	项目编号，用于资源隔离。请参考获取项目ID。
  graph_name	是	String	图名称。
  details	否	String	可为SIMPLE或FULL，SIMPLE模式表示只返回点或边的label，FULL模式表示除点或边的label外，还有点或边的数量。若该字段不填，则默认为SIMPLE。

请求

• 请求样例

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

响应

• 要素说明

  表2 property参数说明

  参数	类型	说明
  errorMessage	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。
  errorCode	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。
  schema	JSON	schema结构查询结果。详情请参见schema参数说明。

  表3 schema参数说明

  参数	类型	说明
  vertices	JSONArray	点的结果集合。图为空时，vertices内容为空。详情请参见vertices参数说明。
  edges	JSONArray	边的结果集合。图为空时，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": {
          "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"
              }
          ]
      }
  }

• 请求失败样例

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

返回值

• 正常

  200

• 异常

  表6 异常返回值说明

  返回值	说明
  400 Bad Request	请求错误。
  401 Unauthorized	鉴权失败。
  403 Forbidden	没有操作权限。
  404 Not Found	找不到资源。
  500 Internal Server Error	服务内部错误。