output_graylog_stream_archives

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

Overview

Name	output_graylog_stream_archives
Type	Resource
Id	ovh.dbaas_logs.output_graylog_stream_archives

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
archive_id	string (uuid)	Archive ID (wire: archiveId)
created_at	string (date-time)	Create date (wire: createdAt)
filename	string	Filename
md_5	string	MD5 checksum (wire: md5)
retrieval_delay	integer	Retrieval delay (wire: retrievalDelay)
retrieval_state	string	Retrieval state (sealed, unsealed, unsealing) (wire: retrievalState)
sha_256	string	sha256 checksum (wire: sha256)
size	integer	File size in bytes

list

Stream archive

Name	Datatype	Description
archive_id	string (uuid)	Archive ID (wire: archiveId)
created_at	string (date-time)	Create date (wire: createdAt)
filename	string	Filename
md_5	string	MD5 checksum (wire: md5)
retrieval_delay	integer	Retrieval delay (wire: retrievalDelay)
retrieval_state	string	Retrieval state (sealed, unsealed, unsealing) (wire: retrievalState)
sha_256	string	sha256 checksum (wire: sha256)
size	integer	File size in bytes

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	archive_id, service_name, stream_id		Returns the archive.
list	select	service_name, stream_id	x_pagination_mode	Returns the archives of the Logs Data Platform service.
url	exec	archiveId, serviceName, streamId		Creates a temporary URL to download the archive. The URL expires.

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"}})
archiveId	string (uuid)	Archive ID
archive_id	string (uuid)	Archive ID (wire: archiveId)
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
streamId	string (uuid)	Stream ID
stream_id	string (uuid)	Stream ID (wire: streamId)
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 archive.

SELECT
archive_id,
created_at,
filename,
md_5,
retrieval_delay,
retrieval_state,
sha_256,
size
FROM ovh.dbaas_logs.output_graylog_stream_archives
WHERE archive_id = '{{ archive_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND stream_id = '{{ stream_id }}' -- required
;

list

Returns the archives of the Logs Data Platform service.

SELECT
archive_id,
created_at,
filename,
md_5,
retrieval_delay,
retrieval_state,
sha_256,
size
FROM ovh.dbaas_logs.output_graylog_stream_archives
WHERE service_name = '{{ service_name }}' -- required
AND stream_id = '{{ stream_id }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

url

Creates a temporary URL to download the archive. The URL expires.

EXEC ovh.dbaas_logs.output_graylog_stream_archives.url 
@archiveId='{{ archiveId }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@streamId='{{ streamId }}' --required
;