Updated on 2024-01-04 GMT+08:00

Querying Indexes

Function

This API is used to query all indexes created on a graph.

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/indices
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

graph_name

Yes

String

Graph name

Response Parameters

Table 2 Response body parameters

Parameter

Type

Description

errorMessage

String

System prompt.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error message.

errorCode

String

System prompt.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error code.

data

Object

Index data you want to query

result

String

Query results. If the query is successful, success is displayed.

indices

List

Indexes of the query results

indexType

String

Index types of the query results

indexName

String

Index names of the query results

indexLabel

List

Labels of local indexes

indexProperty

List

Index properties of the query results

hasLabel

Boolean

Whether the indexes of the query results contain labels

NOTE:

For full-text indexes, the default value is false.

Example Request

Query all indexes created on a graph.

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

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Example Response

Status code: 200

Example response for a successful request
Http Status Code: 200
{
  "data": {
    "indices": [
      {
        "indexType": "GlobalCompositeVertexIndex",
        "indexName": "ageIndx",
        "indexProperty": [
          "age"
        ],
        "hasLabel": true
       
      }
    ]
  },
   "result": "success"
}

Status code: 400

Example response for a failed request

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

Status Codes

Return Value

Description

400 Bad Request

Request error.

401 Unauthorized

Authorization failed.

403 Forbidden

No operation permissions.

404 Not Found

No resources found.

500 Internal Server Error

Internal server error.

503 Service Unavailable

Service unavailable.

Error Codes

See Error Codes.