华为云用户手册

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 要查询的索引数据。 result String 查询结果，成功时为success。 indices List 查询结果，索引列表。 indexType String 查询结果，索引类别。 indexName String 查询结果，索引名称。 indexProperty List 查询结果，创建的索引属性列表。 hasLabel String 查询结果，索引中是否包含label。 说明： 全文索引该参数默认值为false。 hasLabel（持久化版） Boolean 查询结果，索引中是否包含label。 说明： 全文索引该参数默认值为false。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "data": { "result": "success", "indices": [ { "indexType": "GlobalCompositeVertexIndex", "indexName": "ageIndx", "indexProperty": [ "age" ], "hasLabel": "true" } ] }} 状态码： 200 成功响应示例（持久化版） Http Status Code: 200{ "data": { "indices": [ { "indexType": "GlobalCompositeVertexIndex", "indexName": "ageIndx", "indexProperty": [ "age" ], "hasLabel": true } ] }, "result": "success"} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "graph [demo] is not found", "errorCode": "GES.8605"}

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

请求示例 POST http://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=export-graph{ "graphExportPath" : "demo_movie/", "edgeSetName" : "set_edge.csv", "vertexSetName" : "set_vertex.csv", "schemaName" : "set_schema.xml"}

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 表4 请求Body参数 参数 是否必选 参数类型 描述 graphExportPath 是 String 图的导出OBS路径。 edgeSetName 是 String 导出边文件名。 vertexSetName 是 String 导出点文件名。 schemaName 是 String 导出元数据文件名。 graphExportPath字符串取值合法性参考OBS对象名约束。

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。 枚举值： export-graph

响应示例 状态码： 200 OK { "gesMetadata": { "labels": [ { "name": "friends", "properties": null }, { "name": "movie", "properties": [ { "dataType": "string", "name": "ChineseTitle", "cardinality": "single" }, { "dataType": "int", "name": "Year", "cardinality": "single" }, { "dataType": "string", "name": "Genres", "cardinality": "set" } ] }, { "name": "user", "properties": [ { "dataType": "string", "name": "ChineseTitle", "cardinality": "single" }, { "dataType": "int", "name": "Year", "cardinality": "single" }, { "dataType": "string", "name": "Genres", "cardinality": "set" }{ "typeName1": "F", "typeName2": "M", "typeNameCount": "2", "dataType": "enum", "name": "Gender", "cardinality": "single" }, { "typeName1": "Under 18", "typeName2": "18-24", "typeName3": "25-34", "typeName4": "35-44", "typeNameCount": "7", "dataType": "enum", "name": "Age", "typeName5": "45-49", "typeName6": "50-55", "cardinality": "single", "typeName7": "56+" }, { "dataType": "string", "name": "Occupation", "cardinality": "single" }, { "dataType": "char array", "name": "Zip-code", "maxDataSize": "12", "cardinality": "single" } ] }, { "name": "rate", "properties": [ { "dataType": "int", "name": "Score", "cardinality": "single" }, { "dataType": "date", "name": "Datetime", "cardinality": "single" } ] } ] }} 状态码： 500 Internal Server Error { "errorCode" : "GES.7006", "errorMessage" : "The underlying graph engine has internal error."}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 gesMetadata GesMetaData object 存储metadata的消息信息的对象。 表4 GesMetaData 参数 参数类型 描述 labels Array of Label objects Label数据结构集合。 表5 Label 参数 参数类型 描述 name String Label的名称。 properties Object 表示元数据属性的map，键值对由用户导入的元数据决定。

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

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

请求参数 表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 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 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

