libcloud.common.digitalocean module
Common settings and connection objects for DigitalOcean Cloud
- class libcloud.common.digitalocean.DigitalOceanBaseDriver(key, secret=None, api_version='v2', **kwargs)[source]
Bases:
BaseDriverDigitalOcean BaseDriver
- Parameters:
key (
str) – API key or username to be used (required)secret (
str) – Secret password to be used (required)secure (
bool) – Whether to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default.host (
str) – Override hostname used for connections.port (
int) – Override port used for connections.api_version (
str) – Optional API version. Only used by drivers which support multiple API versions.region (
str) – Optional driver region. Only used by drivers which support multiple regions.
- Return type:
None
- name = 'DigitalOcean'
- website = 'https://www.digitalocean.com'
- class libcloud.common.digitalocean.DigitalOcean_v2_Connection(key, secure=True, host=None, port=None, url=None, timeout=None, proxy_url=None, backoff=None, retry_delay=None)[source]
Bases:
ConnectionKeyConnection class for the DigitalOcean (v2) driver.
Initialize user_id and key; set secure to an
intbased on passed value.- add_default_headers(headers)[source]
Add headers that are necessary for every request
This method adds
tokento the request.
- add_default_params(params)[source]
Add parameters that are necessary for every request
This method adds
per_pageto the request to reduce the total number of paginated requests to the API.
- responseCls
alias of
DigitalOcean_v2_Response
- class libcloud.common.digitalocean.DigitalOcean_v2_Response(response, connection)[source]
Bases:
JsonResponse- Parameters:
response (
httplib.HTTPResponse) – HTTP response object. (optional)connection (
Connection) – Parent connection object.
- parse_error()[source]
Parse the error messages.
Override in a provider’s subclass.
- Returns:
Parsed error.
- Return type:
str
- success()[source]
Determine if our request was successful.
The meaning of this can be arbitrary; did we receive OK status? Did the node get created? Were we authenticated?
- Return type:
bool- Returns:
TrueorFalse
- valid_response_codes = [<HTTPStatus.OK: 200>, <HTTPStatus.ACCEPTED: 202>, <HTTPStatus.CREATED: 201>, <HTTPStatus.NO_CONTENT: 204>]