inputs

Creates, updates, deletes, gets or lists an inputs resource.

Overview

Name	inputs
Type	Resource
Id	ovh.dbaas_logs.inputs

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
engine_id	string (uuid)	Input engine ID (wire: engineId)
input_id	string (uuid)	Input ID (wire: inputId)
stream_id	string (uuid)	Associated Graylog stream (wire: streamId)
allowed_networks	array	IP blocks (wire: allowedNetworks)
autoscale	boolean	Whether the workload is auto-scaled
created_at	string (date-time)	Input creation (wire: createdAt)
description	string	Input description
exposed_port	string	Port (wire: exposedPort)
hostname	string	Hostname
is_restart_required	boolean	Indicate if input need to be restarted (wire: isRestartRequired)
max_scale_instance	integer	Maximum number of instances in auto-scaled mode (wire: maxScaleInstance)
min_scale_instance	integer	Minimum number of instances in auto-scaled mode (wire: minScaleInstance)
nb_instance	integer	Number of instance running (wire: nbInstance)
public_address	string	Input IP address (wire: publicAddress)
scaling_notify_enabled	boolean	If set, notify when scaling happens (wire: scalingNotifyEnabled)
ssl_certificate	string	Input SSL certificate (wire: sslCertificate)
status	string	init: configuration required, pending: ready to start, running: available (INIT, PENDING, PROCESSING, RUNNING)
title	string	Input title
updated_at	string (date-time)	Input last update (wire: updatedAt)

list

Input

