更新时间:2022-02-22 GMT+08:00

导出过滤后的边

功能介绍

导出满足过滤条件的边集合。

URI

  • URI 格式
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=export

请求

  • 请求样例(仅支持异步模式)
    POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=export
      {
    	"labels": [
    		"rate"
    	],
    	"edgeFilters": [
    		{
    			"propertyName": "Score",
    			"predicate": ">=",
    			"values": [
    				"2"
    			]
    		},
    		{
    			"propertyName": "Datetime",
    			"predicate": "range",
    			"values": [
    				"1998-12-27 01:00:00",
    				"2000-12-31 00:12:38"
    			],
    			"type": "or"
    		}
    	],
    	"exportPath": "demo_movie/",
    	"fileName": "export_rate.csv",
    	"obsParameters": {
    		"accessKey": "XXXXXXX",
    		"secretKey": "XXXXXXX"
    	}
      }
  • 参数说明
    表1 Body参数说明

    参数

    是否必选

    类型

    说明

    exportPath

    String

    导出路径。

    fileName

    String

    导出文件名。

    obsParameters

    String

    OBS认证参数。请参见表 obsParameters参数说明

    labels

    labels和edgeFilters两者必选其一

    String

    关系类型过滤条件。

    edgeFilters

    labels和edgeFilters两者必选其一

    String

    过滤条件,按属性过滤,JsonArray格式字符串。请参见表 edgeFilters参数结构

响应

表2 要素说明

参数

是否必选

类型

说明

errorMessage

String

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

errorCode

String

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

job_id

String

查询边任务ID。

说明:

可以查询jobId查看任务执行状态、获取返回结果,详情参考Job管理API

  • 请求成功样例
    Http Status Code: 200
    {
      "jobId": "03e774f5-29ea-4187-9508-5435f3892ead016886200",
      "jobType": 0
    }
  • 请求失败样例
    Http Status Code: 400
    {
      "errorMessage": "Bad Request, parameter labels and vertexFilters cannot all be null",
      "errorCode": "GES.8103"
    }

返回值

  • 正常

    200

  • 异常
    表3 异常返回值说明

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。