更新时间:2022-02-22 GMT+08:00
导出过滤后的点
功能介绍
导出满足过滤条件的顶点集合。
URI
- URI 格式
POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=export
- 参数说明
表1 URI参数说明 参数
是否必选
类型
说明
project_id
是
String
项目编号,用于资源隔离。请参考获取项目ID。
graph_name
是
String
图名称。
请求
- 请求样例(仅支持异步模式)
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" } }
- 参数说明
表2 Body参数说明 参数
是否必选
类型
说明
labels
labels和vertexFilters两者必选其一
String
顶点类型过滤条件。
vertexFilters
labels和vertexFilters两者必选其一
Json
过滤条件,按属性过滤,JsonArray格式字符串。请参见表 vertexFilters参数结构。
exportPath
是
String
导出路径。
fileName
否
String
导出文件名。
obsParameters
是
String
OBS认证参数。请参见表 obsParameters参数说明。
响应
参数 |
是否必选 |
类型 |
说明 |
---|---|---|---|
errorMessage |
否 |
String |
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 |
errorCode |
否 |
String |
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 |
job_id |
否 |
String |
查询边任务ID。
说明:
可以查询jobId查看任务执行状态、获取返回结果,详情参考Job管理API。 |
- 请求成功样例
Http Status Code: 200 { "jobId": "03e774f5-29ea-4187-9508-5435f3892ead016886200", "jobType": 1 }
- 请求失败样例
Http Status Code: 400 { "errorMessage": "Bad Request, parameter labels and vertexFilters cannot all be null", "errorCode": "GES.8203" }
父主题: 点操作API