更新时间:2022-04-12 GMT+08:00
分享

查询图概要信息(1.0.0)

功能介绍

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

URI

  • URI 格式
    GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details={labelDetails}
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

    项目编号,用于资源隔离。请参考获取项目ID

    graph_name

    String

    图名称。

    labelDetails(2.2.14)

    Boolean

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

请求

  • 请求样例
    GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details=true

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

响应

表2 要素说明

参数

是否必选

类型

说明

errorMessage

String

系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。

errorCode

String

系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。

data

Json

查询结果。请求失败时,字段为空。

表3 data参数说明

参数

是否必选

类型

说明

vertexNum

Integer

图的点数。

edgeNum

Integer

图的边数。

labelDetails(2.2.14)

Json

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

表4 执行成功时,labelDetails数据各要素说明

参数

是否必选

类型

说明

labelInVertex

Json

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

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

labelInEdge

Json

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

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

errorMessage

String

系统提示信息,执行成功时,字段为空。执行失败时,用于显示错误信息。

errorCode

String

系统提示信息,执行成功时,字段为空。执行失败时,用于显示错误码。

  • 响应成功示例1(返回不同label下点边数目的情况)
    Http Status Code: 200
    {
        "data": {
            "vertexNum": 146,
            "labelDetails": {
                "labelInVertex": {
                    "movie": 46,
                    "user": 100
                },
                "labelInEdge": {
                    "default": 450,
                    "rate": 1209
                }
            },
            "edgeNum": 1659
        }
    }
  • 响应成功示例2(无法提供不同label下点边数目的情况)
    Http Status Code: 200
    {
        "data": {
            "vertexNum": 146,
            "labelDetails": {
                "errorMessage": "Label index in vertices is not found.Label index in edges is not found.",
                "errorCode": "GES.8017"
            },
            "edgeNum": 1659
        }
    }
  • 响应成功示例3(只有不同label下点数目正常返回的情况)
    Http Status Code: 200
    {
      {
        "data": {
            "vertexNum": 146,
            "labelDetails": {
                "errorMessage": "Label index in edges is not found.",
                "labelInVertex": {
                    "movie": 46,
                    "user": 100
                },
                "errorCode": "GES.8017"
            },
            "edgeNum": 1659
        }
    }
  • 响应成功示例(一千亿(公测版)图规格的响应是jobId )
    Http Status Code: 200
    {
    "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
    }
  • 请求败样例
    Http Status Code: 400
    {
        "errorMessage": "graph [demo] is not found",
        "errorCode": "GES.8001"
    }

返回值

  • 正常

    200

  • 异常
    表5 异常返回值说明

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

close