点过滤查询
功能介绍
查询满足过滤条件的顶点集合。
URI
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
|
graph_name |
是 |
String |
图名称。 |
请求参数
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
labels |
labels和vertexFilters两者必选其一 |
String |
顶点类型过滤条件。 |
|
vertexFilters |
labels和vertexFilters两者必选其一 |
Object |
过滤条件,按属性过滤,JsonArray格式字符串。 |
|
offset |
否 |
Integer |
本次请求的起始位置。 |
|
limit |
否 |
Integer |
每页资源数量的最大值,默认为10。 |
|
sorts |
否 |
Object |
结果排序的属性,JsonArray格式字符。 |
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
key |
Key和propertyName必选其一 |
String |
可选值有id、label、property,分别表示对id、label和属性排序。 |
|
propertyName |
Key和propertyName必选其一 |
String |
属性名称。 |
|
orderValue |
否 |
String |
可选“incr”和“decr”,分别表示升序和降序,默认值“incr”。 |
响应参数
|
参数 |
类型 |
说明 |
|---|---|---|
|
errorMessage |
String |
系统提示信息。
|
|
errorCode |
String |
系统提示信息。
|
|
jobId |
String |
查询节点任务ID。请求失败时字段为空。
说明:
可以查询jobId查看任务执行状态、获取返回结果,详情参考查询Job状态-业务面。 |
|
jobType |
Integer |
任务类型。请求失败时,该字段为空。 |
请求示例
查询满足过滤条件的顶点集合,请求的起始位置为0,每页资源数量的最大值为2,用于过滤的属性条件为movie和user,用于过滤的属性名为Age。
POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query
{
"offset":0,
"limit":2,
"labels": ["movies",
"user"],
"vertexFilters":[{
"propertyName":"Age",
"predicate":"=",
"values":["18-24"]
}
]
}
[
{
"propertyName":"Gender",
"predicate":"=",
"values":["F"]
},
{
"propertyName":"Age",
"predicate":"range",
"values":["18-24","56+"],
"type":"or"
}
]
响应示例
状态码: 200
Http Status Code: 200
{
"jobId": "03e774f5-29ea-4187-9508-5435f3892ead016886200",
"jobType": 1
}
状态码: 400
失败响应示例
Http Status Code: 400
{
"errorMessage": "Bad Request, parameter labels and vertexFilters cannot all be null",
"errorCode": "GES.8203"
}
状态码
|
返回值 |
说明 |
|---|---|
|
400 Bad Request |
请求错误 |
|
401 Unauthorized |
鉴权失败 |
|
403 Forbidden |
没有操作权限 |
|
404 Not Found |
找不到资源 |
|
500 Internal Server Error |
服务内部错误 |
|
503 Service Unavailable |
服务不可用 |
错误码
请参见错误码。
