华为云用户手册

业务面API错误码 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。当调用出错时，HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时，可以联系技术人员，并提供错误码，以便我们尽快帮您解决问题。 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 GES.8000 Incorrect parameter format. 参数格式错误 检查请求url、body体是否和文档描述一致。 400 GES.8001 Failed to query graph statistics. 图统计信息查询失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8002 Graph statistics query error. 图统计信息查询错误 检查token是否过期，重新获取token。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8005 Incorrect parameter. 参数错误 检查URL中的project_id是否正确。 检查请求头是否正确，比如X-Auth-Token是否正确。 400 GES.8006 Invalid resource access. 资源访问不合法 1.AK/SK鉴权方式：需要检查regioncode或者regionname是否正确。 2.Token鉴权方式：需要检查token对应的project是否正确。 400 GES.8007 Invalid token. Token不合法 检查Token是否正确。 400 GES.8008 An error occurs in the underlying authentication system. 底层认证系统出错 请稍后重试或联系技术支持人员。 400 GES.8011 Failed to export a graph. 导出图失败 检查图名是否正确。 查看导出文件路径是否正确。 检查该账号有无OBS写入权限。 400 GES.8012 Failed to clear a graph. 清空图失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8013 Failed to incrementally import data to the graph. 增量导入图失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8020 The current user does not have permission. （细粒度授权时）当前用户没权限 使用具有Security Administrator权限的用户进行授权。 400 GES.8101 Invalid filter criteria for edge queries. 边过滤查询条件不合法 检查边过滤条件格式是否正确。 400 GES.8102 Invalid label for edge filtering queries. 边过滤查询Label不合法 检查labels是不是正常的josn体。 400 GES.8103 Both the condition and label of edge filtering queries are empty. 边过滤查询条件和Label同时为空 边过滤查询条件和Label不能同时为空。 400 GES.8104 Invalid edge filtering query sequence. 边过滤排序输入不合法 检查边过滤排序输入是否合法。 400 GES.8105 Failed to query edges that meet filter criteria. 边过滤查询执行失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8106 The source vertex or target vertex in the edge details is empty. 边详情起点或终点为空 边详情起点和终点不能为空。 400 GES.8107 Failed to query edge details. 边详情查询失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8108 Edge details query error. 边详情查询内部错误 请稍后重试或联系技术人员。 400 GES.8109 Invalid edge filtering query operator. 边过滤查询算子不合法 边过滤查询算子取值为 in、out、both、edge。 400 GES.8110 Parameter edges cannot be left blank. 参数edges不能为空 批量边查询请求体中edges是否为空。 400 GES.8201 Invalid label for vertex filtering queries. 点过滤查询Label不合法 检查labels是不是正常的josn体。 400 GES.8202 Invalid filter criteria for vertex queries. 点过滤查询条件不合法 检查点过滤查询API中propertyName（属性名称）是否为空。 检查点过滤查询API中values（属性值）是否为空。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8203 Both the condition and label of vertex filtering queries are empty. 点过滤查询条件和Label同时为空 点过滤条件和Label不能同时为空。 400 GES.8204 Failed to query vertices that meet filter criteria. 点过滤查询执行失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8205 Invalid vertex filtering query sequence. 点过滤排序输入不合法 点过滤查询API中orderValue必须在“incr”和“decr”。 400 GES.8206 Both vertexid and vertextids exist. vertexid和vertextids同时存在 vertexid和vertextids不能同时存在。 400 GES.8207 Both vertexid and vertextids are empty. vertexid和vertextids同时为空 vertexid或vertextids为空。 400 GES.8208 Incorrect vertextids format. vertextids格式错误 vertextids是否 json array。 400 GES.8209 Failed to query vertex details. 点详情查询失败 检查图名是否存在。 500 GES.8210 Vertex details query error. 点详情查询内部错误 请稍后重试或联系技术支持人员。 400 GES.8211 Invalid vertex filtering query operator. 点过滤查询算子不合法 点过滤查询算子取值为 inV、outV、bothV、vertex。 400 GES.8212 Failed to delete the vertex label. 删除点Label失败 Label是否存在。 400 GES.8213 Failed to add the vertex label. 增加点Label失败 Label是否存在。 400 GES.8214 Parameter vertices cannot be left blank. 参数vertices不能空 批量点查询请求体中vertices是否为空。 400 GES.8220 Failed to update the vertex properties. 更新点属性失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8221 Failed to update the edge properties. 更新边属性失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8301 Failed to query a job. 作业查询失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8302 Job query error. 作业查询内部错误 请稍后重试或联系技术支持人员。 400 GES.8303 Failed to terminate a job. 作业终止失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8304 Job termination error. 作业终止内部错误 请稍后重试或联系技术支持人员。 400 GES.8401 The algorithm or graph name cannot be empty. 算法名或者图名不能为空 算法名或者图名不能为空。 400 GES.8402 Failed to run the algorithm. 算法执行失败 网络波动问题建议重试下。 检查执行算法API图名是否填写正确。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8403 Algorithm running error. 算法执行内部错误 请稍后重试或联系技术支持人员。 400 GES.8404 Invalid algorithm running format. 算法执行模式不合法 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8501 The Gremlin command is not supported. Gremlin查询命令不支持 不支持Gremlin的tryNext、explain、tree语句。 400 GES.8502 Failed to find the Gremlin configuration file. Gremlin配置文件找不到 请稍后重试或联系技术支持人员。 400 GES.8503 Gremlin query failed. Gremlin查询执行失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8504 Gremlin query error. Gremlin查询内部错误 请稍后重试或联系技术支持人员。 400 GES.8505 The Gremlin query statement does not contain the command field. Gremlin查询语句没有command字段 Gremlin查询语句没有command字段。 400 GES.8506 The size of the Gremlin query request statements exceeds the upper limit. Gremlin查询请求语句超过限制 当前限制为64MB。 500 GES.8601 Gremlin service unavailable. Gremlin服务不可用 请稍后重试或联系技术支持人员。 500 GES.8602 Engine service unavailable. Engine服务不可用 请稍后重试或联系技术支持人员。 400 GES.8603 Failed to create an index 索引创建失败 检查索引名称是否只包含字母,数字,-和_。 检查索引参数类型是否符合GES API规定的格式。 400 GES.8604 Failed to delete an index 索引删除失败 检查图名是否填写正确。 检查索引名称是否填写正确。 检查请求Method type是否为delete。 400 GES.8605 Failed to query an index 索引查询失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8609 The request body for querying path details is invalid. 查询路径详情请求体不合法 检查图名是否填写正确。 检查查询路径详情API参数格式是否填写正确。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8610 The path parameter of the request body for querying path details is invalid. 查询路径详情请求体path参数不合法 检查查询路径详情API参数格式是否填写正确。 检查查询路径详情API必选参数是否缺失。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8611 Failed to query path details. 查询路径详情失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8612 The operation of querying path details is not supported. 查询路径详情操作不支持 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8801 Failed to add a label to metadata. 元数据添加label失败 检查要添加的label是否已经存在。 检查添加labelAPI参数格式是否正确。 检查添加labelAPI必选参数是否都有值。 400 GES.8803 Failed to query the metadata. 元数据查询失败 检查要查询的图是否存在。 检查查询图元数据详情API的graph_name是否填写正确。 500 GES.8804 Metadata query error. 元数据查询内部错误 请稍后重试或联系技术支持人员。 400 GES.8806 K-Hop query with filter criteria failed. 带过滤的khop查询执行失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 父主题： 错误码

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

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "jobId": "03e774f5-29ea-4187-9508-5435f3892ead016886200", "jobType": 1} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "Bad Request, parameter labels and vertexFilters cannot all be null", "errorCode": "GES.8203"}

