database_clusters_info

Generated on 16 July 2024 from digitalocean.cloud version v0.6.0

Synopsis

List all of the database clusters on your account.
View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/databases_list_clusters.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices	Default	Comments
`client_override_options` (dict)			Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`module_override_options` (dict)			Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`state` (str)	present absent	present	State of the resource, `present` to create, `absent` to destroy.
`tag_name` (str)			Limits the results to database clusters with a specific tag.
`timeout` (int)		300	Polling timeout in seconds.
`token` (str)			DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Get database clusters
  digitalocean.cloud.database_clusters_info:
    token: "{{ token }}"

Return Values

Key Returned Description

Key	Returned	Description
`databases` (list)	always	Database clusters. Sample: [ { "connection": { "database": "", "host": "backend-do-user-19081923-0.db.ondigitalocean.com", "password": "wv78n3zpz42xezdk", "port": "25060,", "ssl": true, "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", "user": "doadmin" }, "created_at": "2019-01-11T18:37:36Z", "db_names": [ "defaultdb" ], "engine": "pg", "id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "maintenance_window": { "day": "saturday", "description": [ "Update TimescaleDB to version 1.2.1", "Upgrade to PostgreSQL 11.2 and 10.7 bugfix releases" ], "hour": "08:45:12", "pending": true }, "name": "backend", "num_nodes": 1, "private_connection": { "database": "", "host": "private-backend-do-user-19081923-0.db.ondigitalocean.com", "password": "wv78n3zpz42xezdk", "port": 25060, "ssl": true, "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", "user": "doadmin" }, "private_network_uuid": "d455e75d-4858-4eec-8c95-da2f0a5f93a7", "region": "nyc3", "size": "db-s-2vcpu-4gb", "status": "online", "tags": [ "production" ], "users": [ { "name": "doadmin", "password": "wv78n3zpz42xezdk", "role": "primary" } ], "version": 10 } ]
`error` (dict)	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` (str)	always	Database clusters information. Sample: `[ "Current database clusters", "No database clusters" ]`

databases
(list)

always

Database clusters.

Sample:

[
  {
    "connection": {
      "database": "",
      "host": "backend-do-user-19081923-0.db.ondigitalocean.com",
      "password": "wv78n3zpz42xezdk",
      "port": "25060,",
      "ssl": true,
      "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require",
      "user": "doadmin"
    },
    "created_at": "2019-01-11T18:37:36Z",
    "db_names": [
      "defaultdb"
    ],
    "engine": "pg",
    "id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
    "maintenance_window": {
      "day": "saturday",
      "description": [
        "Update TimescaleDB to version 1.2.1",
        "Upgrade to PostgreSQL 11.2 and 10.7 bugfix releases"
      ],
      "hour": "08:45:12",
      "pending": true
    },
    "name": "backend",
    "num_nodes": 1,
    "private_connection": {
      "database": "",
      "host": "private-backend-do-user-19081923-0.db.ondigitalocean.com",
      "password": "wv78n3zpz42xezdk",
      "port": 25060,
      "ssl": true,
      "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require",
      "user": "doadmin"
    },
    "private_network_uuid": "d455e75d-4858-4eec-8c95-da2f0a5f93a7",
    "region": "nyc3",
    "size": "db-s-2vcpu-4gb",
    "status": "online",
    "tags": [
      "production"
    ],
    "users": [
      {
        "name": "doadmin",
        "password": "wv78n3zpz42xezdk",
        "role": "primary"
      }
    ],
    "version": 10
  }
]

error
(dict)

failure

DigitalOcean API error.

Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
(str)

always

Database clusters information.

Sample:

[
  "Current database clusters",
  "No database clusters"
]

Was this page helpful? Thank you!

Give Feedback

In this article...

database_clusters_info

Synopsis

Requirements

Parameters

Examples

Return Values

We can't find any results for your search.