云服务器内容精选

华为云首页用户手册

API概览

图引擎服务 GES-管理面API概览

管理面API概览 GES管理面API包括系统管理，图管理，备份管理，元数据管理和任务中心。表1 系统管理API 名称版本 URL 功能描述查询配额 1.0.0 GET /v2/{project_id}/graphs/quotas 查询图个数、边数以及备份个数配额。创建图或者图备份操作时，可以调用该API查看配额，避免报错配额不足。表2 图管理API 名称版本 URL 功能描述查询图列表 2.1.18 GET /v2/{project_id}/graphs 查看已经创建的所有图的列表。查询图详情 1.0.0 GET /v2/{project_id}/graphs/{graph_id} 查询某个图的详情，包括图内网、公网访问地址，图版本号，图已经导入的点、边数据集。创建图 2.2.2 POST /v2/{project_id}/graphs 用户定义好图的元数据和点、边数据集后，下一步就是创建一个图。关闭图 1.0.0 POST /v2/{project_id}/graphs/{graph_id}/stop 用户的业务不需要连续性，可以随时关闭图。停止后，图停止计费。启动图 1.0.0 POST /v2/{project_id}/graphs/{graph_id}/start 用户关闭图后要再次使用图，可以把数据恢复到上次关闭状态或者恢复到某个备份时间点。删除图 1.0.0 DELETE /v2/{project_id}/graphs/{graph_id} 用户不需要时可以删除图，删除后图停止计费。增量导入图 2.1.14 POST /v2/{project_id}/graphs/{graph_id}/import-graph 用户需要增量导入图数据。导出图 1.0.5 POST /v2/{project_id}/graphs/{graph_id}/export-graph 用户需要把图的所有数据导出为文本文件。清空图 2.1.2 POST /v2/{project_id}/graphs/{graph_id}/clear-graph 用户要把图的所有数据清空，包括点、边数据。说明：当前清空图不清除元数据。升级图 1.0.5 POST /v2/{project_id}/graphs/{graph_id}/upgrade 老版本的图有Bug或者需要增加新功能时，需要把老版本的图升级到新版本。绑定EIP 1.0.6 POST /v2/{project_id}/graphs/{graph_id}/bind-eip 用户需要在公网访问图时，需要绑定一个弹性公网IP。解绑EIP 1.0.6 POST /v2/{project_id}/graphs/{graph_id}/unbind-eip 用户不需要在公网访问图时，可以把该图绑定的弹性公网IP解绑。变更规格 2.2.21 POST /v2/{project_id}/graphs/{graph_id}/resize 变更图规格。强制重启图 2.2.21 POST /v2/{project_id}/graphs/{graph_id}/restart 强制启动一个图。扩副本 2.2.23 POST /v2/{project_id}/graphs/{graph_id}/expand 扩副本能力允许动态扩容多个从节点，扩容的从节点可以处理读请求，从而提高读请求性能。表3 备份管理API 名称版本 URL 功能描述查看所有备份列表 1.0.0 GET /v2/{project_id}/graphs/backups 查看所有图的所有备份详情。查看某个图的备份列表 1.0.0 GET /v2/{project_id}/graphs/{graph_id}/backups 查看某个图下所有备份的详情，包括备份开始、结束时间等。新增备份 1.0.0 POST /v2/{project_id}/graphs/{graph_id}/backups 备份用于增加数据可靠性，同时可以作为一个图的快照，方便恢复到该快照。删除备份 1.0.0 DELETE /v2/{project_id}/graphs/{graph_id}/backups/{backup_id} 删除某个图的备份。导出备份 2.3.16 POST /v2/{project_id}/graphs/{graph_id}/backups/export 通过该API，您可以将GES图实例备份导出到OBS。导入备份 2.3.16 POST /v2/{project_id}/graphs/{graph_id}/backups/import 通过该API，您可以从OBS上的备份文件导入备份。表4 元数据管理API 名称版本 URL 功能描述查询元数据列表 1.0.2 GET /v2/{project_id}/graphs/metadatas 查询所有元数据详情，包括状态、OBS存储路径。查询元数据 1.0.2 GET /v2/{project_id}/graphs/metadatas/{metadata_id} 查询某个元数据详情。新增元数据 2.1.18 POST /v2/{project_id}/graphs/metadatas 新增元数据为创建图之前的准备操作，用户必须先创建元数据才能创建图。删除元数据 1.0.2 DELETE /v2/{project_id}/graphs/metadatas/{metadata_id} 删除一个元数据。从OBS导入元数据 1.0.0 POST /v2/{project_id}/graphs/metadata/upload-from-obs 从OBS导入元数据。表5 任务中心API 名称版本 URL 功能描述查询Job状态 1.0.0 GET /v2/{project_id}/graphs/{graph_id}/jobs/{job_id}/status 图删除、关闭、启动、恢复、增量导入、清空、升级等API为异步任务，API会返回jobId，可以通过该接口查看异步任务执行状态。查询任务中心 1.1.8 GET /v2/{project_id}/graphs/jobs 用户查看所有的异步任务。表6 GraphPlugins管理API 名称版本 URL 功能描述查询获取场景应用分析插件 2.3.11 GET /v2/{project_id}/graphs/scenes 查询scenes场景下的应用分析能力详情，可以获得对应场景下的application、参数和功能介绍详情。订阅场景分析插件 2.3.11 POST /v2/{project_id}/graphs/{graph_id}/scenes/register 订阅scenes应用场景分析能力，便于业务面API使用对应功能。取消订阅场景分析插件 2.3.11 POST /v2/{project_id}/graphs/{graph_id}/scenes/unregister 取消订阅scenes场景应用分析能力，取消订阅后对应scene下的application业务面API将不能使用。父主题： API概览

图引擎服务 GES API概览
图引擎服务 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概览