请求示例 删除满足过滤条件的点集合（仅支持异步模式），点类型过滤条件分别为movies和user，属性名称为Age。 POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=delete {"labels": ["movies","user"],"vertexFilters": [{"propertyName": "Age","predicate": "=","values": ["18-24"]}] }

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 - - OD_pairs和seeds参数二选一，当OD_pairs和seeds同时输入时，以OD_pair为准，忽略seeds。 表2 response_data参数说明 参数 类型 说明 betweenness List 各边的betweenness值，格式： [{“source”: sourceId, “target”: targetId , “index”: indexValue , “betweenness”: betweennessValue },...]，其中： betweennessValue：double类型 父主题： 算法API参数参考

Cypher预置条件 当前的Cypher查询编译过程中使用了基于label的点边索引，如需正常使用Cypher，请使用新建索引API构建索引，示例如下： 点label索引添加命令示例，索引名称为cypher_vertex_index，索引类型为全局点索引。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices{ "indexName": "cypher_vertex_index", "indexType": "GlobalCompositeVertexIndex", "hasLabel": "true", "indexProperty": []} 边label索引添加命令示例，索引名称为cypher_edge_index，索引类型为全局边索引。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices{ "indexName": "cypher_edge_index", "indexType": "GlobalCompositeEdgeIndex", "hasLabel": "true", "indexProperty": []} 图规格为一亿边、十亿边、百亿边规格时，不需要进行此步骤（图版本要求2.3.6及以上）。 需要同时添加两个索引（点label索引和边label索引）才能正常使用Cypher查询。 如果图中已经存在hasLabel为true, indexProperty为空的点索引或边索引，则不需要重复构建。 添加索引API为异步接口，查询索引是否添加成功，请使用查询Job状态API。 细粒度权限开启时使用子账号创建索引，需要子账号具有schema权限、所有label（包括默认label“__DEFAULT__”）的读权限。否则创建索引后需要使用具备相应权限的账号发送“call db.schema()”对Cypher查询编译缓存进行刷新。 父主题： Cypher操作API（2.2.16）

