本文导读

展开导读

文档首页/ 图引擎服务 GES/ API参考（阿布扎比区域）/ 管理面API（V2）/ 图管理API/ 查询图详情

查询图详情

更新时间：2025-03-05 GMT+08:00

查看PDF

功能介绍

根据图ID查询某个图详情。

URI

GET /v2/{project_id}/graphs/{graph_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID。
graph_id	是	String	图ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
graph	graph object	请求失败时为空。

表4 graph
参数	参数类型	描述
id	String	图ID。
name	String	图名称。
created_by	String	IAM用户名。
is_multi_az	String	是否支持跨AZ高可用。
region_code	String	域编码。
az_code	String	可用区编码。
edgeset_format	String	边数据集文件格式。
edgeset_default_label	String	边数据集文件默认Label。
vertexset_format	String	点数据集文件格式。
vertexset_default_label	String	点数据集文件默认Label。
data_store_version	String	图版本。
sys_tags	Array of strings	企业项目信息，如果未指定则不开启，默认不开启。
status	String	图的状态码。 100：准备中 200：运行中 201：升级中 202：导入中 203：回滚中 204：导出中 205：清空中 206：扩容准备中 207：扩容中 208：扩容回退中 210：扩副本准备中 211：扩副本中 300：故障 303：创建失败 400：被删除 800：已冻结 900：停止 901：停止中 920：启动中
action_progress	String	图创建进度百分比。说明：只有图状态码为100时返回该字段。
graph_size_type_index	String	图规模类型索引。 0：一万边 1：百万边 2：千万边 3：一亿边 4：十亿边 5：百亿边 6：持久化版 401：十亿增强边
vpc_id	String	虚拟私有云ID。
subnet_id	String	指定虚拟私有云下的子网ID。
security_group_id	String	安全组ID。
replication	Integer	副本个数，默认为1。
created	String	图创建时间。
updated	String	图更新时间。
private_ip	String	图实例私有网络访问浮动IP地址，通过该IP用户可以通过私有网络中已部署的弹性云服务器对图实例进行访问。
public_ip	String	图实例公网访问地址，通过该IP用户可以从互联网对图实例进行访问。
arch	String	图实例CPU架构类型，取值为x86_64和aarch64。
master_key_id	String	用户主密钥ID。
master_key_name	String	用户主密钥名称。
enable_rbac	Boolean	是否启用细粒度权限控制。
enable_full_text_index	Boolean	是否启用全文索引。
enable_hyg	Boolean	是否启用HyG，该参数只对持久化版规格图生效。
traffic_ip_list	Array of strings	图实例私有网络访问物理地址列表。为了防止浮动IP切换造成业务闪断，推荐您通过轮询的方式使用物理IP访问图实例。
crypt_algorithm	String	图实例加密算法，取值为： generalCipher：国密算法 SMcompatible：商密算法（兼容国际）
enable_https	Boolean	是否开启安全模式，开启安全模式会对性能有较大影响
tags	Array of tags objects	标签列表，每个标签用<key,value>键值对表示。
product_type	String	图产品类型，取值为InMemory和Persistence，默认为InMemory，当graph_size_type_index取值为"6"时，默认为Persistence。 InMemory：内存版 Persistence：持久化版
vertex_id_type	vertex_id_type object	点的id类型，仅持久化图需要填写。说明：点ID类型确定后，将无法更改，请用户谨慎选择!
origin_graph_size_type_index	String	图的初始规格。
expand_time	String	图扩副本的时间。
resize_time	String	图扩容的时间。
enable_multi_label	Boolean	是否启用多标签。
capacity_ratio	Integer	图的容量倍率。该参数只有持久化版百亿规格图支持。

表5 tags
参数	参数类型	描述
key	String	标签key
value	String	标签value

表6 vertex_id_type
参数	参数类型	描述
id_type	String	id类型，目前支持固定长度fixedLengthString和hash两种点ID类型。 fixedLengthString：固定长度String格式下，实际点ID直接用于内部存储与计算，用户需指定一长度，实际点ID不可超过此长度。长度过大，可能影响查询性能，建议用户根据数据集状态进行设置。 hash：哈希格式下，内部计算时将实际点ID转换成哈希码进行存储与计算，对实际点ID长度无限制，但是存在极低的概率(约10^(-43))出现点ID碰撞。若用户无法确定点ID的最大长度，建议选择哈希类型。
id_length	Integer	当id_type取值为fixedLengthString时必填，取值范围：1-128。

状态码： 400

表7 响应Body参数
参数	参数类型	描述
error_code	String	系统提示信息。执行成功时，字段可能为空。执行失败时，用于显示错误码。
error_msg	String	系统提示信息。执行成功时，字段可能为空。执行失败时，用于显示错误信息。

请求示例

根据图ID查询某个图详情。

GET https://Endpoint/v2/{project_id}/graphs/{graph_id}

响应示例

状态码： 200

响应成功示例

{
  "graph" : {
    "id" : "1172f16c-63c7-4746-89b0-78972eddf706",
    "name" : "GES_UI_2_0_1",
    "created_by" : "ei_ges_j00356469_01",
    "is_multi_az" : "false",
    "region_code" : "XXX",
    "az_code" : "XXX",
    "edgeset_format" : "",
    "edgeset_default_label" : "",
    "vertexset_format" : "",
    "vertexset_default_label" : "",
    "data_store_version" : "2.0.1",
    "sys_tags" : [ "0" ],
    "status" : "900",
    "graph_size_type_index" : "0",
    "vpc_id" : "0ac6e3c3-2c9b-4296-84f7-6883cebc7b41",
    "subnet_id" : "2b1755eb-d6d4-421f-88c0-cf6f0bc16801",
    "security_group_id" : "7aa7c8c9-7443-4a01-abf5-8064b586f8f5",
    "replication" : 0,
    "created" : "2022-04-26T02:10:52",
    "updated" : "2022-04-26T02:10:52",
    "private_ip" : "192.168.0.123",
    "encrypted" : false,
    "enable_rbac" : false,
    "enable_full_text_index" : false,
    "enable_hyg" : false,
    "traffic_ip_list" : [ "192.168.0.123" ],
    "crypt_algorithm" : "generalCipher",
    "enable_https" : false,
    "enable_multi_label":false,
    "origin_graph_size_type_index": "1",
    "expand_time": "2023-08-03T02:10:52",
    "resize_time": "2023-08-02T02:10:52"
  }
}

状态码： 400

响应失败示例

{
  "error_code" : "GES.7006",
  "error_msg" : "An internal error occurs in the underlying service of the graph engine."
}

状态码

返回值	说明
400 Bad Request	请求错误
401 Unauthorized	鉴权失败
403 Forbidden	没有操作权限
404 Not Found	找不到资源
500 Internal Server Error	服务内部错误
503 Service Unavailable	服务不可用

错误码

请参见错误码。

父主题： 图管理API

上一篇：查询图列表

下一篇：创建图

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消