华为云用户手册

OD中介中心度（od_betweenness）（2.2.4） 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 directed 否 是否考虑边的方向 Boolean true或者false true weight 否 边上权重 String 空或字符串 * 空：边上的权重、距离默认为“1”。 * 字符串：对应的边上的属性将作为权重，当某边没有对应属性时，权重将默认为1。 说明： 边上权重应大于0。 - OD 否 起点终点对 String 标准csv格式，起点和终点以英文逗号分隔，各起点和终点对之间以换行符“\n”分隔，例如：“Alice,Nana\nLily,Amy”。 - seeds 否 热点事件发生地的节点ID String 当未知OD数据时，输入seeds数据。 - modes 否 与seeds对应的热点事件类别 String IN： 表示以热点事件发生地点的节点ID作为起点 。 OUT：表示以热点事件发生地点的节点ID作为终点。 - capacity 否 与seeds对应的热点事件参加人数 Integer - - 表2 response_data参数说明 参数 类型 说明 betweenness List 各边的betweenness值，格式： [{“source”: sourceId, “target”: targetId , “index”: indexValue , “betweenness”: betweennessValue },...]，其中： betweennessValue：double类型 父主题： 算法API参数参考

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

点集共同邻居(common_neighbors_of_vertex_sets)(2.2.13) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 sources（2.2.6） 是 起点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如：“Alice,Nana”。 个数不大于100000。 - targets（2.2.6） 是 终点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如：“Mike,Amy”。 个数不大于100000。 - restricted（2.2.13） 否 是否带其他约束 Boolean true或false。 false：不带额外约束，即找到的共同邻居为起点集和终点集对应邻域的交集。 true，带额外约束，这里指找到的共同邻居不仅是起点集和终点集邻域的交集，同时共同邻居集合中的每个点都至少有2个以上邻居节点在起点集和终点集中。 true 表2 response_data参数说明 参数 类型 说明 vertices List 公共邻居节点，格式： [vertexId,...], 其中, vertexId：string类型 common_neighbors Integer 公共邻居节点个数。 父主题： 算法API参数参考

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "parameter format error", "errorCode": "GES.8013"}

请求示例 导入文件更新点边的指定属性，点文件目录为datasets/movie/movie.csv，点数据集格式为csv，边文件目录为datasets/movie/ranking_edge.csv，边数据集格式为csv。 POST http://Endpoint/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-properties{ "vertexsetPath": "datasets/movie/movie.csv", "vertexsetFormat": "csv", "vertexProperties": [ { "label": "movie", "properties": [ "genres" ] } ], "edgesetPath": "datasets/movie/ranking_edge.csv", "edgesetFormat": "csv", "edgeProperties": [ { "label": "rate", "properties": [ "Datetime" ] } ], "targetProperties": [ { "label": "rate", "properties": [ "Rating" ] } ], "delimiter": ",", "trimQuote": "\"", "obsParameters": {"accessKey": "XXXXXXX","secretKey": "XXXXXXX" }, "vertexFileContainLabel": true}

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

请求参数 导入文件更新属性的csv文件格式如下： 点文件（包含label）：点ID,label,property_1,…property_n 点文件（不包含label）：点ID,property_1,…property_n 边文件：源点ID,目的点ID,label,边ID属性,property_1,…property_n 表2 Body参数说明 参数 是否必选 类型 说明 vertexsetPath vertexsetPath和edgesetPath至少有一个 String 点文件目录或点文件名。 vertexsetFormat 否 String 点数据集格式。当前仅支持csv。 默认为csv。 vertexProperties 有vertexsetPath则必选 Object 点文件中点的label和待更新属性列表信息，JsonArray格式。 edgesetPath vertexsetPath和edgesetPath至少有一个 String 边文件目录或边文件名。 edgesetFormat 否 String 边数据集格式。当前仅支持csv。 默认为csv。 edgeProperties 有edgesetPath则必选 Object 边文件中边的label和待更新属性列表信息，JsonArray格式。 targetProperties 有edgesetPath则必选 Object 边文件中用于区分重复边的属性信息，JsonArray格式。 delimiter 否 Character csv格式文件字段分隔符，默认值为逗号（,）。list/set类型的字段内元素分隔符默认为分号（;）。 trimQuote 否 Character csv格式文件字段包围符，默认值为双引号（"）。用来包围一个字段，如字段中含有分隔符或者换行等。 obsParameters 是 String OBS认证参数。请参见表 obsParameters参数说明。 vertexFileContainLabel 否 Boolean 点文件是否包含label信息。可选选项，默认值是true。 表3 vertexProperties参数说明 参数 是否必选 类型 说明 label 是 String label名称。 properties 是 Object 待更新属性列表，需要与点文件中属性顺序一致，JsonArray格式。 表4 edgeProperties参数说明 参数 是否必选 类型 说明 label 是 String label名称。 properties 是 Object 待更新属性列表，需要与边文件中属性顺序一致，JsonArray格式。 表5 targetProperties参数说明 参数 是否必选 类型 说明 label 是 String label名称。 properties 是 Object 边ID属性信息，JsonArray格式。当前仅支持一个属性

