文档首页/ 图引擎服务 GES/ API参考/ 业务面API/ 持久化版/ 图统计API/ 查询图概要信息
更新时间：2024-04-17 GMT+08:00
查看PDF
分享

查询图概要信息

功能介绍

查询图的点数和边数等概要信息。

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details={labelDetails}

表1 路径参数

参数

是否必选

类型

说明

project_id

是

String

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

graph_name

是

String

图名称。

labelDetails

否

Boolean

是否返回不同label下点边的数目信息，默认为false。为true时，返回不同label的点边数目。

请求示例

查询图的点数和边数等概要信息，true表示返回不同label的点边数目。

GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details=true

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

响应参数

表2 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

jobId

String

执行该异步任务的jobId。

调用查询jobId接口查看任务执行状态、获取返回结果，详情参考Job管理API，调用结果参数说明，详见表3 data参数说明。
表3 data参数说明

参数

类型

说明

vertexNum

Integer

图的点数。在多标签场景下，该值会按照label出现次数重复统计，如果需要统计真实实体个数，用cypher语句：match (n) return count(*)进行查询。

edgeNum

Integer

图的边数。

labelDetails

Object

不同label下的点边数目信息。若需要正常显示此字段，请按照表 labelDetails数据各要素说明建立点边索引。
表4 执行成功时，labelDetails数据各要素说明

参数

类型

说明

labelInVertex

Object

不同label下面点的数目，若某label下点的数目为0则不显示。

若需要响应中包含该要素，请参考新建索引，新建索引时索引类型为"GlobalCompositeVertexIndex "，hasLabel为"true",属性列表置空。

labelInEdge

Object

不同label下面边的数目，若某label下边的数目为0则不显示。

若需要响应中包含该要素，请参考新建索引，新建索引时索引类型为"GlobalCompositeEdgeIndex "，hasLabel为"true",属性列表置空。

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

响应示例

状态码： 200

响应成功示例 
Http Status Code: 200
{
"jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

状态码： 400

失败响应示例 
Http Status Code: 400
{
    "errorMessage": "graph [demo] is not found",
    "errorCode": "GES.8001"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题： 图统计API

相关文档