删除过滤后的点(2.2.7) -DeleteFilteredVertexs
功能介绍
删除满足过滤条件的点集合。
URI
POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=delete
| 参数 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目编号。获取方法,请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母和数字组成,且长度为[1-64]个字符。 默认取值: 不涉及。 |
| graph_name | 是 | String | 参数解释: 图名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| labels | labels和vertexFilters两者必选其一 | String | 参数解释: 点类型过滤条件。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| vertexFilters | labels和vertexFilters两者必选其一 | Object | 参数解释: 过滤条件,请参见vertexFilters参数结构。 约束限制: 按属性过滤,JsonArray格式字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
| begin | 否 | Integer | 参数解释: 可针对一段范围的点进行过滤,begin指定开始游标。 约束限制: 不涉及。 取值范围: 范围是0 - uint32_MAX。 默认取值: 默认值为0。 |
| end | 否 | Integer | 参数解释: 可针对一段范围的点进行过滤,end指定结束游标。 约束限制:
取值范围: 范围是0 - uint32_MAX。 默认取值: 默认值为uint32_MAX。 |
| limit | 否 | Integer | 参数解释: 被删除点数量的最大值,默认删除全部满足条件的点。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| propertyName | propertyName和degree两者必选其一 | String | 参数解释: 属性名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| predicate | 是 | String | 参数解释: 逻辑关系。 约束限制: 不涉及。 取值范围: 可选值“=”、“<”、“>”、“<=”、“>=”、“range”、“has”“hasNot”、“full_text_match”、“full_text_prefix”、“full_text_wildcard”、“full_text_regexp”、“full_text_fuzzy”和 “full_text_combination”。 默认取值: 不涉及。 |
| values | 否 | String | 参数解释: 属性的值或点的度的值。 约束限制: 当predicate为full_text_combination时,values类型不是string。 取值范围: 不涉及。 默认取值: 不涉及。 |
| type | 否 | String | 参数解释: 过滤条件逻辑关系。 约束限制: 不涉及。 取值范围: 可选值“and”和“or”。 默认取值: 默认为“and”。 |
| degree(2.4.0) | propertyName和degree两者必选其一 | String | 参数解释: 点的度。 约束限制: 对应的predicate支持“=”、“<”、“>”、“<=”、“>=”、“!=”。 取值范围: 可选in、out、both。 默认取值: 不涉及。 |
响应参数
| 参数 | 类型 | 说明 |
|---|---|---|
| errorMessage | String | 参数解释: 系统提示信息。
取值范围: 不涉及。 |
| errorCode | String | 参数解释: 系统提示信息。
取值范围: 不涉及。 |
| jobId | String | 参数解释: 查询节点任务ID。请求失败时字段为空。 说明: 可以查询jobId查看任务执行状态、获取返回结果,详情参考查询Job状态(1.0.0)-业务面 - ShowJob。 取值范围: 不涉及。 |
| jobType | Integer | 参数解释: 任务类型。请求失败时,该字段为空。 取值范围: 不涉及。 |
请求示例
POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=delete
{
"labels": [
"movies",
"user"
],
"vertexFilters": [
{
"propertyName": "Age",
"predicate": "=",
"values": [
"18-24"
]
}
]
} 响应示例
状态码: 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 | 服务不可用。 |
错误码
请参见错误码。