华为云用户手册

  • 请求参数 表2 请求Body参数 参数 是否必选 类型 说明 exportPath 是 String 转存路径。 obsParameters 是 String OBS认证参数。具体请见表 obsParameters参数说明。 erase 否 Boolean 转存后是否删除原job任务的结果,取值为true或false,默认值为true即表示默认删除job结果并释放资源。 表3 obsParameters参数说明 参数 是否必选 类型 说明 accessKey 是 string ak值。 secretKey 是 string sk值。
  • 响应参数 表4 响应Body参数 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 jobId String 执行该异步任务的jobId。请求失败时,字段为空。 说明: 可以利用返回的jobId查看任务执行状态、获取算法返回结果,详情参考查询Job状态(1.0.0)。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "result": "success" } 状态码: 400 失败响应示例 HttpStatusCode: 400 { "errorMessage": "Graph [ {project_id} -movie1] does not exist, please check project_id and graph_name.", "errorCode": "GES.8000", "result": "failed" }
  • 请求示例 请求示例1:取消已经提交的某个作业。 DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id} 请求示例2:取消全部排队中的作业。 DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 响应参数 参数 类型 说明 errorMessage String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 errorCode String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 jobId String 执行算法任务ID。请求失败时,字段为空。 说明: 可以利用返回的jobId查看任务执行状态、获取算法返回结果,详情参考查询Job状态(1.0.0)。 jobType Integer 任务类型。请求失败时,字段为空。
  • 响应示例 状态码: 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 参数 是否必选 类型 说明 sources 是 String 起点ID集合,多个节点ID以逗号分隔(即,标准CSV输入格式),个数不大于100000。 targets 是 String 终点ID集合,多个节点ID以逗号分隔(即,标准CSV输入格式),个数不大于100000。 directed 否 Boolean 是否考虑边的方向。取值为true或false,默认值为false。 说明: 当数据集不包含inedge时,若directed=true,选择一个不依赖于Inedge的算法实现版本计算输出,性能会下降;当directed=false时,会报错。 cutoff 否 Integer 最大长度,取值范围为[1,100],默认值为6。 path_limit 否 Integer 路径数量上限,取值范围是[1,1000000],默认值为1000000。
  • 请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"all_pairs_shortest_paths", "parameters":{ "sources":”1,2”, "targets":”5,6”, "directed":true, "cutoff":3, "path_limit":10000 } } 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" }
  • 请求示例 POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"shortest_path", "parameters":{ "source":"1", "target":"5", "directed":true, "weight":"", } } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 响应参数 参数 类型 说明 errorMessage String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 errorCode String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 jobId String 执行算法任务ID。请求失败时,字段为空。 说明: 可以利用返回的jobId查看任务执行状态、获取算法返回结果,详情参考查询Job状态(1.0.0)。 jobType Integer 任务类型。请求失败时,字段为空。
  • 响应示例 状态码: 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" }
  • 请求参数 表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,会报错。 weight 否 String 边上权重。取值为:空或字符串。 空:边上的权重、距离默认为1。 字符串:对应的边上的属性将作为权重,当某边没有对应属性时,权重将默认为1。
  • 响应示例 状态码: 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" }
  • 请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"k_hop", "parameters":{ "k":3, "source":66, "mode":"ALL" } } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 是 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 k 是 Integer 跳数,取值范围[1,100]。 source 是 String 起点的ID。 mode 否 String 查找方向。取值如下: OUT:沿出边跳。(默认值) IN:沿入边跳 ALL:沿双边跳 说明: 当数据集不包含inedge时,若mode=OUT,选择一个不依赖于Inedge的算法实现版本计算输出,性能会下降;若mode=IN或mode=ALL,会报错。 switch 否 Integer 当激活边的数量达到总边数/switch数值时,进行pull/push模式切换,取值范围[1,2000],默认值为40。
  • 响应参数 参数 类型 说明 errorMessage String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 errorCode String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 jobId String 执行算法任务ID。请求失败时,字段为空。 说明: 可以利用返回的jobId查看任务执行状态、获取算法返回结果,详情参考查询Job状态(1.0.0)。 jobType Integer 任务类型。请求失败时,字段为空。
  • 响应示例 状态码: 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" }
  • 请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"betweenness", "parameters":{ "seeds":"1,2", "directed":true } } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 是 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 directed 否 Boolean 是否考虑边的方向。取值为true或者false,默认值为true。 weight 否 String 边上权重,取值为空或字符串。 当某边没有对应属性时,权重将默认为1。 空:边上的权重、距离默认为“1"。 字符串:对应的边上的属性将作为权重。 说明: 不支持对缺失属性值的默认处理,会直接报错。 HyG对缺失属性进行了默认处理支持。 seeds 否 String 节点ID,输入节点个数不大于100000。 当图较大时,运行精确betweenness较慢,可以设置seeds作为采样节点,进行近似运算,seeds节点越多越接近精确解。 k 否 Integer 采样个数,k不大于100000。 当图较大时,运行betweenness较慢,可以设置k,算法将从图中随机选取k各点,进行采样运算,k值越大约接近准确解。 当进行采样近似betweenness运算时,seeds和k参数二选一输入即可,当两者同时输入时,默认以seeds节点作为采样节点运算,忽略k。
  • 响应参数 参数 类型 说明 errorMessage String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 errorCode String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 jobId String 执行算法任务ID。请求失败时,字段为空。 说明: 可以利用返回的jobId查看任务执行状态、获取算法返回结果,详情参考查询Job状态(1.0.0)。 jobType Integer 任务类型。请求失败时,字段为空。
  • 响应参数 参数 类型 说明 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":"edge_betweenness", "parameters":{ "OD_pairs":"1,2\\n3,4", "directed":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" }
  • 请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 是 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 directed 否 Boolean 是否考虑边的方向。取值为true或false,默认值为false。 weight 否 String 边上权重。取值为:空或字符串。 空:边上的权重、距离默认为1。 字符串:对应的边上的属性将作为权重,当某边没有对应属性时,权重将默认为1。 OD_pairs 否 String 起点终点节点对, 标准csv格式,起点和终点以英文逗号分隔,各起点和终点节点对之间以换行符“\\n"分隔,例如:“Alice,Nana\\nLily,Amy"。 seeds 否 String 热点事件发生地的节点ID,ID个数在30以内。 当未知OD_pairs数据时,输入seeds数据。标准csv格式,节点之间以英文逗号分隔,例如:“Alice,Nana"。 modes 否 String 与seeds对应的热点事件类别。 IN: 表示以热点事件发生地点的节点ID作为起点 。 OUT:表示以热点事件发生地点的节点ID作为终点。 attendees 否 String 与seeds对应的热点事件参加人数,取值范围为[1,1000000]。 标准csv格式,数字之间以英文逗号分隔,例如:“10,20"。 OD_pairs和seeds参数二选一,当OD_pairs和seeds同时输入时,以OD_pair为准,忽略seeds。
  • 响应参数 表4 要素说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 jobId String 执行该异步任务的jobId。 说明: 可以查询jobId查看任务执行状态、获取返回结果,详情参考Job管理API。 图数据库中的悬空边(边存在,但是边的source节点或target节点不存在)不会同步到HyG引擎。
  • 请求参数 表2 Body参数说明 参数 是否必选 类型 说明 vertex 否 Json 点属性列表,如果列表为空,则不会同步点属性。参数详见vertex、edge参数说明。 首次执行数据同步时,该参数生效,后续执行数据同步,该参数默认跟首次指定的保持一致。 edge 否 Json 边属性列表,如果列表为空,则不会同步边属性。参数详见vertex、edge参数说明。 首次执行数据同步时,该参数生效,后续执行数据同步,该参数默认跟首次指定的保持一致。 表3 vertex、edge参数说明 参数 是否必选 类型 说明 label 是 String label名称。 property 是 Array of strings 属性名称,属性要隶属于该标签。
  • 请求示例 图数据库的更新信息同步到HyG计算引擎,点属性列表为空,边属性列表的属性名称为“Rating”、label名称为“rate”。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/sync { "vertex": [], "edge": [ { "property": [ "Rating" ], "label": "rate" } ] } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232" } 状态码: 400 失败响应示例 Http Status Code: 400 { "errorCode": "GES.8011", "errorMessage": "graph : movie2 is not exist" }
共100000条