# 查询图列表(2.1.18) -ListGraphs2 #### 功能介绍 查询当前租户所有的图。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GES&api=ListGraphs2&version=v2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI GET /v2/{project_id}/graphs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-ges/ges_03_0111.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**： 本次请求的起始位置。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 0。 | | limit | 否 | Integer | **参数解释**： 每页资源数量的最大值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 10。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。用于获取操作API的权限。获取方法请参见[获取Token接口](https://support.huaweicloud.com/api-ges/ges_03_0005.html)，响应消息头中X-Subject-Token的值即为Token。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | graph_count | Integer | **参数解释**： 图总个数。请求失败时为空。 **取值范围**： 不涉及。 | | graphs | Array of [graphs] objects | **参数解释**： 图列表。请求失败时为空。 **取值范围**： 不涉及。 | 表5graphs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 图ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 图名称。 **取值范围**： 不涉及。 | | created_by | String | **参数解释**： IAM用户名。 **取值范围**： 不涉及。 | | is_multi_az | String | **参数解释**： 是否支持跨AZ高可用。 **取值范围**： 不涉及。 | | region_code | String | **参数解释**： 域编码。 **取值范围**： 不涉及。 | | az_code | String | **参数解释**： 可用区编码。 **取值范围**： 不涉及。 | | schema_path | Array of [schema_path] objects | **参数解释**： 元数据文件路径。 **取值范围**： 不涉及。 | | edgeset_path | Array of [edgeset_path] objects | **参数解释**： 边数据集OBS路径。 **取值范围**： 不涉及。 | | vertexset_path | Array of [vertexset_path] objects | **参数解释**： 点数据集OBS路径。 **取值范围**： 不涉及。 | | 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 | **参数解释**： 图创建时间（UTC时间）。 **取值范围**： 不涉及。 | | updated | String | **参数解释**： 图更新时间（UTC时间）。 **取值范围**： 不涉及。 | | private_ip | String | **参数解释**： 图实例私有网络访问浮动IP地址，通过该IP用户可以通过私有网络中已部署的弹性云服务器对图实例进行访问。 **取值范围**： 不涉及。 | | public_ip | String | **参数解释**： 图实例公网访问地址，通过该IP用户可以从互联网对图实例进行访问。 **取值范围**： 不涉及。 | | arch | String | **参数解释**： 图实例CPU架构类型。 **取值范围**： - x86_64：x86架构。 - aarch64：Arm架构。 | | master_key_id | String | **参数解释**： 用户主密钥ID。 **取值范围**： 不涉及。 | | master_key_name | String | **参数解释**： 用户主密钥名称。 **取值范围**： 不涉及。 | | enable_rbac | Boolean | **参数解释**： 是否启用细粒度权限控制。 **取值范围**： - true：启用。 - false：不启用。 | | enable_full_text_index | Boolean | **参数解释**： 是否启用全文索引。 **取值范围**： - true：启用。 - false：不启用。 | | enable_hyg | Boolean | **参数解释**： 是否启用HyG，该参数只对持久化版规格图生效。 **取值范围**： - true：启用。 - false：不启用。 | | traffic_ip_list | Array of strings | **参数解释**： 图实例私有网络访问物理地址列表。为了防止浮动IP切换造成业务闪断，推荐您通过轮询的方式使用物理IP访问图实例。 **取值范围**： 不涉及。 | | crypt_algorithm | String | **参数解释**： 图实例加密算法。 **取值范围**： - generalCipher：国密算法。 - SMcompatible：商密算法（兼容国际）。 | | enable_https | Boolean | **参数解释**： 是否开启安全模式，开启安全模式会对性能有较大影响。 **取值范围**： - true：开启。 - false：不开启。 | | tags | Array of [tags] objects | **参数解释**： 标签列表，每个标签用\键值对表示。 **取值范围**： 不涉及。 | | product_type | String | **参数解释**： 图产品类型。 **取值范围**： - InMemory：内存版。 - Persistence：持久化版。 | | vertex_id_type | [vertex_id_type] object | **参数解释**： 点的id类型。 仅持久化版的图返回该字段。 **取值范围**： 不涉及。 | | origin_graph_size_type_index | String | **参数解释**： 图的初始规格。该参数从2.3.15版本后开始支持。 **取值范围**： 不涉及。 | | expand_time | String | **参数解释**： 图扩副本的时间（UTC时间）。 **取值范围**： 不涉及。 | | resize_time | String | **参数解释**： 图变更规格的时间（UTC时间）。 **取值范围**： 不涉及。 | | capacity_ratio | Integer | **参数解释**： 图的容量倍率。该参数只有持久化版百亿规格图支持，且从2.3.18版本后开始支持。 **取值范围**： 不涉及。 | | sort_key_type | String | **参数解释**： 持久化版图数据的sortKey的类型。 **取值范围**： 不涉及。 | | enable_lts | Boolean | **参数解释**： 对接云服务LTS日志开启状态。 **取值范围**： - true：日志对接开启中。 - false：日志对接关闭中。 | 表6schema_path | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 导入OBS文件对应的job_id。 **取值范围**： 不涉及。 | | path | String | **参数解释**： OBS存储路径，不包含OBS Endpoint。 **取值范围**： 不涉及。 | | status | String | **参数解释**： OBS文件导入状态。 **取值范围**： - success：完全导入成功 - partiallyFailed：部分失败 - failed：完全导入失败 | 表7edgeset_path | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 导入OBS文件对应的job_id。 **取值范围**： 不涉及。 | | path | String | **参数解释**： OBS存储路径，不包含OBS Endpoint。 **取值范围**： 不涉及。 | | status | String | **参数解释**： OBS文件导入状态。 **取值范围**： - success：完全导入成功。 - partiallyFailed：部分失败。 - failed：完全导入失败。 | 表8vertexset_path | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 导入OBS文件对应的job_id。 **取值范围**： 不涉及。 | | path | String | **参数解释**： OBS存储路径，不包含OBS Endpoint。 **取值范围**： 不涉及。 | | status | String | **参数解释**： OBS文件导入状态。 **取值范围**： - success：完全导入成功。 - partiallyFailed：部分失败。 - failed：完全导入失败。 | 表9tags | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签key。 **取值范围**： 不涉及。 | | value | String | **参数解释**： 标签value。 **取值范围**： 不涉及。 | 表10vertex_id_type | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id_type | String | **参数解释**： id类型。 **取值范围**： - fixedLengthString：固定长度String格式下，实际点ID直接用于内部存储与计算，用户需指定一长度，实际点ID不可超过此长度。长度过大，可能影响查询性能，建议用户根据数据集状态进行设置。 - hash：哈希格式下，内部计算时将实际点ID转换成哈希码进行存储与计算，对实际点ID长度无限制，但是存在极低的概率(约10\^(-43))出现点ID碰撞。若用户无法确定点ID的最大长度，建议选择哈希类型。 | | id_length | Integer | **参数解释**： id长度，当id_type值为fixedLengthString时返回该字段。 **取值范围**： 1-128。 | **状态码： 400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 系统提示信息。 - 执行成功时，字段可能为空。 - 执行失败时，用于显示错误信息。 **取值范围**： 不涉及 | | error_code | String | **参数解释**： 系统提示信息。 - 执行成功时，字段可能为空。 - 执行失败时，用于显示错误码。 **取值范围**： 不涉及 | #### 请求示例 查看当前租户的前10个图。 ``` GET https://{Endpoint}/v2/{project_id}/graphs?offset=0&limit=10 ``` #### 响应示例 **状态码： 200** 成功响应示例 ``` { "graph_count" : 2, "graphs" : [ { "id" : "146227d2-bfac-499a-97df-df475349e43d", "name" : "TenThousand_Charging", "created_by" : "ei_ges_j00356469_01", "is_multi_az" : "false", "region_code" : "cn-north-7", "az_code" : "cn-north-7c", "edgeset_format" : "", "edgeset_default_label" : "", "vertexset_format" : "", "vertexset_default_label" : "", "data_store_version" : "2.3.2", "sys_tags" : [ "0" ], "status" : "200", "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" : 1, "created" : "2022-04-26T02:19:54", "private_ip" : "192.168.0.228", "arch" : "x86_64", "master_key_id" : "", "master_key_name" : "", "enable_rbac" : false, "enable_full_text_index" : false, "enable_hyg" : false, "traffic_ip_list" : [ "192.168.0.228" ], "crypt_algorithm" : "generalCipher", "enable_https" : false, "origin_graph_size_type_index": "1", "expand_time": "2023-08-03T02:10:52", "resize_time": "2023-08-02T02:10:52" }, { "id" : "1172f16c-63c7-4746-89b0-78972eddf706", "name" : "GES_UI_2_0_1", "created_by" : "ei_ges_j00356469_01", "is_multi_az" : "false", "region_code" : "cn-north-7", "az_code" : "cn-north-7c", "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" : 1, "created" : "2022-04-26T02:10:52", "private_ip" : "192.168.0.123", "enable_rbac" : false, "enable_full_text_index" : false, "enable_hyg" : false, "traffic_ip_list" : [ "192.168.0.123" ], "crypt_algorithm" : "generalCipher", "enable_https" : 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 | 服务不可用 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ges/ges_03_0040.html)。