Show Index
Method |
GET |
URL |
/v1/index/<index_id> |
Authentication required? |
no |
Response Body |
a GSearchIndex document |
Although it is possible to fetch an index by its display_name, this usage is
deprecated and strongly discouraged.
Looking up an index with an id of 4de0e89e-a395-11e7-bc54-8c705ad34f60:
curl -XGET 'https://search.api.globus.org/v1/index/4de0e89e-a395-11e7-bc54-8c705ad34f60'Response Schemas
GSearchIndex
The following document type, a GSearchIndex document, describes various attributes of an index.
| Field Name | Type | Description |
|---|---|---|
display_name |
String |
A common name for the index suitable for display in user interfaces |
id |
String |
A UUID uniquely identifying this index |
description |
String |
A description of the index |
creation_date |
String |
A timestamp in ISO 8601 format, indicating when the index was created |
max_size_in_mb |
Integer |
The maximum size the index will be permitted to grow to in units of Megabytes (1MB = 1,000,000 bytes) |
size_in_mb |
Integer |
The current size of the index rounded down to the closest Megabyte value |
num_subjects |
Integer |
The number of unique subjects stored in the index |
num_entries |
Integer |
The number of GMetaEntries stored in the index |
{
"@datatype": "GSearchIndex",
"@version": "2017-09-01",
"creation_date": "2017-09-05 19:02:18",
"description": "",
"display_name": "globus_search",
"id": "e56fdc95-0c55-4533-ba51-c1e8619ece7b",
"max_size_in_mb": 5000,
"num_entries": 1,
"num_subjects": 1,
"size_in_mb": 0
}