华为云用户手册

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口，响应消息头中X-Subject-Token的值即为Token。 表4 请求Body参数 参数 是否必选 参数类型 描述 upgradeVersion 是 String 升级到的版本，必须大于当前图版本。 forceUpgrade 否 Boolean 是否强制升级。取值为true或false，默认为false。 true：强制升级，会中断升级时已经在处理的任务，比如运行算法长任务，可能会造成少量请求失败。 false：非强制升级，会等待已经运行的业务，升级过程可能较慢。

请求示例 根据批量节点ID删除节点，待删除的点ID数组为Vivian和46。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete { "vertices": [ "Vivian", "46" ], "ignoreError": true} SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求示例 批量更新点属性，待更新的点数组的点名称分别为150，6。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id=batch-update{ "vertices": [ { "vertex": "150", "label": "movie", "properties": { "movieid": [ "150" ], "title": [ "testmoive" ], "genres": [ "Comedy" ] } }, { "vertex": "6", "properties": { "title": [ "testmoive_exist_id" ], "genres": [ "Comedy" ] } } ], "ignoreError": true} SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": " Bad Request, parameter vertices cannot be null", "errorCode": "GES.8214"}

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 vertices 是 Json 待更新的点数组。数组参数详见vertices参数说明。 ignoreError 否 Boolean 是否忽略批量中部分点的更新错误。默认值为false。 当值为false：表示发现导致无法更新的错误，例如待更新的点不存在则报错，不更新任何点。 当值为true：表示忽略类似错误并更新其他无错误的点属性。 表3 vertices参数说明 参数 是否必选 类型 说明 vertex 是 String 点ID。 label 否 String 点的label。 properties 是 Json 待更新的各个属性的值。

node2vec算法（node2vec）(1.0.5) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 P 否 回退参数。 Double 大于0 1 Q 否 前进参数。 Double 大于0 1 dim 否 映射维度。 Integer 1~200，包括1和200。 50 walkLength 否 随机步长。 Integer 建议取1~100，包括1和100。 40 walkNumber 否 每个节点的随机步长数。 Integer 建议取1~100，包括1和100。 10 iterations 否 迭代次数。 Integer 1~100，包括1和100。 10 表2 response_data参数说明 参数 类型 说明 embedding List 各点映射到欧式空间的向量表示，格式： [{vertexId:vectorValue}] 其中， vertexId: string类型 vectorValue：欧式向量，例如[-0.485,-0.679,0.356] 父主题： 算法API参数参考

URI POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id={actionId} 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 actionId 是 String 操作符。 batch-update 更新该属性的值。 batch-add 添加属性的值。当属性的cardinality为single时，其操作与update一致；当cardinality为list或set时，意为向集合中添加值。 batch-del 删除属性的值。

请求示例 根据批量边的起点、终点以及索引来查询这些边的详细信息，待查询边的source节点分别为39631050_景观，27803870_地标建筑。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query { "edges": [{ "source": "39631050_景观", "target": "27803870_地标建筑" },{ "index": "0", "source": "27803870_地标建筑", "target": "27661363_北京九华山庄温泉" }]}

响应参数 表4 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data String 查询成功时包含data字段，data字段中包含edges查询结果。 result String 查询成功时值为success,失败时值为failed。

响应示例 状态码： 200 成功响应示例 { "data": { "edges": [ { "index": "24", "source": "39631050_景观", "label": "superclassOf", "properties": { "popularity": [ 0 ] }, "target": "27803870_地标建筑" }, { "index": "0", "source": "27803870_地标建筑", "label": "superclassOf", "properties": { "popularity": [ 0 ] }, "target": "27661363_北京九华山庄温泉" } ] }}

请求消息头 附加请求消息头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求消息头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 表1 公共请求消息头 参数名 是否必选 说明 示例 Content-Type 是 消息体的类型（格式），默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 application/json X-Auth-Token 是 用户Token。例如， IAM 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 - X-Language 是 请求语言。支持配置如下值： zh-cn：中文 en-us：英文 en-us

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 例如，对于IAM获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称。例如cn-north-1，可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见IAM获取用户Token。 POST https: //iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } }} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于IAM获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 图引擎服务业务面API请求URI由如下部分组成。 {URI-scheme} :// {SERVER_URL} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独拿出来强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 SERVER_URL：图的访问地址，取值请参考业务面API使用限制。 resource-path：资源路径，即API访问路径。从具体API的URI模块获取，例如“ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

响应示例 状态码： 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."}

