图引擎服务 GES-华为云

图引擎服务 GES-添加label(1.1.6):请求示例

请求示例添加label，label的名称为book，label一共有三个待添加的属性。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels { "name": "book", "type": "vertex", "properties": [ { "property": { "name": "Title", "cardinality": "single", "dataType": "string" } }, { "property": { "name": "Version", "cardinality": "single", "dataType": "string" } }, { "property": { "name": "Category", "typeName1": "science", "typeName2": "literature", "typeNameCount": "2", "cardinality": "single", "dataType": "enum" } } ] } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

图引擎服务 GES

图引擎服务 GES-批量添加label(2.2.21):响应参数

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

图引擎服务 GES

图引擎服务 GES-批量添加label(2.2.21):请求示例

请求示例批量添加元数据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", "type": "vertex", "properties": [ { "property": { "name": "title", "cardinality": "single", "dataType": "string" } } ] }, { "name": "movie", "type": "vertex", "properties": [ { "property": { "name": "movieid", "cardinality": "single", "dataType": "int" } } ] } ] } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

图引擎服务 GES

图引擎服务 GES-执行DSL算法:响应示例

响应示例状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "6-57222f3d-f6b8-41ba-b492-60ed9b879223" } 状态码： 400 失败响应示例 HttpStatusCode: 400 { "errorCode": "GES.8011", "errorMessage": "graph : movie2 is not exist" }

图引擎服务 GES HyG算法API

图引擎服务 GES-执行DSL算法:请求参数

请求参数表2 Body参数说明参数是否必选类型说明 scriptPath 是 String 用户编写好的DSL算法文件路径。 obsParameters 是 Object OBS认证参数。具体请见obsParameters参数说明。 timeout 否 Integer 超时时间，单位为秒。表3 obsParameters参数说明参数是否必选类型说明 accessKey 是 string ak值。 secretKey 是 string sk值。

图引擎服务 GES HyG算法API

图引擎服务 GES-执行DSL算法:请求示例

