华为云用户手册

响应参数 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，字段为空。 说明： 可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。 circles List 经过给定点的圈集合。格式： [[circle1],[circle2],…],其中circle的格式为： [vertexId,…],其中，vertexId：string类型。 source String 被包含节点ID。 circle_number Integer 实际找到的圈的个数。 runtime Double 算法运行时间。 min_circle_length Integer 最小圈长。 max_circle_length Integer 最大圈长。 limit_circle_number Integer 限定寻找圈的个数。

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"single_vertex_circles_detection", "parameters":{ "source":"66", "min_circle_length":3, "max_circle_length":7, "limit_circle_number":10000 } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

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

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口，响应消息头中X-Subject-Token的值即为Token。 表4 请求Body参数 参数 是否必选 参数类型 描述 upgradeVersion 是 String 升级到的版本，必须大于当前图版本。 forceUpgrade 否 Boolean 是否强制升级。取值为true或false，默认为false。 true：强制升级，会中断升级时已经在处理的任务，比如运行算法长任务，可能会造成少量请求失败。 false：非强制升级，会等待已经运行的业务，升级过程可能较慢。

URI POST /v1.0/{project_id}/graphs/{graph_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_id 是 String 图ID。 表2 Query参数 参数 是否必选 参数类型 描述 action_id 是 String 图actionId。 枚举值：upgrade

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 backupCount Integer 备份总个数。请求失败时，该字段为空。 backupList Array of backup objects 当前Project ID下的所有图的备份列表。请求失败时，该字段为空。 表5 backup 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 backupMethod String 备份方法，取值为auto或manual。 graphId String 备份关联的图ID。 graph_name String 备份关联的图Name。 graphStatus String 备份关联的图状态。 graphSizeTypeIndex String 备份关联的图规格。 dataStoreVersion String 备份关联的图版本。 arch String 备份关联的图CPU架构。 status String 备份状态。 backing_up：备份中 success：备份成功 failed：备份失败 startTimestamp Long 备份开始时间戳。 startTime String 备份时间。 endTimestamp Long 备份结束时间戳。 endTime String 备份时间。 size Long 备份文件大小，单位为MB。 duration Long 备份时间，单位为秒。

响应示例 状态码： 200 OK { "backupCount": 3, "backupList": [ { "id": "ada3e720-ab87-48cb-bff7-3ec5ae1a9652", "name": "ges060803_nodelete-20210608135513", "backupMethod": "manual", "graphId": "4c5f882d-a813-4d78-a8e3-6d3212ddd121", "graph_name": "ges060803_nodelete", "graphStatus": "200", "graphSizeTypeIndex": "1", "dataStoreVersion": "2.2.21", "arch": "x86_64", "status": "success", "startTimestamp": 1623160513000, "startTime": "2021-06-08T13:55:13", "endTimestamp": 1623160568000, "endTime": "2021-06-08T13:56:08", "size": 1, "duration": 54, }, { "id": "7ed3f51d-816d-4651-9129-fe21b64b5c91", "name": "ges060803_nodelete_20210609203323_auto", "backupMethod": "auto", "graphId": "4c5f882d-a813-4d78-a8e3-6d3212ddd121", "graph_name": "ges060803_nodelete", "graphStatus": "200", "graphSizeTypeIndex": "1", "dataStoreVersion": "2.2.21", "arch": "x86_64", "status": "success", "startTimestamp": 1623242004000, "startTime": "2021-06-09T12:33:24", "endTimestamp": 1623242004000, "endTime": "2021-06-09T12:33:24", "size": 1, "duration": 0 }, { "id": "604bfb46-04dd-45fc-a9ae-df24a0705b9d", "name": "ges060802_nodelete-20210608135523", "backupMethod": "manual", "graphId": "9b9a05c2-0cdb-41ac-b55f-93caffb0519a", "graph_name": "ges060802_nodelete", "graphStatus": "400", "graphSizeTypeIndex": "0", "dataStoreVersion": "2.2.23", "arch": "x86_64", "status": "success", "startTimestamp": 1623160524000, "startTime": "2021-06-08T13:55:24", "endTimestamp": 1623160577000, "endTime": "2021-06-08T13:56:17", "size": 1, "duration": 53 } ] } 状态码： 400 Bad Request { "errorCode" : "GES.7006", "errorMessage" : "The underlying graph engine has internal error." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 results Array of results objects scene场景分析插件信息。 表5 results 参数 参数类型 描述 scene String 场景名。 name String application名称。 params Array of params objects 参数列表。 description String 场景下应用的描述。 表6 params 参数 参数类型 描述 name String 参数名称。 type String 参数类型。取值范围["string","int"]，目前仅支持"string"。 default_value String 取值范围为空，或参数默认值，当为空是表示客户使用时必须传入此参数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

URI GET /v2/{project_id}/graphs/scenes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 scene_name 否 String 场景名称。当有且只有scene_name有值时，返回对应scene_name下的所有application详情。当有且只有scene_name、application_name有值时，返回与application_name对应的application详情。当scene_name、application_name、graph_id均无值时,返回所有SceneApplication application_name 否 String 应用程序名字。当有且只有scene_name、application_name有值时，返回与application_name对应的application详情。当scene_name、application_name、graph_id均无值时,返回所有SceneApplication。 graph_id 否 String 图ID。 当有且只有graph_id有值时，返回对应图id下所订阅的application详情。 当scene_name、application_name、graph_id均无值时,返回所有SceneApplication。

功能介绍 根据输入参数，执行label_propagation算法。 标签传播算法（Label Propagation）是一种基于图的半监督学习方法，其基本思路是用已标记节点的标签信息去预测未标记节点的标签信息。利用样本间的关系建图，节点包括已标注和未标注数据，其边表示两个节点的相似度，节点的标签按相似度传递给其他节点。标签数据就像是一个源头，可以对无标签数据进行标注，节点的相似度越大，标签越容易传播。

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 否 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 convergence 否 Double 收敛精度，取值范围为(0,1)，默认值为0.00001。 max_iterations 否 Integer 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为1000。

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

响应示例 状态码： 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":"label_propagation", "parameters":{ "convergence":"0.00001", "max_iterations":"1000" } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应参数 表4 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 status String 查询成功时返回任务状态，可选值为pending，running，success。查询失败时字段为空。 data Object 算法运行的结果。查询失败时字段为空。

响应示例 根据输入参数，执行指定算法，查询算法结果（根据算法请求返回的job_id，调用查询job_id接口获取算法结果）。 状态码： 200 成功响应示例 { "data": { "outputs": { $response_data //各算法的具体返回结果，不同算法返回结果不同 "runtime": 1.365867, "data_return_size": 3, "data_offset": 0, "data_total_size": 100 } }, "status": "success" } response_data 表示各算法的具体返回结果，不同算法返回结果不同。 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"Running algorithm [XXXX] error: YYYYYYYYY!", "errorCode":"GES.8301" }

请求参数 表1 Body参数说明 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 取值范围（以下显示的均为算法实际调用时的名称）： pagerank personalrank kcore k_hop shortest_path all_shortest_paths filtered_shortest_path sssp shortest_path_of_vertex_sets n_paths closeness subgraph_matching topicrank label_propagation louvain link_prediction node2vec realtime_recommendation common_neighbors connected_component degree_correlation triangle_count cluster_coefficient common_neighbors_of_vertex_sets all_shortest_paths_of_vertex_sets filtered_circle_detection filtered_all_pairs_shortest_paths filtered_all_shortest_paths filtered_n_paths parameters 是 Object 算法参数。详情请参考各算法参数描述。 表2 2.1.7版本新增Body参数说明 参数 是否必选 类型 说明 executionMode 否 String sync：同步 async：异步 默认值为“async”。 支持的算法（以下显示的均为算法实际调用时的名称）： k_hop shortest_path all_shortest_paths filtered_shortest_path shortest_path_of_vertex_sets n_paths realtime_recommandation filtered_all_pairs_shortest_paths filtered_all_shortest_paths offset 否 Integer 同步结果的偏移量，默认值为“0”。 说明： executionMode=sync时有效。 支持的算法（以下显示的均为算法实际调用时的名称）： k_hop shortest_path all_shortest_paths shortest_path_of_vertex_sets n_paths realtime_recommandation filtered_all_pairs_shortest_paths filtered_all_shortest_paths limit 否 Integer 同步结果返回的最大数量，最大值为100000。默认值为“100000”。 说明： executionMode=sync时有效。 支持的算法（以下显示的均为算法实际调用时的名称）： k_hop shortest_path all_shortest_paths shortest_path_of_vertex_sets n_paths realtime_recommandation filtered_all_pairs_shortest_paths filtered_all_shortest_paths 表3 2.2.4版本新增Body参数说明 参数 是否必选 类型 说明 vertex_filter 否 Object 路径中对节点的过滤条件。 支持的算法（以下显示的均为算法实际调用时的名称）： filtered_shortest_path filtered_all_pairs_shortest_paths filtered_all_shortest_paths 具体格式请见 Filtered-query API中的表6。 edge_filter 否 Object 路径中对边（关系）的过滤条件。 支持的算法（以下显示的均为算法实际调用时的名称）： filtered_shortest_path filtered_all_pairs_shortest_paths filtered_all_shortest_paths 具体格式请见 Filtered-query API中的表6。 filters 否 Object 过滤条件列表，数组的每个元素分别对应每一层要做的查询和过滤条件。该参数仅适用于带一般过滤条件环路检测（filtered circle detection）,具体格式请见filters元素格式。 支持的算法： filtered_n_paths filtered_circle_detection topicrank

响应参数 同步返回 表10 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 查询结果。查询失败时，字段为空。 表11 data参数说明 参数 类型 说明 vertices List 点的结果集合。filters最后一层为点过滤时，data中将包含vertices。 edges List 边的结果集合。filters最后一层为边过滤时，data中将包含edges。 异步返回 表12 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，该字段为空。 jobType Integer 任务类型。请求失败时，该字段为空。

响应示例 同步返回 状态码： 200 成功响应示例 { "data":{ "vertices":[ { "id":"51", "label":"user", "properties":{ "occupation":[ "homemaker" ], "gender":[ "F" ], "Zip-code":[ "46911" ], "userid":[ 5 ], "age":[ "56+" ] } } ] } } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph [tesdt_117] is not found", "errorCode": "GES.8806" }

请求示例 请求样例1：列出满足过滤条件的第k跳节点或边，查询类型是出点，作用在下一跳的点上。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=path-query { "repeat":[ { "operator":"outV", "vertex_filter":{ "property_filter":{ "leftvalue":{ "label_name":"labelName" }, "predicate":"=", "rightvalue":{ "value":"rate" } } } } ], "times":2, "vertices":[ "1","2" ] } 以上请求等价于gremlin语句：g.V('1','2').repeat(out().hasLabel('rate')).times(2).dedup() 请求样例2：列出满足过滤条件的第k跳节点或边，查询类型是出点，作用在下一跳的点上。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=path-query { "repeat":[ { "operator":"outV", "vertex_filter":{ "property_filter":{ "leftvalue":{ "label_name":"labelName" }, "predicate":"=", "rightvalue":{ "value":"rate" } } } } ], "until":[ { "vertex_filter":{ "property_filter":{ "leftvalue":{ "property_name":"movieid" }, "predicate":"=", "rightvalue":{ "value":"1" } } } } ], "vertices":[ "v1","v2" ] } 以上请求等价于gremlin语句： g.V('v1','v2').repeat(out().hasLabel('rate')).until(has('movieid','1')).dedup()

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 关闭图任务ID。请求失败时为空。 表4 响应Body参数 参数 参数类型 描述 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。

请求示例 批量添加边，边的起点为46，边的终点分别为39和38，边的标签为rate。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-add { "parallelEdge": { "action": "override", "ignoreLabel": false, "targetProperties": [ { "label": "rate", "properties": [ "Datetime" ] }, { "label": "superclassOf", "properties": [ "popularity" ] } ] }, "createNotExists": true, "edges": [ { "source": "46", "target": "39", "label": "rate", "properties": { "Rating": [ 5 ], "Datetime": [ "2018-01-01 20:30:05" ] } }, { "source": "46", "target": "39", "label": "rate", "properties": { "Rating": [ 4 ], "Datetime": [ "2018-01-01 20:30:05" ] } } ] } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。 样例中，若假设点666和777不在原图中，则创建666和777两个点，且label为默认值，之后再添加边。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "result":"success", "data": { "edges": [ { "index": "7", "source": "46", "target": "39" }, { "index": "0", "source": "46", "target": "38" } ] } } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"Edge source vertex [Lily] does not exist", "errorCode":"GES.8000" }

响应参数 表6 响应参数说明 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 data Json 结果详情数据，具体请参见data参数说明。 表7 data参数说明 参数 类型 说明 vertices List 结果包含的点集合。 edges List 结果包含的边集合。

请求样例 观察某些节点群体结构的动态演化过程，算法名称为temporal_graph，动态分析的开始时间为${startTime}，结束时间为${endTime}。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/dynamicgraphs/action?action_id=execute-analysis { "algorithmName":"temporal_graph", "dynamicRange":{ "start":"${startTime}", "end":"${endTime}", "time_props":{"stime":"${property(start_time)}","etime":"${property(start_time)}"} }, "parameters":{ "sources":[], "temporal_vertex":false } }

响应示例 状态码： 200 响应成功示例 Http Status Code: 200 { "data": { "vertices": [{ "id": "Place00032", "label": "Place", "properties": {} }, { "id": "Person00041", "label": "Person", "properties": { "gender": ["女"], "phone": ["P0334529194"], "name": ["吴桂芳"], "startTime": [1774368], "endTime": [16756560], "age": [48] } }], "edges": [{ "index": "0", "source": "Person00041", "label": "hasVisit", "properties": { "startTime": [1646092800], "visitDate": [20220301], "endTime": [1646126769] }, "target": "Place00032" }, { "index": "3", "source": "Person00041", "label": "hasVisit", "properties": { "startTime": [1646168289], "visitDate": [20220301], "endTime": [1646179199] }, "target": "Place00032" }] } } 状态码： 400 响应失败示例 Http Status Code: 400 { "errorMessage": "Dynamic Analysis is not supported in this instance. Please build dynamic graph instance", "errorCode": "GES.9001" }

响应示例 状态码： 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":"shortest_path_of_vertex_sets", "parameters":{ "sources: "145,78,77,76", "targets": "23,32", "directed": true } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 是 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 sources 是 String 起点ID集合，标准csv格式，ID之间以英文逗号分隔，例如："Alice,Nana"，个数不大于100000。 targets 是 String 终点ID集合标准csv格式，ID之间以英文逗号分隔，例如："Mike,Amy"，个数不大于100000。 directed 否 Boolean 是否考虑边的方向。取值为true或false。默认取值为false。 说明： 当数据集不包含inedge时，若directed=true，选择一个不依赖于Inedge的算法实现版本计算输出，性能会下降；若directed=false，会报错。

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