请求示例 （仅支持异步模式）导出满足过滤条件的顶点集合，导出路径为demo_movie/，导出文件名export_movie_and_user.csv。 POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=export {"labels": ["movies","user"],"vertexFilters": [{"propertyName": "Age","predicate": "=","values": ["18-24"]}],"exportPath": "demo_movie/","fileName": "export_movie_and_user.csv","obsParameters": {"accessKey": "XXXX","secretKey": "XXXX"} }

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

点集全最短路(all_shortest_paths_of_vertex_sets)(2.2.15) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 sources 是 起点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如：“Alice,Nana”。 个数不大于100000。 - targets 是 终点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如：“Alice,Nana”。 个数不大于100000。 - directed 否 是否考虑边的方向 Boolean true 或false，布尔型。 false 表2 response_data参数说明 参数 类型 说明 paths List source节点和target节点之间所有的最短路径，格式： [[path1],[path2]] 其中，路径（path）的格式可参考：最短路径（Shortest Path）。 source String 路径的起点ID。 target String 路径的终点ID。 父主题： 算法API参数参考

参数说明 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 sources 否 查询的起始节点ID集合 String - 标准csv格式，ID之间以英文逗号分隔，例如:“Alice,Nana” n 否 枚举的满足过滤条件的圈的个数的上限 Integer [1,100000] 100 statistics 否 是否输出所有满足过滤条件的圈的个数 Boolean true或false false batch_number 否 批量处理的起始节点的个数 Integer [1,1000] 10 output_format 否 输出结果的格式 String vertexId,edgeId或edgeObject edgeObject filters 是 过滤条件列表，数组的每个元素分别对应每一层要做的查询和过滤条件。 Object - -

请求样例 Post http://{}/ges/v1.0/1/graphs/movie/action?action_id=execute-algorithm{ "algorithmName": "filtered_circle_detection", "parameters": { "n": 10, "statistics": true, "output_format":"edgeId" }, "filters": [ { }, { "operator": "out", "edge_filter": { "property_filter": { "leftvalue": { "label_name": "labelName" }, "predicate": "=", "rightvalue": { "value": "transfer" } } }, "times":5 } ]}

请求示例 批量添加元数据label，元数据label的名称分别为book和movie，以及两个label的待添加属性数组。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/action?action_id=batch-add { "labels": [ { "name": "book", "properties": [ { "property": { "name": "title", "cardinality": "single", "dataType": "string" } } ] }, { "name": "movie", "properties": [ { "property": { "name": "movieid", "cardinality": "single", "dataType": "int" } } ] } ]} SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应参数 表5 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 result String 响应结果。成功时result值为success，失败时值为failed。 data Object 当批量添加部分失败时，data字段包含失败的label_name以及失败原因。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 强制重启任务ID。请求失败时字段为空。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考任务中心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。 枚举值：restart

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 resize 是 GraphSizeTypeIndexReq object resize是一个对象，包含图规格类型。 表4 GraphSizeTypeIndexReq 参数 是否必选 参数类型 描述 graphSizeTypeIndex 是 String 图规格类型，当前支持取值为"2","3","4","5"分别代表扩容成千万边、一亿边、十亿边、百亿边规格的图。（graph_size_type_index）

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

