vultr.cloud.block_storage_info 模块 – 获取 Vultr 块存储信息

注意

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

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

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

要在剧本中使用它，请指定： vultr.cloud.block_storage_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` ← (默认)

备注 

注意

另请参阅 https://www.vultr.com/api/ 上的 API 文档。

示例 

- name: Get Vultr block_storage infos
  vultr.cloud.block_storage_info:
  register: result

- name: Print the infos
  ansible.builtin.debug:
    var: result.vultr_block_storage_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_block_storage_info 列表 / 元素=字符串	来自 Vultr API 的响应，作为列表。返回：成功
attached_to_instance 字符串	已附加卷的服务器实例的 ID。返回：成功示例： `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
cost 浮点数	卷的每月费用。返回：成功示例： `1.0`
date_created 字符串	创建卷的日期。返回：成功示例： `"2020-10-10T01:56:20+00:00"`
id 字符串	块存储卷的 ID。返回：成功示例： `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
label 字符串	卷的标签。返回：成功示例： `"my volume"`
mount_id 字符串	卷的挂载 ID。返回：成功示例： `"ewr-2f5d7a314fe44f"`
region 字符串	部署卷的区域。返回：成功示例： `"ews"`
size_gb 整数	关于卷大小（以 GB 为单位）的信息。返回：成功示例： `50`
status 字符串	关于卷部署状态的信息。返回：成功示例： `"active"`

作者

René Moser (@resmo)
Yanis Guenane (@Spredzy)