图引擎服务 GES-华为云

图引擎服务 GES-删除图(1.0.0):响应参数

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

图引擎服务 GES

图引擎服务 GES-删除图(1.0.0):URI

URI DELETE /v1.0/{project_id}/graphs/{graph_id} 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_id 是 String 图ID。表2 Query参数参数是否必选参数类型描述 keepBackup 否 Boolean 删除图后是否保留备份，默认保留1个自动备份和2个手动备份。该查询参数为空时，表示不保留。

图引擎服务 GES

图引擎服务 GES-概述

概述欢迎使用图引擎服务（Graph Engine Service）。图引擎服务是业内首个商用的、拥有自主知识产权的国产分布式原生图引擎，是针对以“关系”为基础的“图”结构数据，进行查询、分析的服务。广泛应用于社交应用、企业关系分析、风控、推荐、舆情、防欺诈等具有丰富关系数据的场景。您可以使用本文档提供API对图引擎服务资源进行相关操作。管理面API 管理面API提供了图的管理类功能，包括图的创建，关闭，启动，恢复，升级，导入、导出和清空数据，绑定和解绑EIP，创建、查询和删除图备份、元数据等功能。用户执行这些操作时，需要调用管理面的API。业务面API 业务面API提供了图的业务类功能，包括点、边、元数据的增加、删除、查询和修改，执行Gremlin查询，执行算法等功能。用户执行这些操作时，需要调用业务面的API。 GES支持的全部API请参见管理面API概览和内存版。在调用图引擎服务API之前，请确保已经充分了解图引擎服务相关概念，详细信息请参见产品介绍。父主题：使用前必读

图引擎服务 GES

图引擎服务 GES-管理面API构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），可告知服务正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。例如，在 IAM 获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

图引擎服务 GES

图引擎服务 GES-管理面API构造请求:请求消息头

请求消息头附加请求消息头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求消息头“Content-Type”，请求鉴权信息等。如下公共消息头需要添加到请求中。表1 公共请求头参数是否必选说明示例 Content-Type 是消息体的类型（格式），默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 application/json X-Auth-Token 使用Token方式认证时必选用户Token。例如，IAM用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 - X-Project-ID 否子项目ID。在多项目场景中使用，用于不同项目获取token。 e9993fc787d94b6c886cbaa340f9c0f4 Authorization 使用AK/SK认证时必选。签名认证信息。该值来源于请求签名结果。 - X-Sdk-Date 使用AK/SK认证时必选。请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。取值为当前系统的GMT时间。 20150907T101459Z Host 使用AK/SK认证时必选。请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 code.test.com or code.test.com:443 Content-Length POST/PUT请求必填。 GET不能包含。请求body长度，单位为Byte。 3495 X-Language 否请求语言。支持配置如下值： zh-cn：中文 en-us：英文 en-us 华为云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参考AK/SK认证。例如，对于IAM获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

图引擎服务 GES

图引擎服务 GES-管理面API构造请求:请求消息体

请求消息体请求消息体通常以结构化格式发出，与请求消息头中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。

图引擎服务 GES

图引擎服务 GES-管理面API构造请求:请求URI

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独拿出来强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器域名或IP，从地区和终端节点中获取。例如，图引擎服务在华北-北京一地区的endpoint为ges.cn-north-1.myhuaweicloud.com。 resource-path：资源路径，即API访问路径。从具体API的URI模块获取，例如IAM“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。例如，您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也是相同，所以简洁起见将这两部分省略。

图引擎服务 GES

图引擎服务 GES-管理面API认证鉴权:AK/SK认证

AK/SK认证 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK/SK签名认证方式仅支持消息体大小为12M以内的请求，12M以上的请求请使用Token认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

图引擎服务 GES

图引擎服务 GES-管理面API认证鉴权:Token认证

Token认证 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 username、domainname 的获取请参考获取账号名和账号ID。password为用户密码。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 GES服务必须通过project的方式来获取token，不支持scope为domain的方式。获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

图引擎服务 GES

图引擎服务 GES-关闭图(1.0.0):响应参数

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

图引擎服务 GES

图引擎服务 GES-关闭图(1.0.0):URI

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

图引擎服务 GES

