community.digitalocean.digital_ocean_balance_info 模块 – 显示 DigitalOcean 客户余额

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.digitalocean

要在 playbook 中使用它,请指定:community.digitalocean.digital_ocean_balance_info

community.digitalocean 1.2.0 中的新增功能

概要

  • 此模块可用于显示 DigitalOcean 客户余额。

参数

参数

注释

baseurl

字符串

DigitalOcean API 基址 URL。

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

oauth_token

别名:api_token

字符串

DigitalOcean OAuth 令牌。

可以使用其他几个环境变量来提供此值。

例如:- DO_API_TOKENDO_API_KEYDO_OAUTH_TOKENOAUTH_TOKEN

timeout

整数

用于轮询 DigitalOcean API 的超时时间(秒)。

默认值: 30

validate_certs

布尔值

如果设置为 no,则不会验证 SSL 证书。

此设置应仅在使用自签名证书的个人控制站点上设置为 no

选项

  • false

  • true ← (默认值)

示例

- name: Display DigitalOcean customer balance
  community.digitalocean.digital_ocean_balance_info:
    oauth_token: "{{ oauth_token }}"

返回值

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

描述

data

字典

DigitalOcean 客户余额

返回:成功

示例: {"account_balance": "-27.52", "generated_at": "2021-04-11T05:08:24Z", "month_to_date_balance": "-27.40", "month_to_date_usage": "0.00"}

作者

  • Mark Mercado (@mamercad)