Querying Indexes

Function

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

URI

• URI format

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

• Parameter description

  Table 1 URI parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
  graph_name	Yes	String	Graph name

Request

• Request example

  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 Constraints of Using Service Plane APIs.

Response

• Parameter description

  Table 2 Parameter description

  Parameter	Mandatory	Type	Description
  errorMessage	No	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	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  result	No	String	Query results. If the query is successful, success is displayed.
  indices	No	List	Indexes of the query results
  indexType	No	String	Index types of the query results
  indexName	No	String	Index names of the query results
  indexProperty	No	List	Index properties of the query results

• Response example (successful request)

  Http Status Code: 200
  {
    "data": {
      "result": "success",
      "indices": [
        {
          "indexType": "GlobalCompositeVertexIndex",
          "indexName": "ageIndx",
          "indexProperty": [
            "age"
          ],
          "hasLabel": "true"
         
        }
      ]
    }
  }

• Response example of a successful request

  Http Status Code: 200
  {
    "data": {
      "indices": [
        {
          "indexType": "GlobalCompositeVertexIndex",
          "indexName": "ageIndx",
          "indexProperty": [
            "age"
          ],
          "hasLabel": true
         
        }
      ]
    },
     "result": "success"
  }

• Response example (failed request)

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

Return Value

• Normal

  200

• Abnormal

  Table 3 Return code for failed requests

  Return Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	No operation permission.
  404 Not Found	The requested resource was not found.
  500 Internal Server Error	Internal service error.
  503 Service Unavailable	Service unavailable.