华为云用户手册

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

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 否 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 alpha 否 Double 权重系数(又称阻尼系数)。取值范围为（0,1），默认值为0.85。 convergence 否 Double 收敛精度。取值范围（0,1），默认值为0.00001。 max_iterations 否 Int 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为1000。 directed 否 Boolean Boolean是否考虑边的方向，取值为true或false，默认为true。

响应示例 状态码： 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)。 pagerank List 各节点的pagerank值，格式：[{vertexId: rankValue},...]。其中： vertexId：string类型。 rankValue：double类型。

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"pagerank", "parameters":{ "alpha":0.85, "convergence":0.00001, "max_iterations":1000 } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 graph_backup_id 否 String 启动图时关联的备份ID，设置此参数时，表示从备份进行启动；如果为空，表示从上次关闭图时的状态启动。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 启动图任务ID。请求失败时字段为空。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

响应示例 状态码： 200 成功响应示例 { "job_id" : "ff8080816025a0a1016025a5a2700007" } 状态码： 400 失败响应示例 { "error_code" : "GES.7006", "error_msg" : "An internal error occurs in the underlying service of the graph engine." }

personalrank算法(1.0.0) 表1 parameters参数说明 参数 是否必选 类型 说明 source 是 String 节点的ID。 alpha 否 Double 权重系数(又称阻尼系数)，取值范围为（0,1），默认值为0.85。 convergence 否 Double 收敛精度。 取值范围0~1，不包括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。 weight 否 String 空或字符串。 空：边上的权重、距离默认为“1”。 字符串：对应的边上的属性将作为权重，当某边没有对应属性时，权重将默认为“1”。 说明： 边上权重应大于0。 关于迭代次数（max_iterations）和收敛精度（convergence）参数如何调节，请参考迭代次数和收敛精度的关系。 表2 response_data参数说明 参数 类型 说明 source String - results List 各节点的personalrank值，格式：[{"id":vertexId,"personalrank":rankValue},...]。其中： vertexId：string类型。 rankValue：double类型。 父主题： 算法API参数参考

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 强制重启任务ID。请求失败时字段为空。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考任务中心API。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

响应参数 状态码： 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，键值对由用户导入的元数据决定。

响应示例 状态码： 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 成功响应示例 { "schema": { "vertices": [ { "vertex": "user", "weight": 100 }, { "vertex": "movie", "weight": 46 } ], "edges": [ { "weight": 1209, "source": "user", "target": "movie", "relation": "rate" }, { "weight": 450, "source": "user", "target": "user", "relation": "default" } ] } } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"Parameter error!", "errorCode":"GES.8005" }

URI GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure?detail={details} 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 details 否 String 可为SIMPLE或FULL，SIMPLE模式表示只返回点或边的label，FULL模式表示除点或边的label外，还有点或边的数量。若该字段不填，则默认为SIMPLE。

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 schema Object schema结构查询结果。详情请参见schema参数说明。 表3 schema参数说明 参数 类型 说明 vertices Object 点的结果集合。图为空时，vertices内容为空。详情请参见vertices参数说明。 edges Object 边的结果集合。图为空时，edges内容为空。详情请参见edges参数说明。 表4 vertices参数说明 参数 类型 说明 vertex String label名。 weight Integer 具有该label的点的数量。 表5 edges参数说明 参数 类型 说明 source String 起始点label名。 target String 终点label名。 relation String 关系label名 weight Integer 具有该label的边的数量。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 元数据的id。 name String 元数据的名字。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 metadata_path 是 String 元数据存储地址。 name 是 String 元数据的名字。 description 否 String 对元数据的描述。

响应示例 状态码： 200 请求成功示例 { "id" : "d30d2e94-f2ee-4344-af49-eb27fd002eea", "name" : "test_schema" } 状态码： 400 请求失败示例 { "error_msg" : "test_schema The name already exists.", "error_code" : "GES.2067" }