图引擎服务 GES-持久化版

持久化版持久化版业务面API包括点操作、边操作、元数据操作、索引操作、HyG数据集管理、HyG算法、算法、图统计、图操作、Job管理、Cypher操作API。表1 点操作API 名称起始版本 URL 功能描述查询点详情 1.0.0 GET/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds={vertex_ids} 给定一个点或者一组点的集合，查询这些点的详情，包括Label信息。批量点查询 1.1.9 POST/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-query 批量查询点的详情。批量添加点 2.1.16 POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add 批量添加点的操作。批量删除点 2.1.9 POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete 根据批量节点ID删除节点。批量更新点属性 2.1.10 POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id={actionId} 批量更新点的属性。表2 边操作API 名称起始版本 URL 功能描述查询边详情 1.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&index={index} 根据边的源点和目的点查询边的详情，包括边的Label信息。批量边查询 1.1.6 POST/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query 批量查询边的详情。批量添加边 2.1.16 POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-add 批量添加边的操作。批量删除边 2.1.9 POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete 根据批量边的起点、终点以及索引，删除这些边。批量更新边属性 2.1.10 POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId} 批量更新边属性。表3 元数据操作API 名称起始版本 URL 功能描述添加label 1.1.6 POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels 添加label。更新label 1.1.7 POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{label_name}/properties 更新label。查询图元数据详情 1.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema 查询元数据详情。查询label 2.2.18 GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName} 查询label。表4 索引操作API 名称起始版本 URL 功能描述新建索引 1.1.6 POST /ges/v1.0/{project_id}/graphs/{graph_name}/indices 新建索引。删除索引 1.1.6 DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/indices/{indexName} 删除索引。查询索引 1.1.6 GET /ges/v1.0/{project_id}/graphs/{graph_name}/indices 查询索引。表5 原生算法API 名称起始版本 URL 功能描述执行算法 1.0.0 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm 执行原生算法。表6 图统计API 名称起始版本 URL 功能描述查询图概要信息 1.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary 查询图概要信息。查询图版本 2.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/version 查询图版本。表7 图操作API 名称起始版本 URL 功能描述导入图 2.1.14 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id= import-graph 导入图数据。清空图 2.1.2 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph 清空图数据。表8 Job管理API 名称起始版本 URL 功能描述查询Job状态 1.0.0 GET/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit 查询Job状态。查询job列表 2.2.13 GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset} 异步任务jobId返回后，若jobId业务层丢失无法通过接口重新获取，现在提供一个新的接口用于查询engine中保存的所有异步任务，返回每个任务的jobId、job状态、原始请求。表9 Cypher操作API 名称起始版本 URL 功能描述 Cypher操作API 2.2.16 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-cypher-query 使用Cypher语句可以查询GES中的数据，并返回结果父主题：业务面API概览

图引擎服务 GES 业务面API概览

图引擎服务 GES-查询图详情(1.0.0):响应示例

响应示例状态码： 200 OK { "graph": { "id": "f1529b88-c958-493e-8452-fccfe932cde1", "name": "demo", "regionCode": "cn-north-1", "azCode": "cn-north-1a", "schemaPath": [ { "path": "ges-graphs/demo_movie/schema.xml", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "edgesetPath": [ { "path": "ges-graphs/demo_movie/edge.csv", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "vertexsetPath": [ { "path": "", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "status": "200", "graphSizeTypeIndex": "1", "vpcId": "2d8af840-fd57-4e3b-a8f1-cda0f55ccd99", "subnetId": "dc018ec3-67d1-46c9-b2fc-19d83367f4e2", "securityGroupId": "11d27338-8649-4076-8579-5ebc1a60f79e", "created": "2018-07-23T04:09:44", "privateIp": "192.168.0.4", "publicIp": "49.4.81.183", "dataStoreVersion": "1.0.5", "arch": "x86_64" }}

图引擎服务 GES

图引擎服务 GES-点过滤查询(1.0.0):响应参数

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

图引擎服务 GES

图引擎服务 GES-点过滤查询(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"}

图引擎服务 GES

云服务器内容精选

图引擎服务 GES

7*24

备案

专业服务

退订

建议反馈

售前咨询热线