请求示例 添加label的属性，待添加的属性名为title。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/properties{ "properties": [ { "name": "title", "cardinality": "single", "dataType": "string" } ]} SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "data": { "properties": [ { "name": "Rating", "type": "int", "cardinality": "single" }, { "name": "Datetime", "type": "string", "cardinality": "single" } ] }, "result": "success"} 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8204" }

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "data": { "property": { "name": "creation", "type": "string", "cardinality": "single" } }, "result": "success"} 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8204" }

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "data": { "properties": [ { "name": "test_weight", "type": "float", "cardinality": "single" }, { "name": "test_gender", "type": "string", "cardinality": "single" } ] }, "result": "success"} 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8204" }

导入限制 导入数据的步骤请参见导入数据说明。 持久化版规格的导入限制如下： 并发导入数据文件 持久化版规格可并发导入多个数据文件，推荐用户对数据文件进行拆分（OBS文件最大不超过5G），提高导图速度。 支持OBS上传导图日志 建议用户设置logDir参数，以保存导图日志，方便查看错误原因。 边数据导入策略 持久化版不支持导入边时自动生成点。仅导入边时，客户将无法查询点或从点访问图，因此建议导入边时也提供对应的点数据。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{"jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorCode": "GES.8012", "errorMessage": "graph [movie2] is not found"}

请求示例 请求示例1，进行导出图操作，图的导出OBS路径为demo_movie/，导出边数据集名称为set_edge，导出边数据集名称为set_vertex，导出元数据文件名为set_schema.xml。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph{ "graphExportPath": "demo_movie/", "edgeSetName": "set_edge", "vertexSetName": "set_vertex", "schemaName": "set_schema.xml", "paginate":{ "numThread":16, "rowCountPerFile":1000000}, "obsParameters": { "accessKey": "xxxxxx", "secretKey": "xxxxxx" }} 请求示例2 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=export-graph{ "graphExportPath": "demo_movie/", "edgeSetName": "set_edge.csv", "vertexSetName": "set_vertex.csv", "schemaName": "set_schema.xml", "obsParameters": { "accessKey": "xxxxxx", "secretKey": "xxxxxx" }}

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{"jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorCode": "GES.8011", "errorMessage": "graph [movie2] is not found"}

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

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 graphExportPath 是 String 图的导出OBS路径。 edgeSetName 是 String 导出边数据集名称。 vertexSetName 是 String 导出点数据集名称。 schemaName 是 String 导出元数据文件名。 paginate(2.3.11) 否 Object 分页相关参数，自2.3.11版本起导出图默认分页导出。 obsParameters 是 String Obs相关参数。 accessKey 是 String 用户的accessKey。 secretKey 是 String 用户的secretKey。 表3 参数paginate中各要素说明 参数 是否必选 类型 说明 enable 否 Bool 是否开启分页，默认为true。 不需要开启分页时，需输入值为false。 rowCountPerFile 否 Int 按页导出时每个文件的最大行数，默认最大为10000000。 numThread 否 Int 按页导出时的并行线程数，默认为8。 maxSizePerFile 否 Int 按页导出时每个文件大小的最大值，单位是byte，默认不超过导入时最大文件约束。

单源最短路（sssp）(1.0.0) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 节点的ID。 String - - directed 否 是否考虑边的方向。 Boolean true或false。 true 表2 response_data参数说明 参数 类型 说明 distance List 源节点（source）到图中各节点的路径长度： [{vertexId:distanceValue},...], 其中, vertexId：string类型 distanceValue：double类型 source String 源节点ID 父主题： 算法API参数参考

请求示例 进行导入图操作，边文件目录为testbucket/demo_movie/edges/，边数据集格式为csv，点文件目录为testbucket/demo_movie/vertices/，点数据集格式为csv，新增数据的元数据文件OBS路径为testbucket/demo_movie/incremental_data_schema.xml，日志存放目录为testbucket/importlogdir。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-graph{ "edgesetPath": "testbucket/demo_movie/edges/", "edgesetFormat": "csv", "vertexsetPath": "testbucket/demo_movie/vertices/", "vertexsetFormat": "csv", "schemaPath": "testbucket/demo_movie/incremental_data_schema.xml", "logDir": "testbucket/importlogdir", "parallelEdge": { "action":"override", "ignoreLabel":true, "targetProperties": [{"label": "label1","properties": ["property1"]},{"label": "label2","properties": ["property2"]}] }, "delimiter": ",", "trimQuote": "\"", "offline": true, "obsParameters": { "accessKey": "xxxxxx", "secretKey": "xxxxxx" }}