请求示例 从OBS导入元数据，元数据存储地址为devdata/unionsdk/schema.xml，元数据的名字为test_schema。 POST https://{Endpoint}/v2/{project_id}/graphs/metadata/upload-from-obs { "metadata_path" : "devdata/unionsdk/schema.xml", "name" : "test_schema", "description" : "xx" }

响应示例 状态码： 200 成功响应示例 { "ges_metadata" : { "labels" : [ { "name" : "friends" }, { "name" : "movie", "properties" : [ { "data_type" : "string", "name" : "ChineseTitle", "cardinality" : "single" }, { "data_type" : "int", "name" : "Year", "cardinality" : "single" }, { "data_type" : "string", "name" : "Genres", "cardinality" : "set" } ] }, { "name" : "user", "properties" : [ { "data_type" : "string", "name" : "ChineseName", "cardinality" : "single" }, { "type_name1" : "F", "type_name2" : "M", "data_type" : "enum", "name" : "Gender", "type_name_count" : "2", "cardinality" : "single" }, { "type_name1" : "Under 18", "type_name2" : "18-24", "type_name3" : "25-34", "type_name4" : "35-44", "type_name5" : "45-49", "type_name6" : "50-55", "type_name7" : "56+", "data_type" : "enum", "name" : "Age", "type_name_count" : "7", "cardinality" : "single" }, { "data_type" : "string", "name" : "Occupation", "cardinality" : "single" }, { "data_type" : "char array", "name" : "Zip-code", "max_data_size" : "12", "cardinality" : "single" } ] }, { "name" : "rate", "properties" : [ { "data_type" : "int", "name" : "Score", "cardinality" : "single" }, { "data_type" : "date", "name" : "Datetime", "cardinality" : "single" } ] } ] } } 状态码： 400 失败响应示例 { "error_msg" : "6b74069d-3cf3-4cc0-9118-2478e23b87a does not exist.", "error_code" : "GES.2067" }

响应 要素说明 参数 是否必选 类型 说明 errorMessage 否 String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode 否 String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 result 否 String 成功时result值为success。 请求成功样例 Http Status Code: 200 { "result":"success", "data": { "edges": [ { "index": "7", "source": "46", "target": "39" }, { "index": "0", "source": "46", "target": "38" } ] } } 请求失败样例 Http Status Code: 400 { "errorMessage":"Edge source vertex [Lily] does not exist", "errorCode":"GES.8000" }

请求示例 POST http://{Endpoint}/v1.0/{project_id}/graphs/{graph_id}/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 }, "delimiter": ",", "trimQuote": "\"", "offline": true }

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

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

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 instance_name String 实例名称。 current_queries List 当前查询列表详情。 表3 CurrentQuery参数说明 参数 类型 说明 task_name String 任务名称。 request_id String 请求ID。 status String 请求执行状态。 request String 请求参数。 running_duration Double 请求执行时长，单位为秒。 begin_time String 请求开始时间。

响应示例 同步返回 状态码： 200 成功响应示例 Http Status Code: 200 { "data": { "edges": [ { "index": "1", "source": "tr_1", "label": "rate", "properties": { "Rating": [ 0 ], "Datetime": [ "" ] }, "target": "tr_3" }, ……, { "index": "199998", "source": "tr_1", "label": "rate", "properties": { "Rating": [ 0 ], "Datetime": [ "" ] }, "target": "tr_200000" } ] } } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph [tesdt_117] is not found", "errorCode": "GES.8806" }

响应参数 同步返回 表10 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 查询结果。查询失败时，字段为空。 表11 data参数说明 参数 类型 说明 vertices List 点的结果集合。filters最后一层为点过滤时，data中将包含vertices。 edges List 边的结果集合。filters最后一层为边过滤时，data中将包含edges。 paths List 路径信息集合。格式为[[path1],[path2]]，path的格式见表12。 表12 path参数说明 参数 类型 说明 source String 源点ID。 target String 终点ID。 index String 边index。 label String 边label。 异步返回 表13 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，该字段为空。 jobType Integer 任务类型。请求失败时，该字段为空。