华为云用户手册

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "data":{ "vertices":[ { "id":"Ray", "label":"user", "properties":{ "Name":["雷"], "Gender":["M"], "Age":["18-24"], "Occupation":["college/grad student"], "Zip-code":["90241"] } }, { "id":"Ella", "label":"user", "properties":{ "Occupation":["other or not specified"], "Name":["埃拉"], "Zip-code":["94402"], "Gender":["F"], "Age":["25-34"] } } ], "edges":[ { "source":"Ray", "target":"Lethal Weapon", "index":"1", "label":"rate", "properties":{ "Score":[2], "Datetime":["2000-11-22 19:16:16"] } }, { "index":"0", "source":"Ella", "label":"rate", "properties":{ "Score":[5], "Datetime":["2000-11-23 02:30:29"] }, "target":"Lethal Weapon" }, { "index":"5", "source":"Ella", "label":"friends", "properties":{}, "target":"Ray" } ] } } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": " Bad Request, parameter vertices cannot be null", "errorCode": "GES.8214" }

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Parameter error!", "errorCode": "GES.8005" }

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"n_paths", "parameters": { "source":"129", "target":"78", "directed": "false", "n": "50", "k": "3" } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应参数 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，字段为空。 说明： 可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。 paths List source节点和target节点之间的路径，格式： [[path1],[path2], …] 其中，路径（path）的格式可参考：最短路径（Shortest Path）。 paths_number Integer 路径个数。 source String 起点ID。 target String 终点ID。

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 是 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 source 是 String 输入路径的起点ID。 target 是 String 输入路径的终点ID，不等于source。 directed 否 Boolean 是否考虑边的方向。取值为true或false。 说明： false当前版本在有权图上不支持。 当数据集不包含inedge时，若directed=true，选择一个不依赖于Inedge的算法实现版本计算输出，性能会下降；若directed=false，会报错。 n 否 Integer 路径个数，取值范围[1,100] ，默认值为10。 k 否 Integer 层数，取值范围[1,10]，默认值为5。

请求示例 根据批量边的起点、终点以及索引来查询这些边的详细信息，待查询边的source节点分别为39631050_景观，27803870_地标建筑。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query { "edges": [{ "source": "39631050_景观", "target": "27803870_地标建筑" },{ "index": "0", "source": "27803870_地标建筑", "target": "27661363_北京九华山庄温泉" }] }

响应示例 状态码： 200 成功响应示例 { "data": { "edges": [ { "index": "24", "source": "39631050_景观", "label": "superclassOf", "properties": { "popularity": [ 0 ] }, "target": "27803870_地标建筑" }, { "index": "0", "source": "27803870_地标建筑", "label": "superclassOf", "properties": { "popularity": [ 0 ] }, "target": "27661363_北京九华山庄温泉" } ] } }

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

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "3-f78ec641-ed66-4983-bf93-7f9b3a716c780000000019090" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Parameter error!", "errorCode": "GES.8005" }

响应参数 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，字段为空。 说明： 可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。 modularity Double 模块度。 community_num Integer 社团数量。 community List 各节点对应的社团(community)，格式： [{vertexId:communityId},...] 其中, vertexId: string类型。 communityId: string类型。

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"louvain", "parameters":{ "convergence":0.00001, "max_iterations":100 } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 否 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 convergence 否 Double 收敛精度，取值范围为(0,1)，默认值为0.00001。 max_iterations 否 Integer 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为100。 weight 否 String 边上权重，取值为空或字符串， 当图中的边没有配置该属性时，算法会报错。 空：边上的权重、距离默认为“1"。 字符串：对应的边上的属性将作为权重。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Parameter error!", "errorCode": "GES.8005" }

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，该字段为空。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考Job管理API。

请求示例 执行指定算法，算法名字为shortest_path，路径的起点ID为145，路径的终点ID为10，考虑边的方向。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm { "algorithmName": "shortest_path", "parameters": { "source": "145", "target": "10", "directed":true }, "executionMode": "sync" } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122", "jobType": 1 } 状态码：400 失败响应示例 Http Status Code: 400 { "errorMessage": "Graph [854d9316e71d4dc599c5f27ea323d445-ges_fdb1234] does not exist, please check projectId and graphName.", "errorCode": "GES.8000", "result": "failed" }

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

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "d7e4481b-29e6-443b-85e9-0356f0a371ad000313144", "jobType": 10 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Not found. Please check the input parameters.", "errorCode": "GES.8000" }

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "data": { "vertices": [ { "id": "0", "labels": [ "movie" ], "properties": { "movie": { "movieid": [ 0 ], "title": [ "American Beauty (1999)" ], "genres": [ "Comedy|Drama" ] } } }, { "id": "51", "labels": [ "user" ], "properties": { "user": { "userid": [ 5 ], "gender": [ "F" ], "age": [ "56+" ], "occupation": [ "homemaker" ], "Zip-code": [ "46911" ] } } } ] }, "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Bad Request, parameter vertices cannot be null", "errorCode": "GES.8214", "result": "failed" }