响应示例 状态码： 200 OK Http Status Code: 200{ "jobId": "ff80808167f09aaa0167f19b35ec0305", "status": "success", "jobType": "GraphManagement", "jobName": "ImportGraph", "relatedGraph": "GES_UI_AUTO", "beginTime": "2018-11-27T21:39:00", "endTime": "2018-11-27T21:39:56", "jobDetail": { "vertexsetPath": [ { "path": "ges-ui/auDatas/list_set_vertex.csv", "log": null, "cause": null, "status": "success" } ], "edgesetPath": [ { "path": "ges-ui/auDatas/list_set_edge.csv", "log": null, "cause": null, "status": "success" } ], "schemaPath": [ { "path": "ges-ui/auDatas/list_set_schema.xml", "log": null, "cause": null, "status": "success" } ] }, "jobProgress": 0} 状态码： 400 Bad Request { "errorMessage" : "can not find job, jobId is ff808081646e81d40164c5fb414b2b1a1", "errorCode" : "GES.8301"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 任务ID。 status String 任务状态。 pending:等待中 running:运行中 success:成功 failed:失败 jobType String 任务类型。 jobName String 任务名称。 relatedGraph String 关联图名称。 beginTime String 任务开始时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" endTime String 任务结束时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" jobDetail JobDetail object 只有jobName为ImportGraph时才返回，用于显示导入图详情。 failReason String 任务失败原因。 jobProgress Double 任务执行进度，预留字段。 表4 JobDetail 参数 参数类型 描述 schemaPath Array of schemaPath objects 元数据路径。 edgesetPath Array of edgesetPath objects 边数据集路径。 vertexsetPath Array of vertexsetPath objects 点数据集路径。 表5 schemaPath 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功 cause String 导入失败原因。 表6 edgesetPath 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功 cause String 导入失败原因。 totalLines Long 导入的总行数，以您的配额以及所创图的规格为准。其值为-1时表示当前版本没有返回该字段。 failedLines Long 导入失败行数。其值为-1时表示当前版本没有返回该字段。 successfulLines Long 导出成功行数。其值为-1时表示当前版本没有返回该字段。 表7 vertexsetPath 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功 cause String 导入失败原因。 totalLines Long 导入总行数。以您的配额以及所创图的规格为准，其值为-1时表示当前版本没有返回该字段。 failedLines Long 导入失败行数。其值为-1时表示当前版本没有返回该字段。 successfulLines Long 导出成功行数。其值为-1时表示当前版本没有返回该字段。

全最短路（all_shortest_paths）(1.0.12) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 输入路径的起点ID。 String - - target 是 输入路径的终点ID。 String - - directed 否 是否考虑边的方向。 Boolean true或false。 false 表2 response_data参数说明 参数 类型 说明 paths List source节点和target节点之间所有的最短路径，格式： [[path1],[path2]] 其中，路径（path）的格式可参考：最短路径（Shortest Path）。 paths_number Integer 路径个数 source String 起点ID target String 终点ID 父主题： 算法API参数参考

最短路径（Shortest Path）(1.0.0) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 输入路径的起点ID。 String - - target 是 输入路径的终点ID。 String - - weight 否 边上权重。 String 空或字符串。 空：边上的权重、距离默认为“1”。 字符串：对应的边上的属性将作为权重，当某边没有对应属性时，权重将默认为1。 说明： 边上权重应大于0。 - directed 否 是否考虑边的方向。 Boolean true或false。 false 表2 response_data参数说明 参数 类型 说明 path List 最短路径，格式： [vertexId,...] 其中, vertexId：string类型 source String 起点ID target String 终点ID 父主题： 算法API

关联路径（n_paths）(1.1.2) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 输入路径的起点ID。 String - - target 是 输入路径的终点ID。 String - - directed 否 是否考虑边的方向。 Boolean true或false false n 否 路径个数。 Integer 1~100 10 k 否 层数。 Integer 1~10 5 表2 response_data参数说明 参数 类型 说明 paths List source节点和target节点之间的路径，格式： [[path1],[path2]] 其中，路径（path）的格式可参考：最短路径（Shortest Path）。 paths_number Integer 路径个数 source String 起点ID target String 终点ID 父主题： 算法API参数参考

Louvain算法(1.0.0) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 convergence 否 收敛精度。 Double 0~1，不包括0和1。 0.00001 max_iterations 否 最大迭代次数。 Integer 1~2000。 100 表2 reponse_data参数说明 参数 类型 说明 modularity Double 模块度。 community_num Integer 社团数量。 community List 各节点对应的社团(commmunity)，格式： [{vertexId:communityId},...] 其中, vertexId: string类型 communityId: string类型 父主题： 算法API

标签传播（Label Propagation）(1.0.0) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 coveragence 否 收敛精度。 Double 0~1，不包括0和1。 0.00001 max_iterations 否 最大迭代次数。 Integer 1~2000。 1000 表2 reponse_data参数说明 参数 类型 说明 community List 各节点对应的社团(commmunity)，格式： [{vertexId:communityId},...] 其中, vertexId: string类型 communityId: string类型 父主题： 算法API

关联预测（link_prediction）(1.0.0) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 输入起点ID。 String - - target 是 输入终点ID。 String - - 表2 response_data参数说明 参数 类型 说明 source String 起点ID target String 终点ID link_prediction Double 关联预测结果 父主题： 算法API参数参考

node2vec算法（node2vec）(1.0.5) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 P 否 回退参数。 Double 大于0 1 Q 否 前进参数。 Double 大于0 1 dim 否 映射维度。 Integer 1~200，包括1和200。 50 walkLength 否 随机步长。 Integer 建议取1~100，包括1和100。 40 walkNumber 否 每个节点的随机步长数。 Integer 建议取1~100，包括1和100。 10 iterations 否 迭代次数。 Integer 1~100，包括1和100。 10 表2 response_data参数说明 参数 类型 说明 embedding List 各点映射到欧式空间的向量表示，格式： [{vertexId:vectorValue}] 其中， vertexId: string类型 vectorValue：欧式向量，例如[-0.485,-0.679,0.356] 父主题： 算法API参数参考

共同邻居（common_neighbors）(1.0.0) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 输入起点ID。 String - - target 是 输入终点ID。 String - - 表2 response_data参数说明 参数 类型 说明 vertices List 公共邻居节点，格式： [vertexId,...], 其中, vertexId：string类型 common_neighbors Integer 公共邻居节点个数。 source String 起点ID。 target String 终点ID。 父主题： 算法API参数参考

实时推荐（realtime_recommendation）(2.2.21) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 sources 是 节点的ID，可以是多个。 String source节点的个数不超过上限（默认30个，可以通过source_limit调节）。节点之间用逗号进行分割。 - alpha 否 权重系数，其值越大，步长越长。 Double 0~1，不包括0和1。 0.85 N 否 总的游走步数。 Integer 1~200000。 10000 nv 否 游走过程提前结束参数：候选推荐节点访问次数的最小值。 说明： 对于一个节点，如果其在随机游走过程被访问到，且被访问到的次数达到“nv”，则该节点将记入候选推荐的节点。 Integer 1~10。 5 np 否 游走过程提前结束参数：候选推荐节点个数。 说明： 若某个source节点的候选推荐节点达到“np”，对于该source节点的随机游走将提前结束。 Integer 1~2000。 1000 label 否 希望输出的点的类型。 说明： 其值为空时，将不考虑点的类型，输出算法原始计算结果。 对其赋值时，将从计算结果中过滤出具有该“label”的点的返回。 String 节点label。 - directed 否 是否考虑边的方向。 Boolean true 或false。 true source_limit 否 控制sources的个数上限 Int 1~100000 30 restricted 否 是否接受不合法的source节点输入 restricted=true时，当有图上不存在的source节点输入时，报错; restricted=false，接受包含图上不存在的节点作为sources进行输入，但若所有source节点都不存在时，报错 Bool true 或false。 true 表2 response_data参数说明 参数 类型 说明 score List 各节点的得分，反应推荐程度，值越大推荐度越高，格式： [{vertexId：scoreValue},...] 其中， vertexId: string类型 scoreValue: double类型 sources List 起始节点的ID。 父主题： 算法API参数参考

URI POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/properties/action?action_id={actionId} 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 vertex_id 是 String 点ID，也就是点名称。 actionId 是 String 操作符。 update更新该属性的值 add 添加属性的值。当属性的cardinality为single时，其操作与update一致；当cardinality为list或set时，意为向集合中添加值。 del 删除属性的值

请求示例 更新点的属性值，属性Age的值为under 18，属性Gender的值为F。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/Lily/properties/action?action_id={actionId}{ "properties":{ "Age":[ "under 18" ], "Gender":[ "F" ] }} SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

三角计数（triangle_count）(1.0.0) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 statistics 否 是否仅输出总的统计量结果： true：仅输出总的统计数量。 false：输出各点对应三角形数量。 Boolean true或false，默认为true。 表2 response_data参数说明 参数 类型 说明 triangle_count Integer 三角形个数 vertex_triangles List 各节点的三角形个数，格式： [{vertexId : vertexTriangleCount},...], 其中, vertexId：string类型 vertexTriangleCount：Integer类型 父主题： 算法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：非强制升级，会等待已经运行的业务，升级过程可能较慢。

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

URI DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/{vertex_id}/labels/{label_name} 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 vertex_id 是 String 点ID，也就是点名称。 label_name 是 String 点label。

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

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 properties 是 Object label名称。 label 否 String label名称 targetProperties 否 Array 判断重复边所用的属性列表。 若不为空，则会覆盖重复边（起点终点一致）中，指定属性值与输入属性值相同的边的其他属性（若有多个指定属性，则修改按属性输入顺序匹配上的第一条边的属性）。 若为空或输入边没有指定属性则更新行为与之前一致——更新符合条件的第一条边。 属性列表元素格式见表 targetProperty参数说明。 表3 targetProperty参数说明 参数 是否必选 类型 说明 label 是 String label名称, 需要按属性判断重复边的Label。 properties 是 Array 各个属性的值。需要按属性来判断重复边的Property列表。当前仅支持单个属性，输入多个属性则取第一个。