更新时间:2023-07-19 GMT+08:00

子图查询(2.1.13)

功能介绍

查询输入的节点和它们之间所有边所构成的子图。

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/subgraphs/action?action_id=query
表1 路径参数

参数

是否必选

类型

说明

project_id

String

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

graph_name

String

图名称。

请求参数

表2 Body参数说明

名称

是否必选

参数类型

说明

vertices

String

子图中应包含的顶点ID数组。

说明:

当前支持输入的顶点个数最大值为100000,超过最大值时,会报错。

响应参数

表3 响应Body参数说明

名称

参数类型

说明

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

data

Object

查询成功时包含data字段,data字段中包含子图查询结果。

说明:

当前支持返回的子图边数最大值为100000,超过返回最大值时,会报错。

请求示例

查询输入的节点和它们之间所有边所构成的子图,子图中包含的顶点ID为Ray,Ella,Lethal Weapon。

{
    "vertices":[
               "Ray",
               "Ella",
               "Lethal Weapon"        
               ]
}

响应示例

状态码: 200

成功响应示例

Http Status Code: 200
{
    "data":{
        "vertices":[
            {
                "id":"Ray",
                "label":"user",
                "properties":{
                    "Name":["雷"],
                    "Gender":["M"],
                    "Age":["18-24"],
                    "Occupation":["college/grad student"],
                    "Zip-code":["90241"]
                }
            },
            {
                "id":"Ella",
                "label":"user",
                "properties":{
                    "Occupation":["other or not specified"],
                    "Name":["埃拉"],
                    "Zip-code":["94402"],
                    "Gender":["F"],
                    "Age":["25-34"]
                }
            }
        ],
        "edges":[
            {
                "source":"Ray",
                "target":"Lethal Weapon",
                "index":"1",
                "label":"rate",
                "properties":{
                    "Score":[2],
                    "Datetime":["2000-11-22 19:16:16"]
                }
            },
            {
                "index":"0",
                "source":"Ella",
                "label":"rate",
                "properties":{
                    "Score":[5],
                    "Datetime":["2000-11-23 02:30:29"]
                },
                "target":"Lethal Weapon"
            },
            {
                "index":"5",
                "source":"Ella",
                "label":"friends",
                "properties":{},
                "target":"Ray"
            }
        ]
    }
}

状态码: 400

失败响应示例
Http Status Code: 400
{
  "errorMessage": " Bad Request, parameter vertices cannot be null",
  "errorCode": "GES.8214"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码