响应参数 表3 响应Body参数 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 查询成功时包含data字段，data字段中包含vertices查询结果。 result String 查询结果。成功时值为success，失败时值为failed。

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 scriptPath 是 String 用户编写好的DSL算法文件路径。 obsParameters 是 Object OBS认证参数。具体请见obsParameters参数说明。 timeout 否 Integer 超时时间，单位为秒，超时范围为 (1, 2147483647)。 表3 obsParameters参数说明 参数 是否必选 类型 说明 accessKey 是 String ak值。 secretKey 是 String sk值。

请求示例 请求示例1：取消已经提交的某个作业。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/dsl { "scriptPath": "bucket/run_sssp.py", "obsParameters": { "accessKey": "XXX", "secretKey": "XXX" } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "6-57222f3d-f6b8-41ba-b492-60ed9b879223" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Parameter error!", "errorCode": "GES.8005" }

点集全最短路(all_shortest_paths_of_vertex_sets)(2.2.15) 表1 parameters参数说明 参数 是否必选 类型 取值范围 默认值 说明 sources 是 String 标准csv格式，ID之间以英文逗号分隔，例如："Alice,Nana"。 个数不大于100000。 - 起点ID集合。 targets 是 String 标准csv格式，ID之间以英文逗号分隔，例如："Alice,Nana"。 个数不大于100000。 - 终点ID集合。 directed 否 Boolean true 或false，布尔型。 false 是否考虑边的方向。 表2 response_data参数说明 参数 类型 说明 paths List source节点和target节点之间所有的最短路径，格式： [[path1],[path2]] 其中，路径（path）的格式可参考：最短路径（Shortest Path）。 sources String 路径的起点ID集合。 targets String 路径的终点ID集合。 父主题： 算法API参数参考

任务返回示例 { "data": { "outputs": { "data_return_size": 3, "paths": [ [ "111", "119", "58", "96", "82", "57", "56" ], [ "111", "119", "58", "61", "76", "57", "56" ], [ "111", "119", "58", "79", "76", "57", "56" ] ], "runtime": 0.000308, "source": "111", "path_length": 6, "data_offset": 0, "paths_number": 3, "data_total_size": 3, "target": "56" } }, "status": "success" }

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm { "algorithmName": "filtered_n_paths", "filters": [ { "edge_filter": { "property_filter": { "leftvalue": { "label_name": "labelName" }, "predicate": "=", "rightvalue": { "value": "default" } } } }], "parameters": { "k": 6, "n": 100, "source": "111", "target": "56" } }

请求参数 表1 body体格式 字段名 是否必选 类型 说明 algorithmName 是 String 对应值为“filtered_n_paths”。 parameters 是 Json 具体格式见表parameters参数说明。 filters 是 JSon Array 过滤条件列表，数组的每个元素分别对应每一层要做的查询和过滤条件。具体格式见表filters元素格式。 表2 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 起始点 String 图内部点 无 target 是 目标点 String 图内部点 无 k 是 跳数 Integer [2,6] 2 n 是 路径数 Integer [1,1000] 1 表3 filters元素格式 参数 是否必选 类型 取值范围 默认值 说明 edge_filter 否 json 无 无 全图查询边时的过滤条件。 vertex_filter 否 json 无 无 全图查询点时的过滤条件。 表4 response_data参数说明 字段名 类型 说明 path_length integer 路径长度。 paths_number integer 路径数量。 paths Json Array 路径集合，格式为：[[path1],[path2]]。 source String 起始点。 target String 目标点。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quotas quotas Object resource类型列表，请求失败时该字段为空。 表4 quotas 参数 参数类型 描述 resources Array of resources objects GES资源配额列表。 表5 resources 参数 参数类型 描述 type String 类型。 取值范围： "graph" "backup" "metadata" available Integer 图的可用个数。 当available参数值为-1时，表示图的可用个数不限制。 edge_volume Integer 边的可用个数。type（配额类型）取值为graph时此值有效。 当edgeVolume参数值为-1时，表示边的可用个数不限制。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。

响应示例 状态码： 200 成功响应示例 { "quotas" : { "resources" : [ { "type" : "graph", "available" : 10, "edge_volume" : 7300 }, { "type" : "backup", "available" : 100 }, { "type" : "metadata", "available" : 86 } ] } } 状态码： 400 失败响应示例 { "error_code" : "GES.7006", "error_msg" : "An internal error occurs in the underlying service of the graph engine." }

请求示例 增量导入图数据，边文件目录为testbucket/demo_movie/edges/，边数据集格式为csv，点文件目录为testbucket/demo_movie/vertices/，点数据集格式为csv。 POST http://{Endpoint}/v2/{project_id}/graphs/{graph_id}/import-graph { "edgeset_path" : "testbucket/demo_movie/edges/", "edgeset_format" : "csv", "vertexset_path" : "testbucket/demo_movie/vertices/", "vertexset_format" : "csv", "schema_path" : "testbucket/demo_movie/incremental_data_schema.xml", "log_dir" : "testbucket/importlogdir", "parallel_edge" : { "action" : "override", "ignore_label" : true }, "delimiter" : ",", "trim_quote" : "\"", "offline" : false }