文档首页 > > API参考> API概览>

管理面API概览

管理面API概览

分享
更新时间:2020/12/14 GMT+08:00

GES管理面API包括系统管理,图管理,备份管理,元数据管理和任务中心。

表1 系统管理API

名称

版本

URL

功能描述

查询配额

1.0.0

GET /v1.0/{projectId}/graphs/quotas

查询图个数、边数以及备份个数配额。创建图或者图备份操作时,可以调用该API查看配额,避免报错配额不足。

校验元数据文件

1.0.0

POST /v1.0/{projectId}/graphs/action?action_id=check-schema

校验元数据文件和点、边数据集是否匹配。创建有初始数据的图或者增量导入图时,可以调用该API校验点、边数据集和元数据是否匹配。

表2 图管理API

名称

版本

URL

功能描述

查询图列表

2.1.18

GET /v1.0/{projectId}/graphs?offset={offset}&limit={limit}

查看已经创建的所有图的列表。

查询图详情

1.0.0

GET /v1.0/{projectId}/graphs/{graphId}

查询某个图的详情,包括图内网、公网访问地址,图版本号,图已经导入的点、边数据集。

创建图

2.2.2

POST /v1.0/{projectId}/graphs

用户定义好图的元数据和点、边数据集后,下一步就是创建一个图。

关闭图

1.0.0

POST/v1.0/{projectId}/graphs/{graphId}/action?action_id=stop

用户的业务不需要连续性,可以随时关闭图。停止后,图停止计费。

启动图

1.0.0

POST /v1.0/{projectId}/graphs/{graphId}/action?action_id=start

用户关闭图后要再次使用图,可以把数据恢复到上次关闭状态或者恢复到某个备份时间点。

删除图

1.0.0

DELETE /v1.0/{projectId}/graphs/{graphId}

用户不需要时可以删除图,删除后图停止计费。

增量导入图

2.1.14

POST /v1.0/{projectId}/graphs/{graphId}/action?action_id=import-graph

用户需要增量导入图数据。

导出图

1.0.5

POST /v1.0/{projectId}/graphs/{graphId}/action?action_id=export-graph

用户需要把图的所有数据导出为文本文件。

清空图

2.1.2

POST /v1.0/{projectId}/graphs/{graphId}/action?action_id=clear-graph&clear-metadata={clearMetadata}

用户要把图的所有数据清空,包括点、边数据。

说明:

当前清空图不清除元数据。

升级图

1.0.5

POST /v1.0/{projectId}/graphs/{graphId}/action?action_id=upgrade

老版本的图有Bug或者需要增加新功能时,需要把老版本的图升级到新版本。

绑定EIP

1.0.6

POST /v1.0/{projectId}/graphs/{graphId}/action?action_id=bindEip

用户需要在公网访问图时,需要绑定一个弹性公网IP。

解绑EIP

1.0.6

POST /v1.0/{projectId}/graphs/{graphId}/action?action_id=unbindEip

用户不需要在公网访问图时,可以把该图绑定的弹性公网IP解绑。

表3 备份管理API

名称

版本

URL

功能描述

查看所有备份列表

1.0.0

GET /v1.0/{projectId}/graphs/backups?offset={offset}&limit={limit}

查看所有图的所有备份详情。

查看某个图的备份列表

1.0.0

GET/v1.0/{projectId}/graphs/{graphId}/backups?offset={offset}&limit={limit}

查看某个图下所有备份的详情,包括备份开始、结束时间等。

新增备份

1.0.0

POST/v1.0/{projectId}/graphs/{graphId}/backups

备份用于增加数据可靠性,同时可以作为一个图的快照,方便恢复到该快照。

删除备份

1.0.0

DELETE/v1.0/{projectId}/graphs/{graphId}/backups/{backupId}

删除某个图的备份。

表4 元数据管理API

名称

版本

URL

功能描述

查询元数据列表

1.0.2

GET /v1.0/{projectId}/graphs/metadatas?offset={offset}&limit={limit}

查询所有元数据详情,包括状态、OBS存储路径。

查询元数据

1.0.2

GET/v1.0/{projectId}/graphs/metadatas/{metadataId}

查询某个元数据详情。

新增元数据

2.1.18

POST /v1.0/{projectId}/graphs/metadatas

新增元数据为创建图之前的准备操作,用户必须先创建元数据才能创建图。

删除元数据

1.0.2

DELETE/v1.0/{projectId}/graphs/metadatas/{metadataId}

删除一个元数据。

表5 任务中心API

名称

版本

URL

功能描述

查询Job状态

1.0.0

GET/v1.0/{projectId}/graphs/{graphId}/jobs/{jobId}/status

图删除、关闭、启动、恢复、增量导入、清空、升级等API为异步任务,API会返回jobId,可以通过该接口查看异步任务执行状态。

查询任务中心

1.1.8

GET /v1.0/{projectId}/graphs/jobs?offset={offset}&limit={limit}

用户查看所有的异步任务。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区论坛频道来与我们联系探讨

智能客服提问云社区提问