图引擎服务 GES
图引擎服务 GES
- 最新动态
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 如何使用图引擎服务
- 准备工作
- 权限管理
- 元数据操作
- 创建图
- 管理图
- 数据迁移
- 访问图和分析图
- 查看图任务
- 配置图操作权限
- 运维监控
- 套餐包管理
-
算法参考
- 算法一览表
- PageRank算法
- PersonalRank算法
- k核算法（k-core）
- k跳算法（k-hop）
- 最短路径算法（Shortest Path）
- 全最短路算法（All Shortest Paths）
- 带一般过滤条件最短路径（Filtered Shortest Path）
- 单源最短路算法（SSSP）
- 点集最短路（Shortest Path of Vertex Sets）
- 关联路径算法（n-Paths）
- 紧密中心度算法（Closeness Centrality）
- 标签传播算法（Label Propagation）
- Louvain算法
- 关联预测算法（Link Prediction）
- Node2vec算法
- 实时推荐算法（Real-time Recommendation）
- 共同邻居算法（Common Neighbors）
- 连通分量算法（Connected Component）
- 度数关联度算法（Degree Correlation）
- 三角计数算法（Triangle Count）
- 聚类系数算法（Cluster Coefficient）
- 中介中心度算法（Betweenness Centrality）
- 边中介中心度（Edge-betweenness Centrality）
- OD中介中心度（OD-betweenness Centrality）
- 单点环路检测（Single Vertex Circles Detection）
- 点集共同邻居（Common Neighbors of Vertex Sets）
- 点集全最短路（All Shortest Paths of Vertex Sets）
- 带一般过滤条件环路检测（filtered circle detection）
- 子图匹配（Subgraph Matching）
- 带过滤全对最短路径（Filtered All Pairs Shortest Paths）
- 带过滤全最短路径（Filtered All Shortest Paths）
- TopicRank算法
- 带过滤的n_paths算法（filtered_n_paths）
- 时序路径分析（Temporal Paths）
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
- 管理面API（V2）
-
业务面API
-
内存版
- 点操作API
- 边操作API
- 元数据操作API
- 索引操作API
- Gremlin操作API
-
算法API
- 执行算法(1.0.0)
-
算法API参数参考
- 算法公共参数
- pagerank算法(1.0.0)
- personalrank算法(1.0.0)
- k核算法（kcore）(1.0.0)
- k跳算法（k_hop）(1.0.0)
- 共同邻居（common_neighbors）(1.0.0)
- 点集共同邻居(common_neighbors_of_vertex_sets)(2.2.13)
- 关联预测（link_prediction）(1.0.0)
- 最短路径（shortest_path）(2.1.5)
- 全最短路（all_shortest_paths）(1.0.12)
- 带一般过滤条件最短路径（filtered_shortest_path）(2.2.4)
- 单源最短路（sssp）(1.0.0)
- 点集最短路（shortest_path_of_vertex_sets）(2.1.5)
- 关联路径（n_paths）(1.1.2)
- 带过滤的n_paths算法（filtered_n_paths）(2.2.22)
- 带过滤全对最短路径（filtered_all_pairs_shortest_paths）(2.2.17)
- 点集全最短路(all_shortest_paths_of_vertex_sets)(2.2.15)
- 带过滤全最短路径（filtered_all_shortest_paths）(2.2.17)
- 连通分量（connected_component）(1.0.0)
- 标签传播（label_propagation）(2.1.8)
- louvain算法（louvain）(2.2.1)
- node2vec算法（node2vec）(1.0.5)
- 实时推荐（realtime_recommendation）(2.2.21)
- 度数关联度（degree_correlation）(1.0.0)
- 三角计数（triangle_count）(1.0.0)
- 聚类系数（cluster_coefficient）(1.0.0)
- 紧密中心度（closeness）(1.0.0)
- 中介中心度算法（betweenness）(2.2.4)
- 边中介中心度（edge_betweenness）(2.2.4)
- OD中介中心度（od_betweenness）（2.2.4）
- 单点环路检测（single_vertex_circles_detection）（2.2.4）
- 带一般过滤条件环路检测（filtered_circle_detection）(2.2.15)
- 子图匹配（subgraph_matching）(2.2.16)
- topicrank算法（topicrank）(2.2.20)
- 动态图分析API
- 路径API
- 图统计API
- 图操作API
- 子图操作API
- Job管理API
- 自定义操作API
- Cypher操作API（2.2.16）
- Filtered-query API(2.2.13)
- Filtered-query V2(2.3.6)
- DSL查询API（2.3.14）
- 通过导入文件更新点边的指定属性(2.2.13)
- 通过读取文件删除点边（2.2.15）
- 运维监控API
-
持久化版
- 持久化版规格说明
- 点操作API
- 边操作API
- 元数据操作API
- 索引操作API
- HyG图管理API
-
HyG算法API
- 执行算法
-
算法API参数参考
- 算法公共参数
- pagerank算法
- personalrank算法（personalrank）
- k核算法（kcore）
- k跳算法（k_hop）
- 点集共同邻居(common_neighbors_of_vertex_sets)
- 最短路径（shortest_path）
- 全最短路（all_shortest_paths）
- 全对最短路径（all_pairs_shortest_paths）
- 单源最短路算法（sssp）
- 点集最短路（shortest_path_of_vertex_sets）
- 点集全最短路（all_shortest_paths_of_vertex_sets）
- 连通分量（connected_component）
- 三角计数算法（triangle_count）
- 紧密中心度算法（closeness）
- 中介中心度算法（betweenness）
- 边中介中心度（edge_betweenness）
- OD中介中心度（od_betweenness）
- 单点环路检测（single_vertex_circles_detection）
- topicrank算法（topicrank）
- louvain算法（louvain）
- Bigclam算法（bigclam）
- Cesna算法（cesna）
- infomap算法（infomap）
- 标签传播算法（label_propagation）
- 子图匹配算法（subgraph matching）
- 关联预测算法（link_prediction）
- n_paths算法（n_paths）
- 聚类系数算法（cluster_coefficient）
- 算法结果TXT格式说明
- 执行DSL算法
- DSL语法说明
- HyG Job管理API
- 原生算法API
- 图统计API
- 图操作API
- Job管理API
- Cypher操作API
- 交互式事务API
- 运维监控API
-
内存版
- 应用示例
- 权限策略和授权项
- 云监控服务监控指标说明
- 历史API
- 附录
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
业务面API构造请求
本节介绍GES业务面REST 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条数据。
请求方法
HTTP请求方法（也称为操作或动词），可告知服务正在请求什么类型的操作。
- GET：请求服务器返回指定资源。
- PUT：请求服务器更新指定资源。
- POST：请求服务器新增资源或执行特殊操作。
- DELETE：请求服务器删除指定资源，如删除对象等。
- HEAD：请求服务器资源头部。
- PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。
请求消息头
附加请求消息头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求消息头“Content-Type”，请求鉴权信息等。
如下公共消息头需要添加到请求中。
|
参数名 |
是否必选 |
说明 |
示例 |
|---|---|---|---|
|
Content-Type |
是 |
消息体的类型（格式），默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 |
application/json |
|
X-Auth-Token |
是 |
用户Token。例如，IAM用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 |
- |
|
X-Language |
是 |
请求语言。支持配置如下值：
|
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/tokens
Content-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。
父主题： 构造请求