业务面API使用限制 用户访问业务面API有三种方式： 通过E CS 访问，且创建ECS的VPC和创建图选定的VPC是同一个。如果安全组选择的是同一个，则可以直接访问；如果安全组不是同一个，要在创建图的安全组开通该ECS的访问限制，即入方向放开80和443端口，出方向放开所有端口（分别对应支持HTTP和HTTPS访问）。这种场景，API的SERVER_URL为GES Console图详情的内网访问地址或者管理面API查询图详情返回体的"privateIp"字段的值。 通过ECS访问，但创建ECS的VPC和创建图选定的VPC不是同一个。需要对ECS所在的VPC和建图用的VPC创建VPC对等连接，创建VPC对等连接请参考创建对等连接。同时要在创建图的安全组开通该ECS的访问限制，即入方向放开80和443端口，出方向放开所有端口。这种场景，API的SERVER_URL为GES Console图详情的内网访问地址或者管理面API查询图详情返回体的"privateIp"字段的值。 通过公网访问。此时要求创建弹性公网IP（EIP），且要在创建图的安全组开通客户端的访问限制，即入方向放开80和443端口，出方向放开所有端口。这种场景，API的SERVER_URL为GES Console图详情的公网访问地址或者管理面API查询图详情返回体的"publicIp"字段的值，也即用户绑定或者自动创建的弹性公网IP地址。 父主题： 约束与限制

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

支持的授权项 策略支持的操作与API相对应，授权项列表说明如下： 权限：自定义策略中授权项定义的内容即为权限。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 AM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。 GES支持自定义策略授权项如下表所示。 表1 API授权项列表 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询图列表 GET /v1.0/{project_id}/graphs?offset={offset}&limit={limit} ges:graph:list 项目级服务VPC vpc:publicIps:get √ √ 查看图详情 GET /v1.0/{project_id}/graphs/{graph_id} ges:graph:getDetail - √ √ 创建图 POST /v1.0/{project_id}/graphs ges:graph:create 项目级服务ECS ecs:cloudServerFlavors:get ecs:cloudServerNics:update 项目级服务EVS evs:types:get 项目级服务VPC vpc:ports:create vpc:ports:update vpc:securityGroups:get vpc:publicIps:list vpc:ports:get vpc:subnets:get vpc:vpcs:list √ √ 关闭图 POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=stop ges:graph:operate - √ √ 启动图 POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=start ges:graph:operate - √ √ 删除图 DELETE /v1.0/{project_id}/graphs/{graph_id} ges:graph:delete 项目级服务VPC vpc:publicIps:get vpc:ports:delete vpc:ports:get √ √ 增量导入图 POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=import-graph ges:graph:operate - √ √ 导出图 POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=export-graph ges:graph:operate - √ √ 清空图 POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=clear-graph ges:graph:operate - √ √ 升级图 POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=upgrade ges:graph:operate - √ √ 重启图 POST /v1.0/{project_id}/graphs/{graph_id}/action ges:graph:operate - √ √ 变更图规格 POST /v1.0/{project_id}/graphs/{graph_id}/resize ges:graph:resize - √ √ 扩副本 POST /v1.0/{project_id}/graphs/{graph_id}/expand ges:graph:expand 项目级服务ECS ecs:cloudServerFlavors:get ecs:cloudServerNics:update 项目级服务EVS evs:types:get 项目级服务VPC vpc:ports:create vpc:ports:update vpc:securityGroups:get vpc:publicIps:list vpc:ports:get vpc:subnets:get vpc:vpcs:list √ √ 绑定EIP POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=bindEip ges:graph:operate - √ √ 解绑EIP POST /v1.0/{project_id}/graphs/{graph_id}/action?action_id=unbindEip ges:graph:operate - √ √ 查看所有备份列表 GET /v1.0/{project_id}/graphs/backups?offset={offset}&limit={limit} ges:backup:list - √ √ 查看某个图的备份列表 GET /v1.0/{project_id}/graphs/{graph_id}/backups?offset={offset}&limit={limit} ges:backup:list - √ √ 新增备份 POST /v1.0/{project_id}/graphs/{graph_id}/backups ges:backup:create - √ √ 删除备份 DELETE /v1.0/{project_id}/graphs/{graph_id}/backups/{backup_id} ges:backup:delete - √ √ 查询元数据列表 GET /v1.0/{project_id}/graphs/metadatas?offset={offset}&limit={limit} ges:metadata:list - √ √ 查询元数据 GET /v1.0/{project_id}/graphs/metadatas/{metadata_id} ges:metadata:list - √ √ 校验元数据 POST /v1.0/{project_id}/graphs/action?action_id=check-schema ges:metadata:operate - √ √ 新增元数据 POST /v1.0/{project_id}/graphs/metadatas ges:metadata:create - √ √ 删除元数据 DELETE /v1.0/{project_id}/graphs/metadatas/{metadata_id} ges:metadata:delete - √ √ 查询任务状态 GET /v1.0/{project_id}/graphs/{graph_id}/jobs/{job_id}/status ges:jobs:getDetail - √ √ 查询任务列表 GET /v1.0/{project_id}/graphs/jobs?offset={offset}&limit={limit} ges:jobs:list - √ √

