output_graylog_stream_subscriptions

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

Overview

Name	output_graylog_stream_subscriptions
Type	Resource
Id	ovh.dbaas_logs.output_graylog_stream_subscriptions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
stream_id	string	Id of the destination log stream (wire: streamId)
subscription_id	string (uuid)	Subscription ID (wire: subscriptionId)
service_name	string	Name of the destination log service (wire: serviceName)
created_at	string (date-time)	Creation date of the subscription (wire: createdAt)
kind	string	Log kind name of this subscription
resource	object	Subscribed resource, where the logs come from
updated_at	string (date-time)	Last update date of the subscription (wire: updatedAt)

list

Log subscription

Name	Datatype	Description
stream_id	string	Id of the destination log stream (wire: streamId)
subscription_id	string (uuid)	Subscription ID (wire: subscriptionId)
service_name	string	Name of the destination log service (wire: serviceName)
created_at	string (date-time)	Creation date of the subscription (wire: createdAt)
kind	string	Log kind name of this subscription
resource	object	Subscribed resource, where the logs come from
updated_at	string (date-time)	Last update date of the subscription (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, stream_id, subscription_id		Returns the stream subscription.
list	select	service_name, stream_id	resource_name, resource_type, x_pagination_mode	Returns the stream subscriptions of the Logs Data Platform service.
delete	delete	service_name, stream_id, subscription_id		Deletes the stream subscription.

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"}})
service_name	string	Service name (wire: serviceName)
stream_id	string (uuid)	Stream ID (wire: streamId)
subscription_id	string (uuid)	Subscription ID (wire: subscriptionId)
resource_name	string	Filter by resource name (like) (wire: resourceName)
resource_type	string	Filter by resource type (like) (wire: resourceType)
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 stream subscription.

SELECT
stream_id,
subscription_id,
service_name,
created_at,
kind,
resource,
updated_at
FROM ovh.dbaas_logs.output_graylog_stream_subscriptions
WHERE service_name = '{{ service_name }}' -- required
AND stream_id = '{{ stream_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns the stream subscriptions of the Logs Data Platform service.

SELECT
stream_id,
subscription_id,
service_name,
created_at,
kind,
resource,
updated_at
FROM ovh.dbaas_logs.output_graylog_stream_subscriptions
WHERE service_name = '{{ service_name }}' -- required
AND stream_id = '{{ stream_id }}' -- required
AND resource_name = '{{ resource_name }}'
AND resource_type = '{{ resource_type }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Deletes the stream subscription.

DELETE FROM ovh.dbaas_logs.output_graylog_stream_subscriptions
WHERE service_name = '{{ service_name }}' --required
AND stream_id = '{{ stream_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;