华为云用户手册

pagerank算法(1.0.0) 表1 parameters参数说明 参数 是否必选 类型 说明 alpha 否 Double 权重系数(又称阻尼系数)，取值范围为（0,1），默认值为0.85。 convergence 否 Double 收敛精度。取值范围(0,1)，默认值为0.00001。 max_iterations 否 Integer 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为1000。 num_thread 否 Integer 并发线程数。范围为[1,40]，小于1会自动置为1，大于40则自动置为40。默认值为4。 directed 否 Boolean 是否考虑边的方向。取值为true或false。默认值为true。 迭代次数（max_iterations）和收敛精度（convergence）。 算法终止的条件：要么达到设置的最大迭代次数，要么满足收敛精度，满足其一即可。 一般来说，收敛精度设置得越小，迭代次数设置得越大，算法的效果越好。 在固定收敛精度的情况下，要想算法优先满足收敛精度，迭代次数设置得尽量大。 迭代次数越大，算法运行时间越长。在固定迭代次数（即固定运行时间）的情况下，要想算法运行到设置的迭代次数，收敛精度设置得尽量小。 表2 response_data参数说明 参数 类型 说明 results List 各节点的pagerank值，格式：[{"id":vertexId,"pagerank":rankValue},...]。其中： vertexId：string类型。 rankValue：double类型。 父主题： 算法API参数参考

响应示例 请求成功样例 状态码：200 OK { "data":{ "vertices":[ { "id":"1", "label":"movie", "properties":{ "genres":[ "Comedy" ], "movieid":[ 1 ], "title":[ "Airplane! (1980)" ] } } ], "runtime":0.126476598 } } 请求失败样例 { "errorCode":"GES.8814", "errorMessage":"Unsupported API." }

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Can not find job to cancel, jobId is 2c90803d94eea6f80194f31256260005", "errorCode": "GES.8303" }

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232", "jobType": 8 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph [demo] is not found", "errorCode": "GES.8603" }

请求示例 创建复合索引，索引名称为ageIndex，索引类型为全局点索引。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices { "indexName":"ageIndex", "indexType": "GlobalCompositeVertexIndex", "hasLabel": true, "indexProperty": ["age"] }

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

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 indexName 是 String 索引名称。只能包含字母,数字,-和_。不能包含其他字符。索引名称的长度需在63字符以内。 说明： indexType 是 String 索引的类型，区分大小写。 “GlobalCompositeVertexIndex”为全局的Composite类型的点索引。 “GlobalCompositeEdgeIndex”为全局的Composite类型的边索引。 “CompositeVertexIndex”为局部的Composite类型的点索引。 “CompositeEdgeIndex”为局部的Composite类型的边索引。 “FullTextIndex”为全文索引。 hasLabel 否 Boolean 是否有label，默认为false。 true false indexLabel 否 List Label列表，仅在indexType为CompositeVertexIndex或CompositeEdgeIndex时有效，而且为必填项，用来指定在哪些label上建立索引。 indexProperty 否（若hasLabel为false或null，则该项为必选） List 索引的属性列表。 可以创建的属性类型有： integer、 float、 double、 long、 enum、 string、 date。 索引类型为复合类型时，仅支持属性类型为single。 strLength 否 Integer String类型的属性在编码索引时会按照一固定长度来截断，strLength用于指定此截断长度。未指定时默认值为40字节，用户可指定范围为[1, 256]。 通常用户不需要手动指定此参数，即使有些属性超过此长度，索引编码时被截断。一般也不会有明显的性能劣化。除非绝大多数属性均超过默认长度，可以考虑适当增大strLength，但是会带来索引修改的性能下降。 如果属性类型为string，属性长度建议不要超过40个字节，超出的部分会被截断。 Cypher查询可以借助hasLabel为True的索引来加速。 indexProperty为空时，建立的索引为label索引，可以加速label过滤。 indexProperty不为空时，建立的索引为属性索引，可以加速对应的属性过滤。

功能介绍 根据给定的indexName，IndexType等信息创建索引。目前支持两种索引：复合索引和全文索引。 复合索引有全局点索引（GlobalCompositeVertexIndex），全局边索引（GlobalCompositeEdgeIndex）以及局部点索引（CompositeVertexIndex），和局部边索引（CompositeEdgeIndex）。复合索引是针对固定组合的属性建立的，其中局部索引可以在指定的label上建立索引。而全局索引复合索引不需要指定label，只要某个label包含指定属性，就会自动在此label上建立索引。使用索引查询可以加快速度。 全文索引（FullTextIndex）可以实现全文搜索、模糊搜索等功能。由于全文索引的刷新机制，更新数据后立即查询可能查到的是旧数据，建议更新后间隔60秒以上再进行查询。全文索引的使用请查看点过滤查询和边过滤查询。您也可以使用cypher语句来执行全文索引，具体请查看cypher操作相关章节。 目前全文索引特性只在持久化版规格版本中支持。 索引创建后需要等待30秒索引同步时间，同步完成后Cypher查询才可以利用索引进行加速。

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName": "all_shortest_paths_of_vertex_sets", "parameters": { "sources": "145,78,77,76", "targets": "48,129,34,36", "directed": true } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

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

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

请求参数 表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，会报错。

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

响应参数 参数 类型 说明 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 限定寻找圈的个数。

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

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

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." }

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。

响应参数 状态码： 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 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

功能介绍 根据输入参数，执行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