uptime_checks_state_info

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

Synopsis

Requirements

  • pydo >= 0.1.6
  • azure-core >= 1.26.1

Parameters

Parameter Choices Default Comments
check_id
(str)		 The Uptime check UUID.
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.
name
(str)		 The Uptime check name. Will fail if there is more than one check with this name.
state
(str)
  • present
 present Only present is supported which will return the state of the Uptime check.
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 Uptime check state by ID
  digitalocean.cloud.uptime_checks_state_info:
    token: "{{ token }}"
    check_id: 4de7ac8b-495b-4884-9a69-1050c6793cd6

- name: Get Uptime check state by name
  digitalocean.cloud.uptime_checks_state_info:
    token: "{{ token }}"
    name: my-check

Return Values

Key Returned Description
error
(dict)		 failure DigitalOcean API error.

Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}
msg
(str)		 always Uptime checks result information.

Sample:

[
  "Current Uptime check 4de7ac8b-495b-4884-9a69-1050c6793cd6 state",
  "No Uptime check 4de7ac8b-495b-4884-9a69-1050c6793cd6 state",
  "No Uptime check named my-check",
  "Current Uptime check named my-check state",
  "Multiple Uptime checks named my-check"
]
state
(dict)		 always Uptime check state.

Sample:

{
  "state": {
    "previous_outage": {
      "duration_seconds": 120,
      "ended_at": "2022-03-17T18:06:55Z",
      "region": "us_east",
      "started_at": "2022-03-17T18:04:55Z"
    },
    "regions": {
      "eu_west": {
        "status": "UP",
        "status_changed_at": "2022-03-17T22:28:51Z",
        "thirty_day_uptime_percentag\"": 97.99
      },
      "us_east": {
        "status": "UP",
        "status_changed_at": "2022-03-17T22:28:51Z",
        "thirty_day_uptime_percentage": 97.99
      }
    }
  }
}
Control Panel Blog Pricing Careers Terms Privacy Status API Docs Tutorials Support