1and1 1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +2 -0
- data/1and1-1.0.gem +0 -0
- data/1and1.gemspec +20 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +499 -0
- data/docs/reference.md +2447 -0
- data/examples/dvd_examples.rb +15 -0
- data/examples/example_app.rb +100 -0
- data/examples/firewall_examples.rb +137 -0
- data/examples/image_examples.rb +48 -0
- data/examples/load_balancer_examples.rb +145 -0
- data/examples/log_examples.rb +15 -0
- data/examples/monitoring_center_examples.rb +15 -0
- data/examples/monitoring_policy_examples.rb +343 -0
- data/examples/private_network_examples.rb +86 -0
- data/examples/public_ip_examples.rb +42 -0
- data/examples/role_examples.rb +113 -0
- data/examples/server_appliance_examples.rb +15 -0
- data/examples/server_examples.rb +438 -0
- data/examples/shared_storage_examples.rb +108 -0
- data/examples/usage_examples.rb +6 -0
- data/examples/user_examples.rb +113 -0
- data/examples/vpn_examples.rb +56 -0
- data/lib/1and1/datacenter.rb +73 -0
- data/lib/1and1/dvd.rb +73 -0
- data/lib/1and1/firewall.rb +427 -0
- data/lib/1and1/image.rb +231 -0
- data/lib/1and1/load_balancer.rb +448 -0
- data/lib/1and1/log.rb +77 -0
- data/lib/1and1/monitoring_center.rb +84 -0
- data/lib/1and1/monitoring_policy.rb +598 -0
- data/lib/1and1/oneandone.rb +57 -0
- data/lib/1and1/ping.rb +41 -0
- data/lib/1and1/ping_auth.rb +41 -0
- data/lib/1and1/pricing.rb +41 -0
- data/lib/1and1/private_network.rb +333 -0
- data/lib/1and1/public_ip.rb +192 -0
- data/lib/1and1/role.rb +381 -0
- data/lib/1and1/server.rb +1208 -0
- data/lib/1and1/server_appliance.rb +73 -0
- data/lib/1and1/shared_storage.rb +379 -0
- data/lib/1and1/usage.rb +58 -0
- data/lib/1and1/user.rb +374 -0
- data/lib/1and1/vpn.rb +249 -0
- data/lib/oneandone.rb +27 -0
- data/sphinx/Makefile +192 -0
- data/sphinx/_build/doctrees/dvds.doctree +0 -0
- data/sphinx/_build/doctrees/environment.pickle +0 -0
- data/sphinx/_build/doctrees/firewalls.doctree +0 -0
- data/sphinx/_build/doctrees/images.doctree +0 -0
- data/sphinx/_build/doctrees/index.doctree +0 -0
- data/sphinx/_build/doctrees/load_balancers.doctree +0 -0
- data/sphinx/_build/doctrees/logs.doctree +0 -0
- data/sphinx/_build/doctrees/monitoring_center.doctree +0 -0
- data/sphinx/_build/doctrees/monitoring_policies.doctree +0 -0
- data/sphinx/_build/doctrees/private_networks.doctree +0 -0
- data/sphinx/_build/doctrees/public_ips.doctree +0 -0
- data/sphinx/_build/doctrees/server_appliances.doctree +0 -0
- data/sphinx/_build/doctrees/servers.doctree +0 -0
- data/sphinx/_build/doctrees/shared_storages.doctree +0 -0
- data/sphinx/_build/doctrees/usages.doctree +0 -0
- data/sphinx/_build/doctrees/users.doctree +0 -0
- data/sphinx/_build/html/.buildinfo +4 -0
- data/sphinx/_build/html/_sources/dvds.txt +42 -0
- data/sphinx/_build/html/_sources/firewalls.txt +189 -0
- data/sphinx/_build/html/_sources/images.txt +101 -0
- data/sphinx/_build/html/_sources/index.txt +499 -0
- data/sphinx/_build/html/_sources/load_balancers.txt +231 -0
- data/sphinx/_build/html/_sources/logs.txt +55 -0
- data/sphinx/_build/html/_sources/monitoring_center.txt +55 -0
- data/sphinx/_build/html/_sources/monitoring_policies.txt +288 -0
- data/sphinx/_build/html/_sources/private_networks.txt +146 -0
- data/sphinx/_build/html/_sources/public_ips.txt +78 -0
- data/sphinx/_build/html/_sources/server_appliances.txt +42 -0
- data/sphinx/_build/html/_sources/servers.txt +630 -0
- data/sphinx/_build/html/_sources/shared_storages.txt +160 -0
- data/sphinx/_build/html/_sources/usages.txt +45 -0
- data/sphinx/_build/html/_sources/users.txt +172 -0
- data/sphinx/_build/html/_static/ajax-loader.gif +0 -0
- data/sphinx/_build/html/_static/alabaster.css +585 -0
- data/sphinx/_build/html/_static/basic.css +599 -0
- data/sphinx/_build/html/_static/comment-bright.png +0 -0
- data/sphinx/_build/html/_static/comment-close.png +0 -0
- data/sphinx/_build/html/_static/comment.png +0 -0
- data/sphinx/_build/html/_static/doctools.js +263 -0
- data/sphinx/_build/html/_static/down-pressed.png +0 -0
- data/sphinx/_build/html/_static/down.png +0 -0
- data/sphinx/_build/html/_static/file.png +0 -0
- data/sphinx/_build/html/_static/jquery-1.11.1.js +10308 -0
- data/sphinx/_build/html/_static/jquery.js +4 -0
- data/sphinx/_build/html/_static/minus.png +0 -0
- data/sphinx/_build/html/_static/plus.png +0 -0
- data/sphinx/_build/html/_static/pygments.css +63 -0
- data/sphinx/_build/html/_static/searchtools.js +651 -0
- data/sphinx/_build/html/_static/underscore-1.3.1.js +999 -0
- data/sphinx/_build/html/_static/underscore.js +31 -0
- data/sphinx/_build/html/_static/up-pressed.png +0 -0
- data/sphinx/_build/html/_static/up.png +0 -0
- data/sphinx/_build/html/_static/websupport.js +808 -0
- data/sphinx/_build/html/dvds.html +151 -0
- data/sphinx/_build/html/firewalls.html +397 -0
- data/sphinx/_build/html/genindex.html +114 -0
- data/sphinx/_build/html/images.html +236 -0
- data/sphinx/_build/html/index.html +571 -0
- data/sphinx/_build/html/load_balancers.html +409 -0
- data/sphinx/_build/html/logs.html +160 -0
- data/sphinx/_build/html/monitoring_center.html +160 -0
- data/sphinx/_build/html/monitoring_policies.html +530 -0
- data/sphinx/_build/html/objects.inv +0 -0
- data/sphinx/_build/html/private_networks.html +316 -0
- data/sphinx/_build/html/public_ips.html +215 -0
- data/sphinx/_build/html/rb-modindex.html +106 -0
- data/sphinx/_build/html/search.html +99 -0
- data/sphinx/_build/html/searchindex.js +1 -0
- data/sphinx/_build/html/server_appliances.html +153 -0
- data/sphinx/_build/html/servers.html +994 -0
- data/sphinx/_build/html/shared_storages.html +349 -0
- data/sphinx/_build/html/usages.html +140 -0
- data/sphinx/_build/html/users.html +363 -0
- data/sphinx/conf.py +287 -0
- data/sphinx/dvds.rst +42 -0
- data/sphinx/firewalls.rst +189 -0
- data/sphinx/images.rst +101 -0
- data/sphinx/index.rst +499 -0
- data/sphinx/load_balancers.rst +231 -0
- data/sphinx/logs.rst +55 -0
- data/sphinx/make.bat +263 -0
- data/sphinx/monitoring_center.rst +55 -0
- data/sphinx/monitoring_policies.rst +288 -0
- data/sphinx/private_networks.rst +146 -0
- data/sphinx/public_ips.rst +78 -0
- data/sphinx/server_appliances.rst +42 -0
- data/sphinx/servers.rst +630 -0
- data/sphinx/shared_storages.rst +160 -0
- data/sphinx/usages.rst +45 -0
- data/sphinx/users.rst +172 -0
- data/test/mock-api/add-firewall.json +66 -0
- data/test/mock-api/add-hdd.json +49 -0
- data/test/mock-api/add-lb.json +71 -0
- data/test/mock-api/add-new-ip.json +18 -0
- data/test/mock-api/add-pn.json +66 -0
- data/test/mock-api/add-port-mp.json +81 -0
- data/test/mock-api/add-process-mp.json +20 -0
- data/test/mock-api/add-rule-fp.json +33 -0
- data/test/mock-api/add-rule-lb.json +40 -0
- data/test/mock-api/add-server-ip.json +66 -0
- data/test/mock-api/add-server-mp.json +66 -0
- data/test/mock-api/assign-ip-fp.json +32 -0
- data/test/mock-api/assign-server-lb.json +39 -0
- data/test/mock-api/attach-server-pn.json +14 -0
- data/test/mock-api/attach-server-storage.json +24 -0
- data/test/mock-api/change-api-key.json +15 -0
- data/test/mock-api/change-password.json +5 -0
- data/test/mock-api/change-server-status.json +70 -0
- data/test/mock-api/clone-server.json +29 -0
- data/test/mock-api/create-fp.json +26 -0
- data/test/mock-api/create-image.json +30 -0
- data/test/mock-api/create-lb.json +33 -0
- data/test/mock-api/create-mp.json +81 -0
- data/test/mock-api/create-pn.json +11 -0
- data/test/mock-api/create-public-ip.json +10 -0
- data/test/mock-api/create-server.json +34 -0
- data/test/mock-api/create-snapshot.json +74 -0
- data/test/mock-api/create-storage.json +13 -0
- data/test/mock-api/create-user.json +14 -0
- data/test/mock-api/delete-fp.json +26 -0
- data/test/mock-api/delete-image.json +26 -0
- data/test/mock-api/delete-ip.json +15 -0
- data/test/mock-api/delete-lb.json +33 -0
- data/test/mock-api/delete-mp.json +71 -0
- data/test/mock-api/delete-pn.json +11 -0
- data/test/mock-api/delete-public-ip.json +10 -0
- data/test/mock-api/delete-rule-fp.json +26 -0
- data/test/mock-api/delete-server.json +50 -0
- data/test/mock-api/delete-snapshot.json +74 -0
- data/test/mock-api/delete-storage.json +24 -0
- data/test/mock-api/delete-user.json +15 -0
- data/test/mock-api/detach-server-lb.json +33 -0
- data/test/mock-api/detach-server-mp.json +65 -0
- data/test/mock-api/detach-server-storage.json +19 -0
- data/test/mock-api/edit-image.json +26 -0
- data/test/mock-api/eject-dvd.json +66 -0
- data/test/mock-api/fixed-server-flavors.json +70 -0
- data/test/mock-api/get-appliance.json +16 -0
- data/test/mock-api/get-dvd.json +9 -0
- data/test/mock-api/get-firewall.json +26 -0
- data/test/mock-api/get-fixed-server.json +17 -0
- data/test/mock-api/get-fp-rule.json +7 -0
- data/test/mock-api/get-hardware.json +13 -0
- data/test/mock-api/get-hdd.json +5 -0
- data/test/mock-api/get-image.json +26 -0
- data/test/mock-api/get-lb-rule.json +7 -0
- data/test/mock-api/get-lb-server.json +5 -0
- data/test/mock-api/get-load-balancer.json +33 -0
- data/test/mock-api/get-log.json +23 -0
- data/test/mock-api/get-monitoring-center.json +161 -0
- data/test/mock-api/get-mp-port.json +7 -0
- data/test/mock-api/get-mp-process.json +6 -0
- data/test/mock-api/get-mp-server.json +4 -0
- data/test/mock-api/get-mp.json +65 -0
- data/test/mock-api/get-pn-server.json +4 -0
- data/test/mock-api/get-private-network.json +20 -0
- data/test/mock-api/get-public-ip.json +10 -0
- data/test/mock-api/get-server-dvd.json +4 -0
- data/test/mock-api/get-server-image.json +4 -0
- data/test/mock-api/get-server-ip-fp.json +4 -0
- data/test/mock-api/get-server-ip.json +8 -0
- data/test/mock-api/get-server-pn.json +16 -0
- data/test/mock-api/get-server-status.json +4 -0
- data/test/mock-api/get-server-storage.json +5 -0
- data/test/mock-api/get-server.json +44 -0
- data/test/mock-api/get-storage.json +19 -0
- data/test/mock-api/get-usage.json +161 -0
- data/test/mock-api/get-user-api-key.json +3 -0
- data/test/mock-api/get-user-api.json +7 -0
- data/test/mock-api/get-user.json +15 -0
- data/test/mock-api/list-appliances.json +66 -0
- data/test/mock-api/list-credentials.json +5 -0
- data/test/mock-api/list-dvds.json +128 -0
- data/test/mock-api/list-firewalls.json +54 -0
- data/test/mock-api/list-fp-rules.json +16 -0
- data/test/mock-api/list-hdds.json +7 -0
- data/test/mock-api/list-images.json +54 -0
- data/test/mock-api/list-lb-rules.json +16 -0
- data/test/mock-api/list-lb-servers.json +12 -0
- data/test/mock-api/list-load-balancers.json +68 -0
- data/test/mock-api/list-logs.json +49 -0
- data/test/mock-api/list-monitoring-center-usages.json +90 -0
- data/test/mock-api/list-mp-ports.json +16 -0
- data/test/mock-api/list-mp-processes.json +14 -0
- data/test/mock-api/list-mp-servers.json +10 -0
- data/test/mock-api/list-mps.json +152 -0
- data/test/mock-api/list-pn-servers.json +10 -0
- data/test/mock-api/list-private-networks.json +24 -0
- data/test/mock-api/list-public-ips.json +44 -0
- data/test/mock-api/list-server-fps.json +4 -0
- data/test/mock-api/list-server-ips-fp.json +7 -0
- data/test/mock-api/list-server-ips.json +10 -0
- data/test/mock-api/list-server-lbs.json +6 -0
- data/test/mock-api/list-server-pns.json +6 -0
- data/test/mock-api/list-servers.json +66 -0
- data/test/mock-api/list-snapshots.json +7 -0
- data/test/mock-api/list-storages.json +47 -0
- data/test/mock-api/list-usages.json +144 -0
- data/test/mock-api/list-user-ips.json +5 -0
- data/test/mock-api/list-users.json +31 -0
- data/test/mock-api/load-dvd.json +63 -0
- data/test/mock-api/modify-fp.json +26 -0
- data/test/mock-api/modify-lb.json +33 -0
- data/test/mock-api/modify-mp.json +81 -0
- data/test/mock-api/modify-pn.json +20 -0
- data/test/mock-api/modify-port-mp.json +81 -0
- data/test/mock-api/modify-process-mp.json +73 -0
- data/test/mock-api/modify-public-ip.json +10 -0
- data/test/mock-api/modify-server-hardware.json +44 -0
- data/test/mock-api/modify-server-hdd.json +54 -0
- data/test/mock-api/modify-server.json +44 -0
- data/test/mock-api/modify-storage.json +19 -0
- data/test/mock-api/modify-user-api.json +15 -0
- data/test/mock-api/modify-user.json +15 -0
- data/test/mock-api/reinstall-image.json +52 -0
- data/test/mock-api/remove-firewall-policy.json +26 -0
- data/test/mock-api/remove-hdd.json +54 -0
- data/test/mock-api/remove-ip-fp.json +26 -0
- data/test/mock-api/remove-lb.json +66 -0
- data/test/mock-api/remove-pn.json +71 -0
- data/test/mock-api/remove-port-mp.json +73 -0
- data/test/mock-api/remove-process-mp.json +66 -0
- data/test/mock-api/remove-rule-lb.json +33 -0
- data/test/mock-api/remove-server-ip.json +58 -0
- data/test/mock-api/remove-server-pn.json +16 -0
- data/test/mock-api/restore-snapshot.json +55 -0
- data/test/mock-api/storage-servers.json +12 -0
- data/test/test_mock_dvd.rb +55 -0
- data/test/test_mock_firewall.rb +309 -0
- data/test/test_mock_image.rb +123 -0
- data/test/test_mock_load_balancer.rb +312 -0
- data/test/test_mock_log.rb +55 -0
- data/test/test_mock_monitoring_center.rb +55 -0
- data/test/test_mock_monitoring_policy.rb +587 -0
- data/test/test_mock_private_network.rb +206 -0
- data/test/test_mock_public_ip.rb +118 -0
- data/test/test_mock_server.rb +929 -0
- data/test/test_mock_server_appliance.rb +55 -0
- data/test/test_mock_shared_storage.rb +256 -0
- data/test/test_mock_usage.rb +34 -0
- data/test/test_mock_user.rb +270 -0
- metadata +360 -0
|
@@ -0,0 +1,409 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
6
|
+
<head>
|
|
7
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
8
|
+
|
|
9
|
+
<title>Load Balancers — 1and1 Ruby SDK 1.0 documentation</title>
|
|
10
|
+
|
|
11
|
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
12
|
+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
13
|
+
|
|
14
|
+
<script type="text/javascript">
|
|
15
|
+
var DOCUMENTATION_OPTIONS = {
|
|
16
|
+
URL_ROOT: './',
|
|
17
|
+
VERSION: '1.0',
|
|
18
|
+
COLLAPSE_INDEX: false,
|
|
19
|
+
FILE_SUFFIX: '.html',
|
|
20
|
+
HAS_SOURCE: true
|
|
21
|
+
};
|
|
22
|
+
</script>
|
|
23
|
+
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
24
|
+
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
25
|
+
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
26
|
+
<link rel="top" title="1and1 Ruby SDK 1.0 documentation" href="index.html" />
|
|
27
|
+
<link rel="next" title="Public IPs" href="public_ips.html" />
|
|
28
|
+
<link rel="prev" title="Firewall Policies" href="firewalls.html" />
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
|
32
|
+
|
|
33
|
+
</head>
|
|
34
|
+
<body role="document">
|
|
35
|
+
|
|
36
|
+
<div class="document">
|
|
37
|
+
<div class="documentwrapper">
|
|
38
|
+
<div class="bodywrapper">
|
|
39
|
+
<div class="body" role="main">
|
|
40
|
+
|
|
41
|
+
<div class="section" id="load-balancers">
|
|
42
|
+
<h1>Load Balancers<a class="headerlink" href="#load-balancers" title="Permalink to this headline">¶</a></h1>
|
|
43
|
+
<dl class="class">
|
|
44
|
+
<dt>
|
|
45
|
+
<code class="descname">OneAndOne::LoadBalancer()</code></dt>
|
|
46
|
+
<dd><p>The <code class="xref rb rb-class docutils literal"><span class="pre">LoadBalancer</span></code> class allows a user to perform actions against the 1and1 API.</p>
|
|
47
|
+
<dl class="method">
|
|
48
|
+
<dt id="list">
|
|
49
|
+
<code class="descname">list</code><span class="sig-paren">(</span><em>page: nil</em>, <em>per_page: nil</em>, <em>sort: nil</em>, <em>q: nil</em>, <em>fields: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#list" title="Permalink to this definition">¶</a></dt>
|
|
50
|
+
<dd><p>Return a list of all load balancers.</p>
|
|
51
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
52
|
+
<col class="field-name" />
|
|
53
|
+
<col class="field-body" />
|
|
54
|
+
<tbody valign="top">
|
|
55
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
56
|
+
<li><strong>page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Allows the use of pagination. Indicate which page to start on.</li>
|
|
57
|
+
<li><strong>per_page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Number of items per page.</li>
|
|
58
|
+
<li><strong>sort</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'name'</span></code> retrieves a list of elements sorted
|
|
59
|
+
alphabetically. <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'creation_date'</span></code> retrieves a list of elements
|
|
60
|
+
sorted by their creation date in descending order.</li>
|
|
61
|
+
<li><strong>q</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – <code class="docutils literal"><span class="pre">q</span></code> is for query. Use this parameter to return only the items
|
|
62
|
+
that match your search query.</li>
|
|
63
|
+
<li><strong>fields</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – Returns only the parameters requested.
|
|
64
|
+
(i.e. fields: ‘id, name, description, hardware.ram’)</li>
|
|
65
|
+
</ul>
|
|
66
|
+
</td>
|
|
67
|
+
</tr>
|
|
68
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
69
|
+
</td>
|
|
70
|
+
</tr>
|
|
71
|
+
</tbody>
|
|
72
|
+
</table>
|
|
73
|
+
</dd></dl>
|
|
74
|
+
|
|
75
|
+
<dl class="method">
|
|
76
|
+
<dt id="create">
|
|
77
|
+
<code class="descname">create</code><span class="sig-paren">(</span><em>name: nil</em>, <em>description: nil</em>, <em>health_check_test: nil</em>, <em>health_check_interval: nil</em>, <em>persistence: nil</em>, <em>persistence_time: nil</em>, <em>method: nil</em>, <em>rules: nil</em>, <em>health_check_path: nil</em>, <em>health_check_parse: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#create" title="Permalink to this definition">¶</a></dt>
|
|
78
|
+
<dd><p>Create a load balancer.</p>
|
|
79
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
80
|
+
<col class="field-name" />
|
|
81
|
+
<col class="field-body" />
|
|
82
|
+
<tbody valign="top">
|
|
83
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
|
84
|
+
<li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – load balancer name.</li>
|
|
85
|
+
<li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – load balancer description.</li>
|
|
86
|
+
<li><strong>health_check_test</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – possible values are <code class="docutils literal"><span class="pre">"NONE"</span></code> or <code class="docutils literal"><span class="pre">"TCP"</span></code>.</li>
|
|
87
|
+
<li><strong>health_check_interval</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Health check period in seconds. Can range between <code class="docutils literal"><span class="pre">5</span></code> and <code class="docutils literal"><span class="pre">300</span></code> seconds.</li>
|
|
88
|
+
<li><strong>persistence</strong> (<code class="docutils literal"><span class="pre">bool</span></code>) – enable or disable persistence.</li>
|
|
89
|
+
<li><strong>persistence_time</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Persistence time in seconds. Required if persistence is enabled. Can range from <code class="docutils literal"><span class="pre">30</span></code> to <code class="docutils literal"><span class="pre">1200</span></code> seconds</li>
|
|
90
|
+
<li><strong>method</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – balancing procedure. Possible values are <code class="docutils literal"><span class="pre">"ROUND_ROBIN"</span></code> or <code class="docutils literal"><span class="pre">"LEAST_CONNECTIONS"</span></code>.</li>
|
|
91
|
+
<li><strong>rules</strong> (<code class="docutils literal"><span class="pre">array</span></code>) – takes an array of “rule” objects to be added to the load balancer.</li>
|
|
92
|
+
<li><strong>health_check_path</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – Url to call for checking. Required for HTTP health check.</li>
|
|
93
|
+
<li><strong>health_check_parse</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – Regular expression to check. Required for HTTP health check.</li>
|
|
94
|
+
</ul>
|
|
95
|
+
</td>
|
|
96
|
+
</tr>
|
|
97
|
+
</tbody>
|
|
98
|
+
</table>
|
|
99
|
+
</dd></dl>
|
|
100
|
+
|
|
101
|
+
<dl class="method">
|
|
102
|
+
<dt id="get">
|
|
103
|
+
<code class="descname">get</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#get" title="Permalink to this definition">¶</a></dt>
|
|
104
|
+
<dd><p>Returns the current specs of a load balancer.</p>
|
|
105
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
106
|
+
<col class="field-name" />
|
|
107
|
+
<col class="field-body" />
|
|
108
|
+
<tbody valign="top">
|
|
109
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
110
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
111
|
+
</ul>
|
|
112
|
+
</td>
|
|
113
|
+
</tr>
|
|
114
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
115
|
+
</td>
|
|
116
|
+
</tr>
|
|
117
|
+
</tbody>
|
|
118
|
+
</table>
|
|
119
|
+
</dd></dl>
|
|
120
|
+
|
|
121
|
+
<dl class="method">
|
|
122
|
+
<dt id="modify">
|
|
123
|
+
<code class="descname">modify</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em>, <em>name: nil</em>, <em>description: nil</em>, <em>health_check_test: nil</em>, <em>health_check_interval: nil</em>, <em>persistence: nil</em>, <em>persistence_time: nil</em>, <em>method: nil</em>, <em>health_check_path: nil</em>, <em>health_check_parse: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#modify" title="Permalink to this definition">¶</a></dt>
|
|
124
|
+
<dd><p>Modify a load balancer.</p>
|
|
125
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
126
|
+
<col class="field-name" />
|
|
127
|
+
<col class="field-body" />
|
|
128
|
+
<tbody valign="top">
|
|
129
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
130
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
131
|
+
<li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – load balancer name.</li>
|
|
132
|
+
<li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – load balancer description.</li>
|
|
133
|
+
<li><strong>health_check_test</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – possible values are <code class="docutils literal"><span class="pre">"NONE"</span></code>,``”TCP”<code class="docutils literal"><span class="pre">,</span> <span class="pre">or</span> <span class="pre">``"HTTP"</span></code>.</li>
|
|
134
|
+
<li><strong>health_check_interval</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Health check period in seconds.</li>
|
|
135
|
+
<li><strong>persistence</strong> (<code class="docutils literal"><span class="pre">bool</span></code>) – enable or disable persistnece.</li>
|
|
136
|
+
<li><strong>persistence_time</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Persistence time in seconds. Required if persistence is enabled.</li>
|
|
137
|
+
<li><strong>method</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – balancing procedure. possible values are <code class="docutils literal"><span class="pre">"ROUND_ROBIN"</span></code> or <code class="docutils literal"><span class="pre">"LEAST_CONNECTIONS"</span></code>.</li>
|
|
138
|
+
<li><strong>health_check_path</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – Url to call for checking. Required for HTTP health check.</li>
|
|
139
|
+
<li><strong>health_check_parse</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – Regular expression to check. Required for HTTP health check.</li>
|
|
140
|
+
</ul>
|
|
141
|
+
</td>
|
|
142
|
+
</tr>
|
|
143
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
144
|
+
</td>
|
|
145
|
+
</tr>
|
|
146
|
+
</tbody>
|
|
147
|
+
</table>
|
|
148
|
+
</dd></dl>
|
|
149
|
+
|
|
150
|
+
<dl class="method">
|
|
151
|
+
<dt id="delete">
|
|
152
|
+
<code class="descname">delete</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#delete" title="Permalink to this definition">¶</a></dt>
|
|
153
|
+
<dd><p>Delete a load balancer.</p>
|
|
154
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
155
|
+
<col class="field-name" />
|
|
156
|
+
<col class="field-body" />
|
|
157
|
+
<tbody valign="top">
|
|
158
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
159
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
160
|
+
</ul>
|
|
161
|
+
</td>
|
|
162
|
+
</tr>
|
|
163
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
164
|
+
</td>
|
|
165
|
+
</tr>
|
|
166
|
+
</tbody>
|
|
167
|
+
</table>
|
|
168
|
+
</dd></dl>
|
|
169
|
+
|
|
170
|
+
<dl class="method">
|
|
171
|
+
<dt id="ips">
|
|
172
|
+
<code class="descname">ips</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#ips" title="Permalink to this definition">¶</a></dt>
|
|
173
|
+
<dd><p>Returns a list of the IP’s assigned to a load balancer.</p>
|
|
174
|
+
<p>Delete a load balancer.</p>
|
|
175
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
176
|
+
<col class="field-name" />
|
|
177
|
+
<col class="field-body" />
|
|
178
|
+
<tbody valign="top">
|
|
179
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
180
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
181
|
+
</ul>
|
|
182
|
+
</td>
|
|
183
|
+
</tr>
|
|
184
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
185
|
+
</td>
|
|
186
|
+
</tr>
|
|
187
|
+
</tbody>
|
|
188
|
+
</table>
|
|
189
|
+
</dd></dl>
|
|
190
|
+
|
|
191
|
+
<dl class="method">
|
|
192
|
+
<dt id="ip">
|
|
193
|
+
<code class="descname">ip</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em>, <em>ip_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#ip" title="Permalink to this definition">¶</a></dt>
|
|
194
|
+
<dd><p>Returns information about an IP assigned to a load balancer.</p>
|
|
195
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
196
|
+
<col class="field-name" />
|
|
197
|
+
<col class="field-body" />
|
|
198
|
+
<tbody valign="top">
|
|
199
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
200
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
201
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the IP.</li>
|
|
202
|
+
</ul>
|
|
203
|
+
</td>
|
|
204
|
+
</tr>
|
|
205
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
206
|
+
</td>
|
|
207
|
+
</tr>
|
|
208
|
+
</tbody>
|
|
209
|
+
</table>
|
|
210
|
+
</dd></dl>
|
|
211
|
+
|
|
212
|
+
<dl class="method">
|
|
213
|
+
<dt id="remove_ip">
|
|
214
|
+
<code class="descname">remove_ip</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em>, <em>ip_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#remove_ip" title="Permalink to this definition">¶</a></dt>
|
|
215
|
+
<dd><p>Remove an IP from a load balancer.</p>
|
|
216
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
217
|
+
<col class="field-name" />
|
|
218
|
+
<col class="field-body" />
|
|
219
|
+
<tbody valign="top">
|
|
220
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
221
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
222
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the IP.</li>
|
|
223
|
+
</ul>
|
|
224
|
+
</td>
|
|
225
|
+
</tr>
|
|
226
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
227
|
+
</td>
|
|
228
|
+
</tr>
|
|
229
|
+
</tbody>
|
|
230
|
+
</table>
|
|
231
|
+
</dd></dl>
|
|
232
|
+
|
|
233
|
+
<dl class="method">
|
|
234
|
+
<dt id="add_ips">
|
|
235
|
+
<code class="descname">add_ips</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em>, <em>ips: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_ips" title="Permalink to this definition">¶</a></dt>
|
|
236
|
+
<dd><p>Assign IP’s to a load balancer.</p>
|
|
237
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
238
|
+
<col class="field-name" />
|
|
239
|
+
<col class="field-body" />
|
|
240
|
+
<tbody valign="top">
|
|
241
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
242
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
243
|
+
<li><strong>ips</strong> (<code class="docutils literal"><span class="pre">array</span></code>) – takes an array of IP strings to be added to the load balancer.</li>
|
|
244
|
+
</ul>
|
|
245
|
+
</td>
|
|
246
|
+
</tr>
|
|
247
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
248
|
+
</td>
|
|
249
|
+
</tr>
|
|
250
|
+
</tbody>
|
|
251
|
+
</table>
|
|
252
|
+
</dd></dl>
|
|
253
|
+
|
|
254
|
+
<dl class="method">
|
|
255
|
+
<dt id="rules">
|
|
256
|
+
<code class="descname">rules</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#rules" title="Permalink to this definition">¶</a></dt>
|
|
257
|
+
<dd><p>Returns a list of the load balancer’s rules.</p>
|
|
258
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
259
|
+
<col class="field-name" />
|
|
260
|
+
<col class="field-body" />
|
|
261
|
+
<tbody valign="top">
|
|
262
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
263
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
264
|
+
</ul>
|
|
265
|
+
</td>
|
|
266
|
+
</tr>
|
|
267
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
268
|
+
</td>
|
|
269
|
+
</tr>
|
|
270
|
+
</tbody>
|
|
271
|
+
</table>
|
|
272
|
+
</dd></dl>
|
|
273
|
+
|
|
274
|
+
<dl class="method">
|
|
275
|
+
<dt id="rule">
|
|
276
|
+
<code class="descname">rule</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em>, <em>rule_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#rule" title="Permalink to this definition">¶</a></dt>
|
|
277
|
+
<dd><p>Returns information about a load balancer’s rule.</p>
|
|
278
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
279
|
+
<col class="field-name" />
|
|
280
|
+
<col class="field-body" />
|
|
281
|
+
<tbody valign="top">
|
|
282
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
283
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
284
|
+
<li><strong>rule_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the rule.</li>
|
|
285
|
+
</ul>
|
|
286
|
+
</td>
|
|
287
|
+
</tr>
|
|
288
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
289
|
+
</td>
|
|
290
|
+
</tr>
|
|
291
|
+
</tbody>
|
|
292
|
+
</table>
|
|
293
|
+
</dd></dl>
|
|
294
|
+
|
|
295
|
+
<dl class="method">
|
|
296
|
+
<dt id="add_rules">
|
|
297
|
+
<code class="descname">add_rules</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em>, <em>rules: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_rules" title="Permalink to this definition">¶</a></dt>
|
|
298
|
+
<dd><p>Add rules to a load balancer.</p>
|
|
299
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
300
|
+
<col class="field-name" />
|
|
301
|
+
<col class="field-body" />
|
|
302
|
+
<tbody valign="top">
|
|
303
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
304
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
305
|
+
<li><strong>rules</strong> (<code class="docutils literal"><span class="pre">array</span></code>) – takes an array of “rule” objects to be added to the load balancer.</li>
|
|
306
|
+
</ul>
|
|
307
|
+
</td>
|
|
308
|
+
</tr>
|
|
309
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
310
|
+
</td>
|
|
311
|
+
</tr>
|
|
312
|
+
</tbody>
|
|
313
|
+
</table>
|
|
314
|
+
</dd></dl>
|
|
315
|
+
|
|
316
|
+
<dl class="method">
|
|
317
|
+
<dt id="remove_rule">
|
|
318
|
+
<code class="descname">remove_rule</code><span class="sig-paren">(</span><em>load_balancer_id: @id</em>, <em>rule_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#remove_rule" title="Permalink to this definition">¶</a></dt>
|
|
319
|
+
<dd><p>Remove a load balancer’s rule.</p>
|
|
320
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
321
|
+
<col class="field-name" />
|
|
322
|
+
<col class="field-body" />
|
|
323
|
+
<tbody valign="top">
|
|
324
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
325
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
|
326
|
+
<li><strong>rule_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the rule.</li>
|
|
327
|
+
</ul>
|
|
328
|
+
</td>
|
|
329
|
+
</tr>
|
|
330
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
331
|
+
</td>
|
|
332
|
+
</tr>
|
|
333
|
+
</tbody>
|
|
334
|
+
</table>
|
|
335
|
+
</dd></dl>
|
|
336
|
+
|
|
337
|
+
<dl class="method">
|
|
338
|
+
<dt id="wait_for">
|
|
339
|
+
<code class="descname">wait_for</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wait_for" title="Permalink to this definition">¶</a></dt>
|
|
340
|
+
<dd><p>Polls the load balancer until an “ACTIVE” state is returned. Use this when chaining actions.</p>
|
|
341
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
342
|
+
<col class="field-name" />
|
|
343
|
+
<col class="field-body" />
|
|
344
|
+
<tbody valign="top">
|
|
345
|
+
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal"><span class="pre">nil</span></code></td>
|
|
346
|
+
</tr>
|
|
347
|
+
</tbody>
|
|
348
|
+
</table>
|
|
349
|
+
</dd></dl>
|
|
350
|
+
|
|
351
|
+
</dd></dl>
|
|
352
|
+
|
|
353
|
+
</div>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
</div>
|
|
357
|
+
</div>
|
|
358
|
+
</div>
|
|
359
|
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
360
|
+
<div class="sphinxsidebarwrapper"><div class="relations">
|
|
361
|
+
<h3>Related Topics</h3>
|
|
362
|
+
<ul>
|
|
363
|
+
<li><a href="index.html">Documentation overview</a><ul>
|
|
364
|
+
<li>Previous: <a href="firewalls.html" title="previous chapter">Firewall Policies</a></li>
|
|
365
|
+
<li>Next: <a href="public_ips.html" title="next chapter">Public IPs</a></li>
|
|
366
|
+
</ul></li>
|
|
367
|
+
</ul>
|
|
368
|
+
</div>
|
|
369
|
+
<div role="note" aria-label="source link">
|
|
370
|
+
<h3>This Page</h3>
|
|
371
|
+
<ul class="this-page-menu">
|
|
372
|
+
<li><a href="_sources/load_balancers.txt"
|
|
373
|
+
rel="nofollow">Show Source</a></li>
|
|
374
|
+
</ul>
|
|
375
|
+
</div>
|
|
376
|
+
<div id="searchbox" style="display: none" role="search">
|
|
377
|
+
<h3>Quick search</h3>
|
|
378
|
+
<form class="search" action="search.html" method="get">
|
|
379
|
+
<input type="text" name="q" />
|
|
380
|
+
<input type="submit" value="Go" />
|
|
381
|
+
<input type="hidden" name="check_keywords" value="yes" />
|
|
382
|
+
<input type="hidden" name="area" value="default" />
|
|
383
|
+
</form>
|
|
384
|
+
<p class="searchtip" style="font-size: 90%">
|
|
385
|
+
Enter search terms or a module, class or function name.
|
|
386
|
+
</p>
|
|
387
|
+
</div>
|
|
388
|
+
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
389
|
+
</div>
|
|
390
|
+
</div>
|
|
391
|
+
<div class="clearer"></div>
|
|
392
|
+
</div>
|
|
393
|
+
<div class="footer">
|
|
394
|
+
©2016, StackPointCloud, Inc..
|
|
395
|
+
|
|
396
|
+
|
|
|
397
|
+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
|
|
398
|
+
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
|
399
|
+
|
|
400
|
+
|
|
|
401
|
+
<a href="_sources/load_balancers.txt"
|
|
402
|
+
rel="nofollow">Page source</a>
|
|
403
|
+
</div>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
</body>
|
|
409
|
+
</html>
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
6
|
+
<head>
|
|
7
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
8
|
+
|
|
9
|
+
<title>Logs — 1and1 Ruby SDK 1.0 documentation</title>
|
|
10
|
+
|
|
11
|
+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
|
12
|
+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
13
|
+
|
|
14
|
+
<script type="text/javascript">
|
|
15
|
+
var DOCUMENTATION_OPTIONS = {
|
|
16
|
+
URL_ROOT: './',
|
|
17
|
+
VERSION: '1.0',
|
|
18
|
+
COLLAPSE_INDEX: false,
|
|
19
|
+
FILE_SUFFIX: '.html',
|
|
20
|
+
HAS_SOURCE: true
|
|
21
|
+
};
|
|
22
|
+
</script>
|
|
23
|
+
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
24
|
+
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
25
|
+
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
26
|
+
<link rel="top" title="1and1 Ruby SDK 1.0 documentation" href="index.html" />
|
|
27
|
+
<link rel="next" title="Users" href="users.html" />
|
|
28
|
+
<link rel="prev" title="Monitoring Policies" href="monitoring_policies.html" />
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
|
32
|
+
|
|
33
|
+
</head>
|
|
34
|
+
<body role="document">
|
|
35
|
+
|
|
36
|
+
<div class="document">
|
|
37
|
+
<div class="documentwrapper">
|
|
38
|
+
<div class="bodywrapper">
|
|
39
|
+
<div class="body" role="main">
|
|
40
|
+
|
|
41
|
+
<div class="section" id="logs">
|
|
42
|
+
<h1>Logs<a class="headerlink" href="#logs" title="Permalink to this headline">¶</a></h1>
|
|
43
|
+
<dl class="class">
|
|
44
|
+
<dt>
|
|
45
|
+
<code class="descname">OneAndOne::Log()</code></dt>
|
|
46
|
+
<dd><p>The <code class="xref rb rb-class docutils literal"><span class="pre">Log</span></code> class allows a user to perform actions against the 1and1 API.</p>
|
|
47
|
+
<dl class="method">
|
|
48
|
+
<dt id="list">
|
|
49
|
+
<code class="descname">list</code><span class="sig-paren">(</span><em>page: nil</em>, <em>per_page: nil</em>, <em>sort: nil</em>, <em>q: nil</em>, <em>fields: nil</em>, <em>period: 'LAST_24H'</em>, <em>start_date: nil</em>, <em>end_date: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#list" title="Permalink to this definition">¶</a></dt>
|
|
50
|
+
<dd><p>List all logs by time period.</p>
|
|
51
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
52
|
+
<col class="field-name" />
|
|
53
|
+
<col class="field-body" />
|
|
54
|
+
<tbody valign="top">
|
|
55
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
56
|
+
<li><strong>page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Allows the use of pagination. Indicate which page to start on.</li>
|
|
57
|
+
<li><strong>per_page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Number of items per page.</li>
|
|
58
|
+
<li><strong>sort</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'name'</span></code> retrieves a list of elements sorted
|
|
59
|
+
alphabetically. <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'creation_date'</span></code> retrieves a list of elements
|
|
60
|
+
sorted by their creation date in descending order.</li>
|
|
61
|
+
<li><strong>q</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – <code class="docutils literal"><span class="pre">q</span></code> is for query. Use this parameter to return only the items
|
|
62
|
+
that match your search query.</li>
|
|
63
|
+
<li><strong>fields</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – Returns only the parameters requested.
|
|
64
|
+
(i.e. fields: ‘id, name, description, hardware.ram’)</li>
|
|
65
|
+
<li><strong>period</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the time range of logs to be shown. Possible values are
|
|
66
|
+
<code class="docutils literal"><span class="pre">'LAST_HOUR'</span></code>, <code class="docutils literal"><span class="pre">'LAST_24H'</span></code>, <code class="docutils literal"><span class="pre">'LAST_7D'</span></code>, <code class="docutils literal"><span class="pre">'LAST_30D'</span></code>,
|
|
67
|
+
<code class="docutils literal"><span class="pre">'LAST_365D'</span></code>, or <code class="docutils literal"><span class="pre">'CUSTOM'</span></code></li>
|
|
68
|
+
<li><strong>start_date</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – start point. Only required if using <code class="docutils literal"><span class="pre">'CUSTOM'</span></code> for the
|
|
69
|
+
<code class="docutils literal"><span class="pre">period</span></code> parameter. <em>Format:</em> <code class="docutils literal"><span class="pre">2015-19-05T00:05:00Z</span></code></li>
|
|
70
|
+
<li><strong>end_date</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – end point. Only required if using <code class="docutils literal"><span class="pre">'CUSTOM'</span></code> for the
|
|
71
|
+
<code class="docutils literal"><span class="pre">period</span></code> parameter. <em>Format:</em> <code class="docutils literal"><span class="pre">2015-19-05T00:10:00Z</span></code></li>
|
|
72
|
+
</ul>
|
|
73
|
+
</td>
|
|
74
|
+
</tr>
|
|
75
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
76
|
+
</td>
|
|
77
|
+
</tr>
|
|
78
|
+
</tbody>
|
|
79
|
+
</table>
|
|
80
|
+
</dd></dl>
|
|
81
|
+
|
|
82
|
+
<dl class="method">
|
|
83
|
+
<dt id="get">
|
|
84
|
+
<code class="descname">get</code><span class="sig-paren">(</span><em>log_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#get" title="Permalink to this definition">¶</a></dt>
|
|
85
|
+
<dd><p>Returns information about a log</p>
|
|
86
|
+
<table class="docutils field-list" frame="void" rules="none">
|
|
87
|
+
<col class="field-name" />
|
|
88
|
+
<col class="field-body" />
|
|
89
|
+
<tbody valign="top">
|
|
90
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
91
|
+
<li><strong>log_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the log.</li>
|
|
92
|
+
</ul>
|
|
93
|
+
</td>
|
|
94
|
+
</tr>
|
|
95
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
|
96
|
+
</td>
|
|
97
|
+
</tr>
|
|
98
|
+
</tbody>
|
|
99
|
+
</table>
|
|
100
|
+
</dd></dl>
|
|
101
|
+
|
|
102
|
+
</dd></dl>
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
111
|
+
<div class="sphinxsidebarwrapper"><div class="relations">
|
|
112
|
+
<h3>Related Topics</h3>
|
|
113
|
+
<ul>
|
|
114
|
+
<li><a href="index.html">Documentation overview</a><ul>
|
|
115
|
+
<li>Previous: <a href="monitoring_policies.html" title="previous chapter">Monitoring Policies</a></li>
|
|
116
|
+
<li>Next: <a href="users.html" title="next chapter">Users</a></li>
|
|
117
|
+
</ul></li>
|
|
118
|
+
</ul>
|
|
119
|
+
</div>
|
|
120
|
+
<div role="note" aria-label="source link">
|
|
121
|
+
<h3>This Page</h3>
|
|
122
|
+
<ul class="this-page-menu">
|
|
123
|
+
<li><a href="_sources/logs.txt"
|
|
124
|
+
rel="nofollow">Show Source</a></li>
|
|
125
|
+
</ul>
|
|
126
|
+
</div>
|
|
127
|
+
<div id="searchbox" style="display: none" role="search">
|
|
128
|
+
<h3>Quick search</h3>
|
|
129
|
+
<form class="search" action="search.html" method="get">
|
|
130
|
+
<input type="text" name="q" />
|
|
131
|
+
<input type="submit" value="Go" />
|
|
132
|
+
<input type="hidden" name="check_keywords" value="yes" />
|
|
133
|
+
<input type="hidden" name="area" value="default" />
|
|
134
|
+
</form>
|
|
135
|
+
<p class="searchtip" style="font-size: 90%">
|
|
136
|
+
Enter search terms or a module, class or function name.
|
|
137
|
+
</p>
|
|
138
|
+
</div>
|
|
139
|
+
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
140
|
+
</div>
|
|
141
|
+
</div>
|
|
142
|
+
<div class="clearer"></div>
|
|
143
|
+
</div>
|
|
144
|
+
<div class="footer">
|
|
145
|
+
©2016, StackPointCloud, Inc..
|
|
146
|
+
|
|
147
|
+
|
|
|
148
|
+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
|
|
149
|
+
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
|
150
|
+
|
|
151
|
+
|
|
|
152
|
+
<a href="_sources/logs.txt"
|
|
153
|
+
rel="nofollow">Page source</a>
|
|
154
|
+
</div>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</body>
|
|
160
|
+
</html>
|