Skip to content

Latest commit

 

History

History
421 lines (277 loc) · 10.8 KB

SystemindexerindicesApi.md

File metadata and controls

421 lines (277 loc) · 10.8 KB
Raw

graylog.SystemindexerindicesApi

All URIs are relative to http://log.ano.yumimobi.com/api

Method HTTP request Description
all GET /system/indexer/indices List all open, closed and reopened indices.
close POST /system/indexer/indices/{index}/close Close an index. This will also trigger an index ranges rebuild job.
closed GET /system/indexer/indices/closed Get a list of closed indices that can be reopened.
delete DELETE /system/indexer/indices/{index} Delete an index. This will also trigger an index ranges rebuild job.
multiple POST /system/indexer/indices/multiple Get information of all specified indices and their shards.
open GET /system/indexer/indices/open Get information of all open indices managed by Graylog and their shards.
reopen POST /system/indexer/indices/{index}/reopen Reopen a closed index. This will also trigger an index ranges rebuild job.
reopened GET /system/indexer/indices/reopened Get a list of reopened indices, which will not be cleaned by retention cleaning
single GET /system/indexer/indices/{index} Get information of an index and its shards.

all

AllIndices all()

List all open, closed and reopened indices.

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SystemindexerindicesApi()

try: 
    # List all open, closed and reopened indices.
    api_response = api_instance.all()
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SystemindexerindicesApi->all: %s\n" % e

Parameters

This endpoint does not need any parameter.

Return type

AllIndices

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

close

close(index)

Close an index. This will also trigger an index ranges rebuild job.

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SystemindexerindicesApi()
index = graylog.Object() # Object | 

try: 
    # Close an index. This will also trigger an index ranges rebuild job.
    api_instance.close(index)
except ApiException as e:
    print "Exception when calling SystemindexerindicesApi->close: %s\n" % e

Parameters

Name Type Description Notes
index Object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

closed

ClosedIndices closed()

Get a list of closed indices that can be reopened.

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SystemindexerindicesApi()

try: 
    # Get a list of closed indices that can be reopened.
    api_response = api_instance.closed()
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SystemindexerindicesApi->closed: %s\n" % e

Parameters

This endpoint does not need any parameter.

Return type

ClosedIndices

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

delete(index)

Delete an index. This will also trigger an index ranges rebuild job.

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SystemindexerindicesApi()
index = graylog.Object() # Object | 

try: 
    # Delete an index. This will also trigger an index ranges rebuild job.
    api_instance.delete(index)
except ApiException as e:
    print "Exception when calling SystemindexerindicesApi->delete: %s\n" % e

Parameters

Name Type Description Notes
index Object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

multiple

Map multiple(requested_indices)

Get information of all specified indices and their shards.

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SystemindexerindicesApi()
requested_indices = graylog.IndicesReadRequest() # IndicesReadRequest | 

try: 
    # Get information of all specified indices and their shards.
    api_response = api_instance.multiple(requested_indices)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SystemindexerindicesApi->multiple: %s\n" % e

Parameters

Name Type Description Notes
requested_indices IndicesReadRequest

Return type

Map

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

open

OpenIndicesInfo open()

Get information of all open indices managed by Graylog and their shards.

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SystemindexerindicesApi()

try: 
    # Get information of all open indices managed by Graylog and their shards.
    api_response = api_instance.open()
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SystemindexerindicesApi->open: %s\n" % e

Parameters

This endpoint does not need any parameter.

Return type

OpenIndicesInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reopen

reopen(index)

Reopen a closed index. This will also trigger an index ranges rebuild job.

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SystemindexerindicesApi()
index = graylog.Object() # Object | 

try: 
    # Reopen a closed index. This will also trigger an index ranges rebuild job.
    api_instance.reopen(index)
except ApiException as e:
    print "Exception when calling SystemindexerindicesApi->reopen: %s\n" % e

Parameters

Name Type Description Notes
index Object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reopened

ClosedIndices reopened()

Get a list of reopened indices, which will not be cleaned by retention cleaning

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SystemindexerindicesApi()

try: 
    # Get a list of reopened indices, which will not be cleaned by retention cleaning
    api_response = api_instance.reopened()
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SystemindexerindicesApi->reopened: %s\n" % e

Parameters

This endpoint does not need any parameter.

Return type

ClosedIndices

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

single

IndexInfo single(index)

Get information of an index and its shards.

Example

import time
import graylog
from graylog.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = graylog.SystemindexerindicesApi()
index = graylog.Object() # Object | 

try: 
    # Get information of an index and its shards.
    api_response = api_instance.single(index)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SystemindexerindicesApi->single: %s\n" % e

Parameters

Name Type Description Notes
index Object

Return type

IndexInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]