vultr.cloud.region_info 模块 – 收集关于 Vultr 地区的信息

注意

此模块是 vultr.cloud 集合(版本 1.13.0)的一部分。

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

要安装它,请使用:ansible-galaxy collection install vultr.cloud

要在 playbook 中使用它,请指定:vultr.cloud.region_info

vultr.cloud 1.0.0 中的新功能

概要

  • 收集有关可用于启动服务器的地区的信息。

参数

参数

注释

api_endpoint

字符串

API 端点的 URL(不带尾部斜杠)。

备用环境变量 VULTR_API_ENDPOINT

默认值: "https://api.vultr.com/v2"

api_key

字符串 / 必需

Vultr API 的 API 密钥。

备用环境变量 VULTR_API_KEY

api_retries

整数

在 Vultr API 返回 HTTP 错误代码的情况下,例如 - 429 请求过多 - 500 内部服务器错误 - 504 网关超时,重试的次数。

备用环境变量 VULTR_API_RETRIES

默认值: 5

api_retry_max_delay

整数

重试回退延迟时间(秒)呈指数增长,直到达到此最大值(秒)。

备用环境变量 VULTR_API_RETRY_MAX_DELAY

默认值: 12

api_timeout

整数

到 Vultr API 的 HTTP 超时时间。

备用环境变量 VULTR_API_TIMEOUT

默认值: 180

validate_certs

布尔值

验证 Vultr API 的 SSL 证书。

选项

  • false

  • true ← (默认)

注释

注意

示例

- name: Gather Vultr regions information
  vultr.cloud.region_info:
  register: result

- name: Print the gathered information
  ansible.builtin.debug:
    var: result.vultr_region_info

返回值

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

描述

vultr_api

字典

来自 Vultr API 的响应,其中包含一些添加/修改。

已返回: 成功

api_endpoint

字符串

用于 API 请求的端点。

已返回: 成功

示例: "https://api.vultr.com/v2"

api_retries

整数

API 请求的最大重试次数。

已返回: 成功

示例: 5

api_retry_max_delay

整数

重试之间指数回退延迟(秒),直到达到此最大延迟值。

已返回: 成功

示例: 12

api_timeout

整数

用于 API 请求的超时时间。

已返回: 成功

示例: 60

vultr_region_info

列表 / 元素=字符串

来自 Vultr API 的响应。

已返回: 成功

示例: [{"block_storage": false, "continent": "Europe", "country": "GB", "ddos_protection": true, "id": 8, "name": "London", "regioncode": "LHR", "state": ""}]

作者

  • Yanis Guenane (@Spredzy)

  • René Moser (@resmo)