Class: IonoscloudDbaasMongo::LogsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud-dbaas-mongo/api/logs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LogsApi

Returns a new instance of LogsApi.



19
20
21
 
# File 'lib/ionoscloud-dbaas-mongo/api/logs_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ionoscloud-dbaas-mongo/api/logs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#clusters_logs_get(cluster_id, opts = {}) ⇒ ClusterLogs

Get logs of your cluster Retrieves MongoDB logs based on the given parameters.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start (Time) —

    The start time for the query in RFC3339 format. Must not be more than 30 days ago but before the end parameter. The default is 30 days ago.

  • :_end (Time) —

    The end time for the query in RFC3339 format. Must not be greater than now. The default is the current timestamp.

  • :direction (String) —

    The direction in which to scan through the logs. The logs are returned in order of the direction. (default to ‘BACKWARD’)

  • :limit (Integer) —

    The maximal number of log lines to return. If the limit is reached then log lines will be cut at the end (respecting the scan direction). (default to 100)

Returns:



31
32
33
34
 
# File 'lib/ionoscloud-dbaas-mongo/api/logs_api.rb', line 31

def clusters_logs_get(cluster_id, opts = {})
  data, _status_code, _headers = clusters_logs_get_with_http_info(cluster_id, opts)
  data
end

#clusters_logs_get_with_http_info(cluster_id, opts = {}) ⇒ Array<(ClusterLogs, Integer, Hash)>

Get logs of your cluster Retrieves MongoDB logs based on the given parameters.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start (Time) —

    The start time for the query in RFC3339 format. Must not be more than 30 days ago but before the end parameter. The default is 30 days ago.

  • :_end (Time) —

    The end time for the query in RFC3339 format. Must not be greater than now. The default is the current timestamp.

  • :direction (String) —

    The direction in which to scan through the logs. The logs are returned in order of the direction.

  • :limit (Integer) —

    The maximal number of log lines to return. If the limit is reached then log lines will be cut at the end (respecting the scan direction).

Returns:

  • (Array<(ClusterLogs, Integer, Hash)>) —

    ClusterLogs data, response status code and response headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/ionoscloud-dbaas-mongo/api/logs_api.rb', line 45

def clusters_logs_get_with_http_info(cluster_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsApi.clusters_logs_get ...'
  end
  # verify the required parameter 'cluster_id' is set
  if @api_client.config.client_side_validation && cluster_id.nil?
    fail ArgumentError, "Missing the required parameter 'cluster_id' when calling LogsApi.clusters_logs_get"
  end
  allowable_values = ["BACKWARD", "FORWARD"]
  if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
    fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling LogsApi.clusters_logs_get, must be smaller than or equal to 5000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling LogsApi.clusters_logs_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/clusters/{clusterId}/logs'.sub('{' + 'clusterId' + '}', CGI.escape(cluster_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?
  query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ClusterLogs'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

  new_options = opts.merge(
    :operation => :"LogsApi.clusters_logs_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LogsApi#clusters_logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end