Name	Datatype	Description
engine_id	string (uuid)	Input engine ID (wire: engineId)
input_id	string (uuid)	Input ID (wire: inputId)
stream_id	string (uuid)	Associated Graylog stream (wire: streamId)
allowed_networks	array	IP blocks (wire: allowedNetworks)
autoscale	boolean	Whether the workload is auto-scaled
created_at	string (date-time)	Input creation (wire: createdAt)
description	string	Input description
exposed_port	string	Port (wire: exposedPort)
hostname	string	Hostname
is_restart_required	boolean	Indicate if input need to be restarted (wire: isRestartRequired)
max_scale_instance	integer	Maximum number of instances in auto-scaled mode (wire: maxScaleInstance)
min_scale_instance	integer	Minimum number of instances in auto-scaled mode (wire: minScaleInstance)
nb_instance	integer	Number of instance running (wire: nbInstance)
public_address	string	Input IP address (wire: publicAddress)
scaling_notify_enabled	boolean	If set, notify when scaling happens (wire: scalingNotifyEnabled)
ssl_certificate	string	Input SSL certificate (wire: sslCertificate)
status	string	init: configuration required, pending: ready to start, running: available (INIT, PENDING, PROCESSING, RUNNING)
title	string	Input title
updated_at	string (date-time)	Input last update (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	input_id, service_name		Returns the data-gathering tool.
list	select	service_name	title_pattern, x_pagination_mode	Returns the data-gathering tools of the Logs Data Platform service.
create	insert	service_name, description, engine_id, stream_id, title		Creates a data-gathering tool on the Logs Data Platform service.
update	update	input_id, service_name, description, engine_id, stream_id, title		Updates the data-gathering tool.
delete	delete	input_id, service_name		Deletes the data-gathering tool.
configtest	exec	inputId, serviceName		Checks the data-gathering tool configuration and returns a test result.
end	exec	inputId, serviceName		Stops the data-gathering tool.
logs_url	exec	inputId, serviceName		Creates a temporary URL to read the logs of a data-gathering tool. The URL expires.
restart	exec	inputId, serviceName		Restarts the data-gathering tool.
start	exec	inputId, serviceName		Starts the data-gathering tool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
inputId	string (uuid)	Input ID
input_id	string (uuid)	Input ID (wire: inputId)
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
title_pattern	string	Filter by title (like) (wire: titlePattern)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Returns the data-gathering tool.

SELECT
engine_id,
input_id,
stream_id,
allowed_networks,
autoscale,
created_at,
description,
exposed_port,
hostname,
is_restart_required,
max_scale_instance,
min_scale_instance,
nb_instance,
public_address,
scaling_notify_enabled,
ssl_certificate,
status,
title,
updated_at
FROM ovh.dbaas_logs.inputs
WHERE input_id = '{{ input_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the data-gathering tools of the Logs Data Platform service.

SELECT
engine_id,
input_id,
stream_id,
allowed_networks,
autoscale,
created_at,
description,
exposed_port,
hostname,
is_restart_required,
max_scale_instance,
min_scale_instance,
nb_instance,
public_address,
scaling_notify_enabled,
ssl_certificate,
status,
title,
updated_at
FROM ovh.dbaas_logs.inputs
WHERE service_name = '{{ service_name }}' -- required
AND title_pattern = '{{ title_pattern }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Creates a data-gathering tool on the Logs Data Platform service.

INSERT INTO ovh.dbaas_logs.inputs (
allowed_networks,
autoscale,
description,
engine_id,
exposed_port,
max_scale_instance,
min_scale_instance,
nb_instance,
scaling_notify_enabled,
stream_id,
title,
service_name
)
SELECT 
'{{ allowed_networks }}',
{{ autoscale }},
'{{ description }}' /* required */,
'{{ engine_id }}' /* required */,
'{{ exposed_port }}',
{{ max_scale_instance }},
{{ min_scale_instance }},
{{ nb_instance }},
{{ scaling_notify_enabled }},
'{{ stream_id }}' /* required */,
'{{ title }}' /* required */,
'{{ service_name }}'
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: inputs
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the inputs resource.
  - name: allowed_networks
    value:
      - "{{ allowed_networks }}"
    description: |
      IP blocks
  - name: autoscale
    value: {{ autoscale }}
    description: |
      Whether the workload is auto-scaled
  - name: description
    value: "{{ description }}"
    description: |
      Description
  - name: engine_id
    value: "{{ engine_id }}"
    description: |
      Engine ID
  - name: exposed_port
    value: "{{ exposed_port }}"
    description: |
      Exposed port
  - name: max_scale_instance
    value: {{ max_scale_instance }}
    description: |
      Maximum number of instances in auto-scaled mode
  - name: min_scale_instance
    value: {{ min_scale_instance }}
    description: |
      Minimum number of instances in auto-scaled mode
  - name: nb_instance
    value: {{ nb_instance }}
    description: |
      Number of instance running
  - name: scaling_notify_enabled
    value: {{ scaling_notify_enabled }}
    description: |
      If set, notify when scaling happens
  - name: stream_id
    value: "{{ stream_id }}"
    description: |
      Stream ID
  - name: title
    value: "{{ title }}"
    description: |
      Title

UPDATE examples

update

Updates the data-gathering tool.

UPDATE ovh.dbaas_logs.inputs
SET 
allowed_networks = '{{ allowed_networks }}',
autoscale = {{ autoscale }},
description = '{{ description }}',
engine_id = '{{ engine_id }}',
exposed_port = '{{ exposed_port }}',
max_scale_instance = {{ max_scale_instance }},
min_scale_instance = {{ min_scale_instance }},
nb_instance = {{ nb_instance }},
scaling_notify_enabled = {{ scaling_notify_enabled }},
stream_id = '{{ stream_id }}',
title = '{{ title }}'
WHERE 
input_id = '{{ input_id }}' --required
AND service_name = '{{ service_name }}' --required
AND description = '{{ description }}' --required
AND engine_id = '{{ engine_id }}' --required
AND stream_id = '{{ stream_id }}' --required
AND title = '{{ title }}' --required
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at;

DELETE examples

delete

Deletes the data-gathering tool.

DELETE FROM ovh.dbaas_logs.inputs
WHERE input_id = '{{ input_id }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

configtest

Checks the data-gathering tool configuration and returns a test result.

EXEC ovh.dbaas_logs.inputs.configtest 
@inputId='{{ inputId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

end

Stops the data-gathering tool.

EXEC ovh.dbaas_logs.inputs.end 
@inputId='{{ inputId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

logs_url

Creates a temporary URL to read the logs of a data-gathering tool. The URL expires.

EXEC ovh.dbaas_logs.inputs.logs_url 
@inputId='{{ inputId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

restart

Restarts the data-gathering tool.

EXEC ovh.dbaas_logs.inputs.restart 
@inputId='{{ inputId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

start

Starts the data-gathering tool.

EXEC ovh.dbaas_logs.inputs.start 
@inputId='{{ inputId }}' --required, 
@serviceName='{{ serviceName }}' --required
;