文档首页/图引擎服务 GES/API参考/业务面API/持久化版/HyG图管理API/查询HyG图概要信息
更新时间：2025-12-19 GMT+08:00
查看PDF
分享

查询HyG图概要信息

功能介绍

查询HyG图的点数量、边数量、属性信息、切分策略等概要信息。

URI

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

参数

是否必选

类型

说明

project_id

是

String

参数解释：

项目编号。获取方法，请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母和数字组成，且长度为[1-64]个字符。

默认取值：

不涉及。

graph_name

是

String

图名称。

请求参数

无

响应参数

表2 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

data

Object

查询成功时包含data字段，参数详见data参数说明。

status

String

查询成功时返回任务状态，可选值为pending，running，complete。查询失败时字段为空。

result

String

执行结果。

  • 成功时，result值为success。
  • 失败时，result值为failed。
表3 data参数说明

参数

类型

说明

vertex

Json

包含的点标签、属性信息。

edge

Json

包含的边标签、属性信息。

policy

String

切分策略。

inEdge

Boolean

是否包含入边。

idIndex

Boolean

是否包含点ID索引。

updateTime

String

图更新时间。

vertexNum

Integer

点数量。

edgeNum

Integer

边数量。

请求示例

查询HyG图的概要信息。

GET http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/summary

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

响应示例

状态码： 200

成功响应示例 
Http Status Code: 200
{
    "data": {
        "inEdge": true,
        "idIndex": true,
        "policy": "oec",
        "updateTime": "2023-08-03 15:13:16",
        "vertex": [],
        "edge": [
            {
                "label": "rate",
                "property": [
                    "Rating"
                ]
            }
        ],
        "vertexNum": 150,
        "edgeNum": 1659
    },
    "result": "success"
}

状态码： 400

失败响应示例

Http Status Code: 400
{
    "errorMessage": "Graph [cb1ed5491f7f466e8947ff09c06ca08c-ges_hyg12] does not exist, please check projectId and graphName.",
    "errorCode": "GES.8000",
    "result": "failed"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题：HyG图管理API