导出job返回结果到文件

功能介绍

用于将异步任务（jobId）的执行结果（result）导出到文件。

• 支持算法列表：
  • pagerank、personalrank、pixie
  • louvain、label_propagation、connect_component
  • kcore
  • sssp、shortest_path（含time_window_shortest_path）、shortest_path_of_vertex_sets、all_shortest_paths、n_paths
  • traingle_count、cluster_coefficient、degree_correlation、closeness
  • link_prediction
  • betweenness、edge_betweenness、od_betweenness
• 支持查询列表
  • Cypher操作API（2.2.16）

URI

• URI 格式

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/action?action_id=export-result

• 参数说明

  表1 URI参数说明

  参数	是否必选	类型	说明
  project_id	是	String	项目编号，用于资源隔离。请参考获取项目ID。
  graph_name	是	String	图名称。
  job_id	是	String	Response对应的任务Job ID。

请求

• 参数说明

  表2 请求参数说明

  参数	是否必选	类型	说明
  exportPath	是	String	导出路径。
  fileName	否	String	导出文件名。
  obsParameters	是	String	OBS认证参数。具体请见表3。

  表3 obsParameters参数说明

  参数	是否必选	类型	说明
  accessKey	是	string	ak值。
  secretKey	是	string	sk值。

• 请求样例

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/action?action_id=export-result

  • 导出到OBS

    {
        "exportPath": "demo_movie/",
        "fileName": "louvain",
        "obsParameters": {
            "accessKey": "xxxx",
            "secretKey": "xxxx"
        }
    }

响应

• 要素说明

  表4 要素说明

  参数	是否必选	类型	说明
  errorMessage	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。
  errorCode	否	String	系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。
  job_id	否	String	执行该异步任务的jobId。 可以查询jobId查看任务执行状态、获取返回结果，详情参考查询Job状态(1.0.0)-业务面。

• 请求成功样例

  HttpStatusCode: 200
  {
      "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
  }

• 请求失败样例

  HttpStatusCode: 400
  {
      "errorMessage": "graph [demo] is not found",
      "errorCode": "GES.8011"
  }

返回值

• 正常

  200

• 异常

  表5 异常返回值说明

  返回值	说明
  400 Bad Request	请求错误。
  401 Unauthorized	鉴权失败。
  403 Forbidden	没有操作权限。
  404 Not Found	找不到资源。
  500 Internal Server Error	服务内部错误。
  503 Service Unavailable	服务不可用。

导出csv文件格式

• 算法结果举例，例如Louvain.csv内容如下：

  # modularity: 0.4269691347613425,
  #community_num: 4,
  #runtime: 0.003784,
  #data_total_size: 34
  #community:
  1,1
  2,1
  …

• Cypher结果举例如下：
  • 示例一

    示例语句：

    match (n:user)-[r]->(m:movie) return id(n),n.Name, n.Occupation, n.Age,r.Score,m.Title

    示例结果：

    #data_total_size:1209
    #data_return_size:1209
    #data_offset:0
    #records:
    Vivian,薇薇安,artist,25-34,5,致命武器
    Vivian,薇薇安,artist,25-34,4,抚养亚历桑纳
    Mercedes,默西迪丝,K-12 student,Under 18,3,致命武器
    Mercedes,默西迪丝,K-12 student,Under 18,3,勇闯夺命岛
    …

  • 示例二

    示例语句：

    match (n)-->(m) where id(n)='Vivian' return labels(m),count(*)

    示例结果：

    #data_total_size:2
    #data_return_size:2
    #data_offset:0
    #records:
    user,5
    movie,2