查询图列表
功能介绍
查询当前租户所有的图。
URI
GET /v2/{project_id}/graphs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。获取方法请参见获取项目ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 本次请求的起始位置，默认为0。 |
| limit | 否 | Integer | 每页资源数量的最大值，默认为10。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 |
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| graph_count | Integer | 图总个数。请求失败时为空。 |
| graphs | Array of graphs objects | 图列表。请求失败时为空。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 图的状态码。
|
| action_progress | String | 图创建进度百分比。 说明： 只有图状态码为100时返回该字段。 |
| graph_size_type_index | String | 图规模类型索引。
|
| 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 | 图实例加密算法，取值为：
|
| enable_https | Boolean | 是否开启安全模式，开启安全模式会对性能有较大影响 |
| tags | Array of tags objects | 标签列表，每个标签用<key,value>键值对表示。 |
| product_type | String | 图产品类型，取值为InMemory和Persistence，默认为InMemory，当graph_size_type_index取值为"6"时，默认为Persistence。
|
| vertex_id_type | vertex_id_type object | 点的id类型，仅持久化图需要填写。 说明： 点ID类型确定后，将无法更改，请用户谨慎选择! |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id_type | String | id类型，目前支持固定长度fixedLengthString和hash两种点ID类型。
|
| id_length | Integer | 当id_type取值为fixedLengthString时必填，取值范围：1-128。 |
状态码： 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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" : "XXX",
"az_code" : "XXX",
"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",
"encrypted" : false,
"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
}, {
"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" : 1,
"created" : "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
} ]
} 状态码： 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 | 服务不可用 |
错误码
请参见错误码。
