community.general.scaleway_database_backup 模块 – Scaleway 数据库备份管理模块

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定： community.general.scaleway_database_backup。

community.general 1.2.0 中的新增功能

概要 

此模块管理 Scaleway 帐户上的数据库备份 https://developer.scaleway.com.

参数 

参数	注释
api_timeout 别名：timeout 整数	到 Scaleway API 的 HTTP 超时时间（以秒为单位）。默认值： `30`
api_token 别名：oauth_token 字符串 / 必需	Scaleway OAuth 令牌。
api_url 别名：base_url 字符串	Scaleway API URL。默认值： `"https://api.scaleway.com"`
database_name 字符串	用于标识数据库的名称。对于 `present` 和 `restored` 状态是必需的。当 `state=absent` 或 `state=exported` 时忽略。
expires_at 字符串	数据库备份的过期日期时间（ISO 8601 格式）。当 `state=absent`，`state=exported` 或 `state=restored` 时忽略。
id 字符串	用于标识数据库备份的 UUID。对于 `absent`、`exported` 和 `restored` 状态是必需的。
instance_id 字符串	与数据库备份关联的实例的 UUID。对于 `present` 和 `restored` 状态是必需的。当 `state=absent` 或 `state=exported` 时忽略。
name 字符串	用于标识数据库备份的名称。对于 `present` 状态是必需的。当 `state=absent`，`state=exported` 或 `state=restored` 时忽略。
query_parameters 字典	传递给查询字符串的参数列表。默认值： `{}`
region 字符串 / 必需	要使用的 Scaleway 区域（例如 `fr-par`）。选项 `"fr-par"` `"nl-ams"` `"pl-waw"`
state 字符串	指示所需数据库备份状态。 `present` 创建备份。 `absent` 删除备份。 `exported` 为备份创建一个下载链接。 `restored` 将备份还原到新的数据库。选项 `"present"` ← (默认) `"absent"` `"exported"` `"restored"`
validate_certs 布尔值	验证 Scaleway API 的 SSL 证书。选项 `false` `true` ← (默认)
wait 布尔值	等待实例达到其所需状态后再返回。选项 `false` ← (默认) `true`
wait_sleep_time 整数	每次尝试检查备份状态之前等待的时间。默认值： `3`
wait_timeout 整数	等待备份达到预期状态的时间。默认值： `300`

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 `check_mode` 模式下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	在 diff 模式下，将返回有关已更改内容（或在 `check_mode` 模式下可能需要更改的内容）的详细信息。

备注 

注意

另请参阅 https://developer.scaleway.com/ 上的 API 文档。
如果模块中未设置 api_token，则可以按优先级递减的顺序使用以下环境变量：SCW_TOKEN，SCW_API_KEY，SCW_OAUTH_TOKEN 或 SCW_API_TOKEN。
如果要使用不同的 api_url，也可以设置 SCW_API_URL 环境变量。

示例 

- name: Create a backup
  community.general.scaleway_database_backup:
      name: 'my_backup'
      state: present
      region: 'fr-par'
      database_name: 'my-database'
      instance_id: '50968a80-2909-4e5c-b1af-a2e19860dddb'

- name: Export a backup
  community.general.scaleway_database_backup:
      id: '6ef1125a-037e-494f-a911-6d9c49a51691'
      state: exported
      region: 'fr-par'

- name: Restore a backup
  community.general.scaleway_database_backup:
      id: '6ef1125a-037e-494f-a911-6d9c49a51691'
      state: restored
      region: 'fr-par'
      database_name: 'my-new-database'
      instance_id: '50968a80-2909-4e5c-b1af-a2e19860dddb'

- name: Remove a backup
  community.general.scaleway_database_backup:
      id: '6ef1125a-037e-494f-a911-6d9c49a51691'
      state: absent
      region: 'fr-par'

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

metadata

字典

备份元数据。

返回：当 state=present、state=exported 或 state=restored 时

示例：{"metadata": {"created_at": "2020-08-06T12:42:05.631049Z", "database_name": "my-database", "download_url": null, "download_url_expires_at": null, "expires_at": null, "id": "a15297bd-0c4a-4b4f-8fbb-b36a35b7eb07", "instance_id": "617be32e-6497-4ed7-b4c7-0ee5a81edf49", "instance_name": "my-instance", "name": "backup_name", "region": "fr-par", "size": 600000, "status": "ready", "updated_at": "2020-08-06T12:42:10.581649Z"}}

作者

Guillaume Rodriguez (@guillaume_ro_fr)