请求示例请求示例1：取消已经提交的某个作业。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/dsl { "scriptPath": "bucket/run_sssp.py", "obsParameters": { "accessKey": "XXX", "secretKey": "XXX" } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

图引擎服务 GES HyG算法API

图引擎服务 GES-添加label:响应参数

响应参数表5 要素说明参数类型说明 errorMessage String 系统提示信息。执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息。执行成功时，字段可能为空。执行失败时，用于显示错误码。 result String 响应结果。成功时result值为success，失败时值为failed。 cause String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。

图引擎服务 GES 元数据操作API

图引擎服务 GES-添加label:请求示例

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

图引擎服务 GES 元数据操作API

图引擎服务 GES-personalrank算法(1.0.0)

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。关于迭代次数（iterations）和收敛精度（convergence）参数如何调节，请参考迭代次数和收敛精度的关系。表2 response_data参数说明参数类型说明 source String - personalrank List 各节点的personalrank值，格式： [{vertexId:rankValue},...] 其中, vertexId：string类型 rankValue：double类型父主题：算法API参数参考

图引擎服务 GES

图引擎服务 GES-标签传播（label_propagation）(2.1.8)

标签传播（label_propagation）(2.1.8) 表1 parameters参数说明参数是否必选说明类型取值范围默认值 convergence 否收敛精度。 Double 0~1，不包括0和1。 0.00001 max_iterations 否最大迭代次数。 Integer 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为1000。 1000 initial 否点上用作初始化标签的属性名称 String 空或字符串。空：每个节点各自分配一个特有的初始化标签；适用于事先没有任何节点标注信息的情况。字符串：将节点的对应的属性字段取值作为初始化标签（类型为string，对于未知标签的点，初始化标签字段赋空）；适用于已标注部分节点标签，预测未知节点标签的情况。说明：当initial取值为“字符串”时，其中具有初始化标签的点的数量应大于0，小于点总数。 - 关于迭代次数（iterations）和收敛精度（convergence）参数如何调节，请参考迭代次数和收敛精度的关系。表2 reponse_data参数说明参数类型说明 community List 各节点对应的社团(community)，格式： [{vertexId:communityId},...] 其中, vertexId: string类型 communityId: string类型父主题：算法API参数参考

图引擎服务 GES

图引擎服务 GES-算法公共参数:请求参数

请求参数表1 请求Body参数说明参数是否必选类型说明 algorithmName 是 String 算法名字，详见具体的各个算法。 parameters 否 Object 算法参数。详情请参考各算法参数描述。 output 否 Object 结果输出参数。具体请见表2。 timeout 否 Integer 超时时间，单位为秒。说明：最大团（max_clique）、mccis算法不支持该参数。表2 output参数说明参数是否必选类型说明 format 否 String 算法结果的输出格式。可选值是["JSON", "TXT"]，默认值是"JSON"。TXT格式请参考算法结果TXT格式说明。 mode 否 String 算法结果的输出模式。可选值是["FULL", "TRUNCATED"]。默认值是"TRUNCATED"。 "FULL"表示算法结果全量输出。"FULL"模式下，当前只支持"TXT"这个格式，且算法结果会写到集群节点的本地目录，需要通过"export-result"接口将全量结果写到obs才能访问。 "TRUNCATED"表示算法结果截断输出，当前只支持"JSON"这种格式。对于存在默认值的参数，如果传参数值为null，按默认值处理。

图引擎服务 GES 算法API参数参考

图引擎服务 GES-算法公共参数:响应示例

响应示例根据输入参数，执行指定算法，查询算法结果（根据算法请求返回的job_id，调用查询job_id接口获取算法结果）。状态码： 200 成功响应示例 { "data": { "outputs": { $response_data //各算法的具体返回结果，不同算法返回结果不同 "runtime": 1.365867, "data_return_size": 3, "data_offset": 0, "data_total_size": 100 } }, "status": "complete" } response_data 表示各算法的具体返回结果，不同算法返回结果不同。状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"Running algorithm [XXXX] error: YYYYYYYYY!", "errorCode":"GES.8301" }

图引擎服务 GES 算法API参数参考

图引擎服务 GES-新建索引:请求参数

请求参数表2 Body参数说明参数是否必选类型说明 indexName 是 String 索引名称。只能包含字母,数字,-和_。不能包含其他字符。索引名称的长度需在63字符以内。 indexType 是 String 索引的类型，区分大小写。 “GlobalCompositeVertexIndex”为全局的Composite类型的点索引。 “GlobalCompositeEdgeIndex”为全局的Composite类型的边索引。 “CompositeVertexIndex”为局部的Composite类型的点索引。 “CompositeEdgeIndex”为局部的Composite类型的边索引。 “FullTextIndex”为全文索引。 hasLabel 否 Boolean 是否有label，默认为false。 true false indexLabel 否 List Label列表，仅在indexType为CompositeVertexIndex或CompositeEdgeIndex时有效，而且为必填项，用来指定在哪些label上建立索引。 indexProperty 否（若hasLabel为false或null，则该项为必选） List 索引的属性列表。可以创建索引的属性类型有： integer、 float、 double、 long、 enum、 string、 date。 strLength 否 Integer String类型的属性在编码索引时会按照一固定长度来截断，strLength用于指定此截断长度。未指定时默认值为40字节，用户可指定范围为[1, 256]。通常用户不需要手动指定此参数，即使有些属性超过此长度，索引编码时被截断。一般也不会有明显的性能劣化。除非绝大多数属性均超过默认长度，可以考虑适当增大strLength，但是会带来索引修改的性能下降。如果属性类型为string，属性长度建议不要超过40个字节，超出的部分会被截断。 Cypher查询可以借助hasLabel为True的索引来加速。 indexProperty为空时，建立的索引为label索引，可以加速label过滤。 indexProperty不为空时，建立的索引为属性索引，可以加速对应的属性过滤。

图引擎服务 GES 索引操作API

图引擎服务 GES-新建索引:功能介绍

功能介绍根据给定的indexName，IndexType等信息创建索引。目前支持两种索引：复合索引和全文索引。复合索引有全局点索引（GlobalCompositeVertexIndex），全局边索引（GlobalCompositeEdgeIndex）以及局部点索引（CompositeVertexIndex），和局部边索引（CompositeEdgeIndex）。复合索引是针对固定组合的属性建立的，其中局部索引可以在指定的label上建立索引。而全局索引复合索引不需要指定label，只要某个label包含指定属性，就会自动在此label上建立索引。使用索引查询可以加快速度。全文索引（FullTextIndex）可以实现全文搜索、模糊搜索等功能。由于全文索引的刷新机制，更新数据后立即查询可能查到的是旧数据，建议更新后间隔60秒以上再进行查询。全文索引的使用请查看点过滤查询和边过滤查询。您也可以使用cypher语句来执行全文索引，具体请查看cypher操作相关章节。目前全文索引特性只在持久化版规格版本中支持。索引创建后需要等待30秒索引同步时间，同步完成后Cypher查询才可以利用索引进行加速。

图引擎服务 GES 索引操作API

图引擎服务 GES-新建索引:响应示例

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

图引擎服务 GES 索引操作API

云服务器内容精选

图引擎服务 GES

7*24

备案

专业服务

退订

建议反馈

售前咨询热线