pydo.databases.get_logsink()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To get a logsink for a database cluster, send a GET request to /v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

Parameters

Name	Type	Required	Description	Default Value
`database_cluster_uuid`	string	True	A unique identifier for a database cluster.
`logsink_id`	string	True	A unique identifier for a logsink of a database cluster

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

201
401
404
429
500
default

A JSON object with a key of sink.

Click to expand an example response for Create an opensearch logsink.

{
  "value": {
    "sink": {
      "sink_id": "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7",
      "sink_name": "logs-sink",
      "sink_type": "opensearch",
      "config": {
        "url": "https://user:[email protected]:25060",
        "index_prefix": "opensearch-logs",
        "index_days_max": 5
      }
    }
  }
}

Click to expand an example response for Create an elasticsearch logsink.

{
  "value": {
    "sink": {
      "sink_id": "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7",
      "sink_name": "logs-sink",
      "sink_type": "elasticsearch",
      "config": {
        "url": "https://user:[email protected]:25060",
        "index_prefix": "elasticsearch-logs",
        "index_days_max": 5
      }
    }
  }
}

Click to expand an example response for Create a rsyslog logsink.

{
  "value": {
    "sink": {
      "sink_id": "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7",
      "sink_name": "logs-sink",
      "sink_type": "rsyslog",
      "config": {
        "server": "192.168.0.1",
        "port": 514,
        "tls": false,
        "format": "rfc5424"
      }
    }
  }
}

Unauthorized