pagerank算法(1.0.0) 表1 parameters参数说明 参数 是否必选 类型 说明 alpha 否 Double 权重系数(又称阻尼系数)，取值范围为（0,1），默认值为0.85。 convergence 否 Double 收敛精度。取值范围(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。 迭代次数（iterations）和收敛精度（convergence）。 算法终止的条件：要么达到设置的最大迭代次数，要么满足收敛精度，满足其一即可。 一般来说，收敛精度设置得越小，迭代次数设置得越大，算法的效果越好。 在固定收敛精度的情况下，要想算法优先满足收敛精度，迭代次数设置得尽量大。 迭代次数越大，算法运行时间越长。在固定迭代次数（即固定运行时间）的情况下，要想算法运行到设置的迭代次数，收敛精度设置得尽量小。 表2 response_data参数说明 参数 类型 说明 pagerank List 各节点的pagerank值，格式： [{vertexId:rankValue},...] 其中, vertexId：string类型 rankValue：double类型 父主题： 算法API参数参考

业务面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查看错误信息联系技术支持人员。 父主题： 错误码

响应示例 状态码： 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"}

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

请求示例 删除满足过滤条件的点集合（仅支持异步模式），点类型过滤条件分别为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"]}] }

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{"jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232","jobType": 3} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "graph [demo] is not found", "errorCode": "GES.8003"}

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 查询结果。请求失败时字段为空。 表3 data参数说明 参数 类型 说明 outputs Integer 删除label时，被删除的相关点/边数量。

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

请求参数 表1 Body参数说明 参数 是否必选 类型 说明 exportPath 是 String 导出路径。 fileName 否 String 导出文件名。 obsParameters 是 String OBS认证参数。请参见表 obsParameters参数说明。 labels labels和edgeFilters两者必选其一 String 关系类型过滤条件。 edgeFilters labels和edgeFilters两者必选其一 String 过滤条件，按属性过滤，JsonArray格式字符串。请参见表 edgeFilters参数结构。

响应示例 同步返回 状态码： 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 路径信息集合。with_path为true时可输出。格式见表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 任务类型。请求失败时，该字段为空。

请求示例 （同步模式）列出满足过滤条件的第k跳节点或边，执行模式是同步，不进行可视化即查询job结果分页返回。 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=filtered-query{ "executionMode": "sync", "visulized": "false", "filters": [ { "operator": "outV" }, { "operator": "out", "edge_filter": { "property_filter": { "leftvalue": { "label_name": "labelName" }, "predicate": "=", "rightvalue": { "value": "rate" } } } } ], "full_path": false, "vertices": [ "tr_10" ]} （异步模式）列出满足过滤条件的第k跳节点或边，执行模式是异步，不进行可视化即查询job结果分页返回。 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=filtered-query{ "executionMode": "async", "visulized": "false", "filters": [ { "operator": "outV" }, { "operator": "out", "edge_filter": { "property_filter": { "leftvalue": { "label_name": "labelName" }, "predicate": "=", "rightvalue": { "value": "rate" } } } } ], "full_path": false, "vertices": [ "tr_10" ]} 嵌套property_filter，列出满足过滤条件的第k跳节点或边，执行模式是同步，不进行可视化即查询job结果分页返回。 { "executionMode": "sync", "filters": [ { "operator": "outV", "vertex_filter": { "property_filter": { "leftvalue": { "property_filter": { "leftvalue": { "property_name": "genres" }, "predicate": "PREFIX", "rightvalue": { "value": "A|" } } }, "predicate": "&", "rightvalue": { "property_filter": { "leftvalue": { "label_name": "labelName" }, "predicate": "=", "rightvalue": { "value": "movie" } } } } } } ], "vertices": [ "tr_3" ]}

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参数参考