连通分量（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参数参考

任务类型和任务名称对应表 表3 任务类型和任务名称对应表 任务类型 任务名称 100 点查询 101 创建点 102 删除点 103 修改点属性 104 添加点Label 105 删除点Label 200 边查询 201 创建边 202 删除边 203 修改边属性 300 查询Schema详情 301 添加Label 302 修改Label 303 查询Label 304 修改属性 400 查询图详情 401 清空图 402 在线增量导入图 403 创建图 405 删除图 406 导出图 407 filtered_khop 408 查询路径详情 409 离线增量导入图 500 创建备份 501 从备份恢复图 601 创建索引 602 查询索引 603 更新索引 604 删除索引 700 运行算法 800 查询异步任务

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

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

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

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 各节点对应的社团(community)，格式： [{vertexId:communityId},...] 其中, vertexId: string类型 communityId: string类型 父主题： 算法API

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "data": { "vertices": [ { "id": "27003509_北京中央电视台大楼", "label": "tag", "properties": { "popularity": [ 0 ], "name": [ "北京中央电视台大楼" ], "alias": [ "中央电视台光华路办公区", "中央电视台总部大楼", "大裤衩", "央视总部大楼" ] } }, { "id": "39636392_八达岭长城", "label": "tag", "properties": { "popularity": [ 0 ], "name": [ "八达岭长城" ], "alias": [ "长城" ] } } ] }, "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": " Bad Request, parameter vertices cannot be null", "errorCode": "GES.8214"}

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

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

请求示例 进行导入图操作，边文件目录为testbucket/demo_movie/edges/，边数据集格式为csv，点文件目录为testbucket/demo_movie/vertices/，点数据集格式为csv，新增数据的元数据文件OBS路径为testbucket/demo_movie/schema.xml，日志存放目录为testbucket/importlogdir。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/import-graph{ "edgesetPath": "testbucket/demo_movie/edges/", "vertexsetPath": "testbucket/demo_movie/vertices/", "schemaPath": "testbucket/demo_movie/schema.xml", "logDir": "testbucket/importlogdir", "delimiter": ",", "trimQuote": "\"", "obsParameters": { "accessKey": "xxxxxx", "secretKey": "xxxxxx" }, "vertex": [ { "property": [ "title", "movieid" ], "label": "movie" } ], "edge": [ { "property": [ "Rating", "Datetime" ], "label": "rate" } ]} SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 edgesetPath 是 String 边文件目录或边文件名，支持csv、txt格式文件导入。 vertexsetPath 是 String 点文件目录或点文件名，支持csv、txt格式文件导入。 schemaPath 是 String 新增数据的元数据文件OBS路径。 logDir 否 String 导入图日志存放目录，用于存储导入失败的数据和详细错误原因。 delimiter 否 Character csv格式文件字段分隔符，默认值为逗号（,）。 trimQuote 否 Character csv格式文件字段包围符，默认值为双引号（"）。用来包围一个字段，如字段中含有分隔符或者换行等。 obsParameters 是 Object Obs相关参数。参数详见obsParameters参数说明。 vertex 否 Object 点属性列表，指定的属性需属于schema文件中的属性，如果列表为空，则不会导入点属性。参数详见vertex、edge参数说明。 edge 否 Object 边属性列表，指定的属性需属于schema文件中的属性，如果列表为空，则不会导入边属性。参数详见vertex、edge参数说明。 表3 obsParameters参数说明 参数 是否必选 类型 说明 accessKey 是 String 用户的accessKey。 secretKey 是 String 用户的secretKey。 表4 vertex、edge参数说明 参数 是否必选 类型 说明 label 是 String label名称。 property 是 Array of strings 属性名称，属性要隶属于该标签。支持的属性类型包括：string、bool、int、long、double、float。

最短路径（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

共同邻居（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参数参考

三角计数（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参数参考

请求示例 进行添加点操作，点名称为Lily，点的标签为user。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices{ "vertex":"Lily", "label":"user", "properties":{ "Age":[ "under 18" ], "Gender":[ "F" ], "Occupation":[ "aritist" ], "Zip-code":[ "98133" ] }} SERVER_URL：图的访问地址，取值请参考业务面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参数参考

