1. Description

The Index Management API provides only one method for getting more information about an index. This includes summary information including naming and description as well as basic status information in terms of the size of the index.

1.1. GSearchIndex Document

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

1.1.1. Examples

{
  "@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
}

2. API Methods

2.1. GET Index Description

URL

/v1/index/<index_id>

Method

GET

Response Body

a GSearchIndex document describing the index, defined above

Note:

This API also supports use of an Index’s display_name at present. This behavior is considered deprecated, but may be useful for getting Index IDs if you only know the display name.

You should make sure no automated systems or scripts are relying on this behavior, however, so that when the deprecated behavior is removed, you do not experience issues.

2.1.1. Examples

  • with an id of 4de0e89e-a395-11e7-bc54-8c705ad34f60

curl -XGET 'https://search.api.globus.org/v1/index/4de0e89e-a395-11e7-bc54-8c705ad34f60'

© 2010- The University of Chicago Legal