云服务器内容精选

  • 请求参数 表1 请求Body参数说明 参数 是否必选 类型 说明 algorithmName 是 String 算法名字,详见具体的各个算法。 parameters 否 Object 算法参数。详情请参考各算法参数描述。 output 否 Object 结果输出参数。具体请见表2。 timeout 否 Integer 超时时间,单位为秒。 说明: 最大团(max_clique)、mccis算法不支持该参数。 表2 output参数说明 参数 是否必选 类型 说明 format 否 String 算法结果的输出格式。可选值是["JSON", "TXT"],默认值是"JSON"。TXT格式请参考算法结果TXT格式说明。 mode 否 String 算法结果的输出模式。可选值是["FULL", "TRUNCATED"]。默认值是"TRUNCATED"。 "FULL"表示算法结果全量输出。"FULL"模式下,当前只支持"TXT"这个格式,且算法结果会写到集群节点的本地目录,需要通过"export-result"接口将全量结果写到obs才能访问。 "TRUNCATED"表示算法结果截断输出,当前只支持"JSON"这种格式。 对于存在默认值的参数,如果传参数值为null,按默认值处理。
  • 响应示例 根据输入参数,执行指定算法,查询算法结果(根据算法请求返回的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" }
  • 请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName": "topicrank", "vertex_filter": { "property_filter": { "leftvalue": { "label_name": "labelName" }, "predicate": "=", "rightvalue": { "value": "user" } } }, "parameters": { "sources": "lili,andy", "alpha": 0.85, "convergence": 0.00001, "max_iterations": 1000, "filtered": "true" } } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122", "jobType": 1 } 状态码: 400 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8402" }
  • 响应参数 参数 类型 说明 errorMessage String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 errorCode String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 jobId String 执行算法任务ID。请求失败时,字段为空。 说明: 可以利用返回的jobId查看任务执行状态、获取算法返回结果,详情参考查询Job状态(1.0.0)。 jobType Integer 任务类型。请求失败时,字段为空。
  • 请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 是 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 source 是 String 输入路径的起点ID。 directed 否 Boolean 是否考虑边的方向。取值为true或false。 说明: false当前版本在有权图上不支持。 当数据集不包含inedge时,若directed=true,选择一个不依赖于Inedge的算法实现版本计算输出,性能会下降;若directed=false,会报错。 weight 否 String 边上权重。取值为:空或字符串。 空:边上的权重、距离默认为1。 字符串:对应的边上的属性将作为权重,当某边没有对应属性时,权重将默认为1。
  • 响应参数 表4 响应Body参数 参数 类型 说明 errorMessage String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 errorCode String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 jobId String 执行算法任务ID。请求失败时,字段为空。 说明: 可以利用返回的jobId查看任务执行状态、获取算法返回结果,详情参考查询Job状态(1.0.0)。 jobType Integer 任务类型。请求失败时,字段为空。
  • 请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"sssp", "parameters":{ "source":"1", "directed":true, "weight": "" } } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122", "jobType": 1 } 状态码: 400 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8402" }
  • 最短路径(shortest_path)(2.1.5) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 输入路径的起点ID。 String - - target 是 输入路径的终点ID。target取值不能与source取值相同。 String - - weight 否 边上权重。 String 空或字符串。 空:边上的权重、距离默认为“1”。 字符串:对应的边上的属性将作为权重,当某边没有对应属性时,权重将默认为1。 说明: 边上权重应大于0。 - directed 否 是否考虑边的方向。 Boolean true或false。 false timeWindow 否 用于进行时间过滤的时间窗 Object 具体请参见表2。 说明: timeWindow目前不支持带weight的最短路,即timeWindow与weight不可同时输入。 - 表2 timeWindow参数说明 参数 是否必选 说明 类型 取值范围 默认值 filterName 是 用于进行时间过滤的时间属性名称 String 字符串:对应的点/边上的属性作为时间 - filterType 否 在点或边上过滤 String V:点上 E:边上 BOTH:点和边上 BOTH startTime 否 起始时间 String Date型字符串或时间戳 - endTime 否 终止时间 String Date型字符串或时间戳 - 表3 response_data参数说明 参数 类型 说明 path List 最短路径,格式: [vertexId,...] 其中, vertexId:string类型 source String 起点ID target String 终点ID 父主题: 算法API参数参考
  • 连通分量(connected_component)(1.0.0) 当前该算法不需要输入parameters参数就可以运行。 表1 response_data参数说明 参数 类型 说明 Max_WCC_size Integer 最大连通分量中节点的个数 Max_WCC_id String 最大连通分量对应的连通集合ID community List 各节点对应的连通集合(community),格式:[{vertexId:communityId},...] 其中, vertexId: string类型 communityId: string类型 父主题: 算法API参数参考
  • louvain算法(louvain)(2.2.1) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 convergence 否 收敛精度。 Double 0~1,不包括0和1。 0.00001 max_iterations 否 最大迭代次数。 Integer API调用限制为[1,2147483647],前端调用限制为[1,2000],默认值为100。 100 weight 否 边上权重 String 空或字符串 空:边上的权重、距离默认为“1” 字符串:对应的边上的属性将作为权重,当某边没有对应属性时,权重将默认为“1” 说明: 边上权重应大于0。 weight 关于迭代次数(iterations)和收敛精度(convergence)参数如何调节,请参考迭代次数和收敛精度的关系。 表2 reponse_data参数说明 参数 类型 说明 modularity Double 模块度。 community_num Integer 社团数量。 community List 各节点对应的社团(community),格式: [{vertexId:communityId},...] 其中, vertexId: string类型 communityId: string类型 父主题: 算法API参数参考
  • 请求示例 带过滤的n_paths算法,算法名称是filtered_n_paths,跳数是6,路径数是100,起始点是111,终点是56。 POST http://IP:PORT/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" }}
  • 任务返回示例 { "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"}
  • 请求参数 表1 body体格式 字段名 是否必选 类型 说明 algorithmName 是 String 对应值为“filtered_n_paths”。 parameters 是 Json格式 具体格式见表parameters参数说明。 filters 是 JSon Array 过滤条件列表,数组的每个元素分别对应每一层要做的查询和过滤条件。具体格式见表filters元素格式。 表2 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 起始点 String 图内部点 无 target 是 目标点 String 图内部点 无 k 是 跳数 Int [2,6] 2 n 是 路径数 Int [1,1000] 1 表3 filters元素格式 参数 是否必选 类型 取值范围 默认值 说明 edge_filter 否 json 无 无 全图查询边时的过滤条件。 vertex_filter 否 json 无 无 全图查询点时的过滤条件。 表4 response_data参数说明 字段名 是否必选 类型 说明 path_length 是 int 路径长度。 paths_number 是 int 路径数量。 paths 是 JsonArray 路径集合,["111","119","58","96","82","57","56"]。 source 是 String 起始点。 target 是 String 目标点。