请求示例 更新label，label的名称为book。 POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName}{ "type": "vertex", "properties": [ { "property": { "name": "Title", "cardinality": "single", "dataType": "string" } }, { "property": { "name": "Version", "cardinality": "single", "dataType": "string" } } ]} SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "result": "success"} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "label : undefinedLabel not exist", "errorCode": "GES.8703", "result": "failed"}

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "data": { "schema": [ { "label": "__DEFAULT__", "type": "all" }, { "label": "friends", "type": "vertex" }, { "label": "movie", "type": "vertex", "properties": [ { "name": "ChineseTitle", "type": "string", "cardinality": "single" }, { "name": "Year", "type": "int", "cardinality": "single" } ] }, { "label": "user", "type": "vertex", "properties": [ { "name": "Name", "type": "string", "cardinality": "single" },{ "name": "Occupation", "type": "string", "cardinality": "single" }, { "name": "Zip-code", "type": "string", "cardinality": "single" } ] }, { "label": "rate", "type": "edge", "properties": [ { "name": "Score", "type": "int", "cardinality": "single" }, { "name": "Datetime", "type": "date", "cardinality": "single" } ] } ] }} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "graph [demo] is not found", "errorCode": "GES.8003"}

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{"jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorCode": "GES.8818", "errorMessage": "Data assets information is being generated"}

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 result String 创建事务结果。成功时值为success，失败时值为failed。 commit String 创建的事务ID。

操作步骤 创建HyG图。 发送“POST /ges/v1.0/{project_id}/hyg/{graph_name}”，project_id为项目ID，graph_name为图数据库中已创建的图名。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下： { "inEdge": true //图是否包含入边} 查看请求响应结果。请求成功时，响应参数如下： { "result": "success"} 请求异常时，错误码请参见错误码。 HyG图数据同步，将图数据库的数据同步到HyG计算引擎。 发送“POST /ges/v1.0/{project_id}/hyg/{graph_name}/sync”，project_id为项目ID，graph_name为图名。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下： { "vertex": [], //点属性列表 "edge": [ { "property": [ "Rating" ], "label": "rate" } ] //边属性列表} 根据JobId查看请求响应结果。请求成功时，响应参数如下： { "status": "complete", "result": "success"} 请求异常时，错误码请参见错误码。 如果对图数据库执行了增、删、改操作，使用该接口可以将图数据库的修改信息同步到HyG计算引擎。首次执行数据同步时，请求body里面的vertex和edge参数生效，后续执行数据同步，该参数默认跟首次指定的保持一致。 查询HyG图详情。 发送“GET /ges/v1.0/{project_id}/hyg/{graph_name}/summary”，project_id为项目ID，graph_name为图名。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。请求成功时，响应参数如下： { "data": { "inEdge": true, "idIndex": true, "policy": "oec", "updateTime": "2024-01-25 10:55:31", "vertex": [], "edge": [ { "label": "rate", "property": [ "Rating" ] } ], "vertexNum": 146, "edgeNum": 1659 }, "result": "success"} 请求异常时，错误码请参见错误码。 执行算法 发送“POST /ges/v1.0/{project_id}/hyg/{graph_name}/algorithm”，project_id为项目ID，graph_name为图名。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下（以pagerank为例）。 {"algorithmName":"pagerank", "parameters":{ "alpha":0.85, "convergence":0.00001, "max_iterations":1000, "directed":true }} 根据JobId查看请求响应结果。请求成功时，响应参数如下： { "status": "complete", "data": { "outputs": { "data_offset": 0, "data_return_size": 147, "data_total_size": 147, "pagerank": [ { "38": 0.02115960730038959 }, { "13": 0.018535705068819635 }, { "7": 0.0166381431701182 }, … … ], "runtime": 0.022 } }, "result": "success"} 请求异常时，错误码请参见错误码。 删除HyG图。 发送“DELETE /ges/v1.0/{project_id}/hyg/{graph_name}”，project_id为项目ID，graph_name为图名。 在Request Header中增加“X-Auth-Token”。 根据jobId查看请求响应结果。请求成功时，响应参数如下： { "status": "complete", "result": "success"} 请求异常时，错误码请参见错误码。

响应参数 表2 响应Body参数说明 参数 类型 说明 generating Boolean 是否正在生成数据资产。 progress String 正在生成数据资产时的生成进度。 last_generate_time String 上一次生成数据资产的时间。 data_assets Object 包含不同标签下点和边的个数。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 表3 data_assets参数说明 参数 类型 说明 vertex Object 包含不同标签下点的个数。 edge Object 包含不同标签下边的个数。

响应示例 状态码： 200 成功响应示例，有以下几种情况： 从未生成过。 Http Status Code: 200{ } 从未生成过，并正在生成。 Http Status Code: 200{ "progress":"10.05%", "generating": true} 生成过，并正在生成最新的。 Http Status Code: 200{ "last_generate_time": "2022-1-3 12:34:12", "data_assets": { "vertex": { "label1": 3, "label2": 14 }, "edge": { "label3":123, "label4":435 } }, "progress":"10.05%", "generating": true} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorCode": "GES.8818", "errorMessage": "graph [demo] is not found"}