文档首页/ 图引擎服务 GES/ API参考/ 业务面API/ 持久化版/ 索引操作API/ 查询索引
更新时间：2023-11-09 GMT+08:00
查看PDF
分享

查询索引

功能介绍

查询在图上创建的所有索引。

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/indices
表1 路径参数

参数

是否必选

类型

说明

project_id

是

String

项目ID。获取方法请参见获取项目ID。

graph_name

是

String

图名称。

响应参数

表2 响应Body参数说明

参数

类型

说明

errorMessage

String

系统提示信息。

  • 执行成功时，字段可能为空。
  • 执行失败时，用于显示错误信息。

errorCode

String

系统提示信息。

  • 执行成功时，字段可能为空。
  • 执行失败时，用于显示错误码。

data

Object

要查询的索引数据。

result

String

查询结果，成功时为success。

indices

List

查询结果，索引列表。

indexType

String

查询结果，索引类别。

indexName

String

查询结果，索引名称。

indexLabel

List

查询结果，局部索引的label列表。

indexProperty

List

查询结果，创建的索引属性列表。

hasLabel

Boolean

查询结果，索引中是否包含label。

说明：

全文索引该参数默认值为false。

请求示例

查询在图上创建的所有索引。

GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices

SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例

状态码： 200

成功响应示例 
Http Status Code: 200
{
  "data": {
    "indices": [
      {
        "indexType": "GlobalCompositeVertexIndex",
        "indexName": "ageIndx",
        "indexProperty": [
          "age"
        ],
        "hasLabel": true
       
      }
    ]
  },
   "result": "success"
}

状态码： 400

失败响应示例

Http Status Code: 400
{
  "errorMessage": "graph [demo] is not found",
  "errorCode": "GES.8605"
}

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码。

父主题： 索引操作API