Clever Cloud ListDrains
CertifiedList log drains configured for a Clever Cloud application
Clever Cloud ListDrains
List log drains configured for a Clever Cloud application
Lists the log drains forwarding an application's logs to an external observability platform, via GET /v4/drains/organisations/{organisationId}/applications/{applicationId}/drains.
organisationId is always required here: unlike the rest of this plugin, the v4 drains API has no /self shortcut for personal accounts.
type: io.kestra.plugin.clevercloud.logs.ListDrainsExamples
List log drains for an application
id: list_log_drains
namespace: company.team
tasks:
- id: list_drains
type: io.kestra.plugin.clevercloud.logs.ListDrains
apiToken: "{{ secret('CC_API_TOKEN') }}"
organisationId: "orga_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
applicationId: "app_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Properties
apiToken *Requiredstring
API token
Bearer token for the Clever Cloud API. Store as a Kestra secret and reference with {{ secret('CC_API_TOKEN') }}.
applicationId *Requiredstring
Application ID
organisationId *Requiredstring
Organisation ID
The Clever Cloud organisation or personal account ID that owns the application (orga_xxx or user_xxx). Unlike the rest of this plugin, the v4 logs and log drain APIs have no /self shortcut, so this is always required.
fetchType string
FETCHSTOREFETCHFETCH_ONENONEHow to fetch the results
FETCH returns all items, FETCH_ONE returns the first item, STORE saves them to internal storage as an ion file, NONE returns only the count.
options Non-dynamic
HTTP client options
Optional HttpConfiguration applied to every Clever Cloud API call, including timeouts and proxy settings.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
Outputs
drain
First log drain returned by the API
Populated when fetchType is FETCH_ONE, null if no drain was found.
io.kestra.plugin.clevercloud.logs.model.Drain
io.kestra.plugin.clevercloud.logs.model.Drain-Backlog
io.kestra.plugin.clevercloud.logs.model.Drain-Execution
io.kestra.plugin.clevercloud.logs.model.Drain-Recipient
io.kestra.plugin.clevercloud.logs.model.Drain-Status
drains array
List of log drains
Populated when fetchType is FETCH.
io.kestra.plugin.clevercloud.logs.model.Drain
io.kestra.plugin.clevercloud.logs.model.Drain-Backlog
io.kestra.plugin.clevercloud.logs.model.Drain-Execution
io.kestra.plugin.clevercloud.logs.model.Drain-Recipient
io.kestra.plugin.clevercloud.logs.model.Drain-Status
total integer
0Total number of log drains returned
uri string
uriURI of the stored log drains
Populated when fetchType is STORE, points to an ion file in Kestra internal storage.
