导出过滤后的点(2.2.7) -ExportFilteredVertexs
功能介绍
导出满足过滤条件的点集合。
URI
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目编号。获取方法，请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母和数字组成，且长度为[1-64]个字符。 默认取值： 不涉及。 |
|
graph_name |
是 |
String |
图名称。 |
请求参数
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
labels |
labels和vertexFilters两者必选其一 |
String |
点类型过滤条件。 |
|
vertexFilters |
labels和vertexFilters两者必选其一 |
Json |
过滤条件，按属性过滤，JsonArray格式字符串。请参见vertexFilters参数结构。 |
|
exportPath |
是 |
String |
导出路径。 |
|
fileName |
否 |
String |
导出文件名。 |
|
obsParameters |
是 |
String |
OBS认证参数。请参见obsParameters参数说明。2.4.17及以上版本图支持通过委托访问OBS，使用委托时该参数非必选，委托详情见创建OBS委托。 |
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
propertyName |
是 |
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”。 |
响应参数
|
参数 |
类型 |
说明 |
|---|---|---|
|
errorMessage |
String |
参数解释： 系统提示信息。
取值范围： 不涉及。 |
|
errorCode |
String |
参数解释： 系统提示信息。
取值范围： 不涉及。 |
|
jobId |
String |
查询边任务ID。
说明：
可以查询jobId查看任务执行状态、获取返回结果，详情参考Job管理API。 |
|
jobType |
Integer |
请求为异步执行模式下，该字段用于输出异步任务的类型。 |
请求示例
（仅支持异步模式）导出满足过滤条件的点集合，导出路径为demo_movie/，导出文件名export_movie_and_user.csv。
POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=export
{
"labels": [
"movies",
"user"
],
"vertexFilters": [
{
"propertyName": "Age",
"predicate": "=",
"values": [
"18-24"
]
}
],
"exportPath": "demo_movie/",
"fileName": "export_movie_and_user.csv",
"obsParameters": {
"accessKey": "XXXX",
"secretKey": "XXXX"
}
}
响应示例
状态码： 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 |
服务不可用。 |
错误码
请参见错误码。
