Retrieve GSI Status
To retrieve GSI status, use GET /getIndexStatus
.
Description
This endpoint returns status on Global Secondary Indexes. The specified IP address should be that of any cluster-node that is running the Index Service; and the specified port must be 9102.
Sample Curl Command
The following example retrieves GSI status from node 10.142.180.101; which is running the Index Service, at port 9102.
curl -u Administrator:password -v -X GET http://10.142.180.101:9102/getIndexStatus
Sample Response
- 200 OK
-
The response body contains status on each defined index. See below for a formatted example
- 401 Unauthorized
-
The body of the response is empty.
Formatted status for one index contained in the successful response might appear as follows:
{
"defnId":4624455053989895893,
"instId":5414678899896559144,
"name":"def_airportname",
"bucket":"travel-sample",
"secExprs":["`airportname`"],
"indexType":"plasma",
"status":"Warmup",
"definition":"CREATE INDEX `def_airportname` ON `travel-sample`(`airportname`) WITH { \"defer_build\":true }",
"hosts":["10.142.180.101:8091"],
"completion":0,
"progress":0,
"scheduled":false,
"partitioned":false,
"numPartition":1,
"partitionMap":{"10.142.180.101:8091":[0]}
},