导出图(1.0.5) - ExportGraph

如果将导出的CSV文件下载到本地，默认会用系统的Excel软件打开（推荐使用文本编辑器打开）。如果数据中包含“+”、“-”、“=”、“@”等特殊字符，会被Excel解析为公式。为了保证系统安全，请打开文件时注意以下事项：

不要启用“启用动态数据交换服务器启动（不推荐）”配置。
打开CSV文件弹窗提醒安全问题时，不要选择“启用”或者“是”。

URI

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

表1 路径参数
参数	是否必选	类型	说明
project_id	是	String	参数解释：项目编号。获取方法，请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母和数字组成，且长度为[1-64]个字符。默认取值：不涉及。
graph_name	是	String	参数解释：图名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 Body参数说明
参数	是否必选	类型	说明
graphExportPath	是	String	参数解释：图的导出OBS路径。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
edgeSetName	是	String	参数解释：导出边文件夹名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
vertexSetName	是	String	参数解释：导出点文件夹名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
schemaName	是	String	参数解释：导出元数据文件名。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
paginate(2.3.11)	否	Object	参数解释：分页相关参数，自2.3.11版本起导出图默认分页导出。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
obsParameters	是	Object	参数解释： Obs相关参数，详情请参见表4。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
accessKey	是	String	参数解释：用户的accessKey。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
secretKey	是	String	参数解释：用户的secretKey。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表3 参数paginate中各要素说明
参数	是否必选	类型	说明
enable	否	Bool	参数解释：是否开启分页。不需要开启分页时，需输入值为false。约束限制：不涉及。取值范围：不涉及。默认取值：默认为true。
rowCountPerFile	否	Int	参数解释：按页导出时每个文件的最大行数。约束限制：不涉及。取值范围：默认最大为10000000。默认取值：不涉及。
numThread	否	Int	参数解释：按页导出时的并行线程数。约束限制：不涉及。取值范围：不涉及。默认取值：默认为8。
maxSizePerFile	否	Int	参数解释：按页导出时每个文件大小的最大值，单位是byte。约束限制：默认不超过导入时最大文件约束。取值范围：不涉及。默认取值：不涉及。

表4 obsParameters参数说明
参数	是否必选	类型	说明
accessKey	是	String	参数解释：用户的accessKey。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
secretKey	是	String	参数解释：用户的secretKey。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

表5 响应Body参数说明
参数	类型	说明
errorMessage	String	参数解释：系统提示信息。执行成功时，字段可能为空。执行失败时，用于显示错误信息。取值范围：不涉及。
errorCode	String	参数解释：系统提示信息。执行成功时，字段可能为空。执行失败时，用于显示错误码。取值范围：不涉及。
jobId	String	执行该异步任务的jobId。可以查询jobId查看任务执行状态、获取返回结果，详情参考Job管理API。
jobType	Integer	参数解释：任务类型。请求失败时，该字段为空。取值范围：不涉及。

请求示例

请求示例1，进行导出图操作，图的导出OBS路径为demo_movie/，导出边文件夹名称为set_edge，导出点文件夹名称为set_vertex，导出元数据文件名为set_schema.xml。

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph
{
  "graphExportPath": "demo_movie/",
  "edgeSetName": "set_edge",
  "vertexSetName": "set_vertex",
  "schemaName": "set_schema.xml",
  "paginate":{
    "numThread":16,
    "rowCountPerFile":1000000
},
  "obsParameters": {
    "accessKey": "xxxxxx",
    "secretKey": "xxxxxx"
  }
}

请求示例2

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph
{
  "graphExportPath": "demo_movie/",
  "edgeSetName": "set_edge",
  "vertexSetName": "set_vertex",
  "schemaName": "set_schema.xml",
  "obsParameters": {
    "accessKey": "xxxxxx",
    "secretKey": "xxxxxx"
  }
}

响应示例

状态码： 200

成功响应示例

Http Status Code: 200
{
    "jobId": "9874990c-b2c5-4e8b-96f3-10a9c46fe3a6000003836",
    "jobType": 1
}

状态码： 400

失败响应示例

Http Status Code: 400
{
 "errorMessage": "Not found. Please check the input parameters.",
 "errorCode": "GES.8000"
}

状态码

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