-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathusage.html
More file actions
182 lines (137 loc) · 10.8 KB
/
usage.html
File metadata and controls
182 lines (137 loc) · 10.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Usage — ucloud-sdk-python3 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="usage">
<h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1>
<div class="section" id="type-system">
<h2>Type System<a class="headerlink" href="#type-system" title="Permalink to this headline">¶</a></h2>
<p>UCloud Python SDK has type system for runtime checking.</p>
<p>For example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">client</span><span class="o">.</span><span class="n">uhost</span><span class="p">()</span><span class="o">.</span><span class="n">create_uhost_instance</span><span class="p">({</span>
<span class="s1">'CPU'</span><span class="p">:</span> <span class="s2">"i am not a integer"</span><span class="p">,</span>
<span class="p">})</span>
</pre></div>
</div>
<p>it will raise <code class="xref py py-class docutils literal notranslate"><span class="pre">ValidationException</span></code> with invalid integer and some required field is miss matched.</p>
</div>
<div class="section" id="wait-state-changed">
<h2>Wait State Changed<a class="headerlink" href="#wait-state-changed" title="Permalink to this headline">¶</a></h2>
<p>SDK also provide state waiter helper to improver usage experience.</p>
<p><strong>When using it?</strong></p>
<p>Waiter can wait for remote state is achieved to target state. such as,</p>
<ul class="simple">
<li>create and wait for resource state is completed.</li>
<li>invoke/start/stop a resource and wait for it is finished.</li>
<li>custom retry policies and wait for retrying is finished.</li>
</ul>
<p>For example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">mget_uhost_states</span><span class="p">(</span><span class="n">uhost_ids</span><span class="p">):</span>
<span class="n">resp</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">uhost</span><span class="p">()</span><span class="o">.</span><span class="n">describe_uhost_instance</span><span class="p">({</span><span class="s1">'UHostIds'</span><span class="p">:</span> <span class="n">uhost_ids</span><span class="p">})</span>
<span class="k">return</span> <span class="p">[</span><span class="n">inst</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'State'</span><span class="p">)</span> <span class="k">for</span> <span class="n">inst</span> <span class="ow">in</span> <span class="n">resp</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'UHostSet'</span><span class="p">)]</span>
<span class="c1"># Stop all instances</span>
<span class="k">for</span> <span class="n">uhost_id</span> <span class="ow">in</span> <span class="n">uhost_ids</span><span class="p">:</span>
<span class="n">client</span><span class="o">.</span><span class="n">uhost</span><span class="p">()</span><span class="o">.</span><span class="n">stop_uhost_instance</span><span class="p">({</span><span class="s1">'UHostId'</span><span class="p">:</span> <span class="n">uhost_id</span><span class="p">})</span>
<span class="c1"># Wait all instances is stopped</span>
<span class="n">wait</span><span class="o">.</span><span class="n">wait_for_state</span><span class="p">(</span>
<span class="n">target</span><span class="o">=</span><span class="p">[</span><span class="s1">'stopped'</span><span class="p">],</span> <span class="n">pending</span><span class="o">=</span><span class="p">[</span><span class="s1">'pending'</span><span class="p">],</span>
<span class="n">timeout</span><span class="o">=</span><span class="mi">300</span><span class="p">,</span> <span class="c1"># wait 5min</span>
<span class="n">refresh</span><span class="o">=</span><span class="k">lambda</span><span class="p">:</span> <span class="p">(</span>
<span class="s1">'stopped'</span> <span class="k">if</span> <span class="nb">all</span><span class="p">([</span><span class="n">state</span> <span class="o">==</span> <span class="s1">'Stopped'</span> <span class="k">for</span> <span class="n">state</span> <span class="ow">in</span> <span class="n">mget_uhost_states</span><span class="p">(</span><span class="n">uhost_ids</span><span class="p">)])</span> <span class="k">else</span> <span class="s1">'pending'</span>
<span class="p">),</span>
<span class="p">)</span>
<span class="c1"># Remove all instances</span>
<span class="k">for</span> <span class="n">uhost_id</span> <span class="ow">in</span> <span class="n">uhost_ids</span><span class="p">:</span>
<span class="n">client</span><span class="o">.</span><span class="n">uhost</span><span class="p">()</span><span class="o">.</span><span class="n">terminate_uhost_instance</span><span class="p">({</span><span class="s1">'UHostId'</span><span class="p">:</span> <span class="n">uhost_id</span><span class="p">})</span>
</pre></div>
</div>
<p>By the default, waiter will use exponential back-off delay between twice request.
it will raise <code class="xref py py-class docutils literal notranslate"><span class="pre">WaitTimeoutException</span></code> when timeout is reached.</p>
</div>
<div class="section" id="client-transport-middleware">
<h2>Client/Transport Middleware<a class="headerlink" href="#client-transport-middleware" title="Permalink to this headline">¶</a></h2>
<p>UCloud SDK provide middleware feature to client or transport level request.</p>
<p>It allowed to add custom logic into the lifecycle of request/response.</p>
<p>For example:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@client</span><span class="o">.</span><span class="n">middleware</span><span class="o">.</span><span class="n">request</span>
<span class="k">def</span> <span class="nf">log_params</span><span class="p">(</span><span class="n">req</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'[REQ]'</span><span class="p">,</span> <span class="n">req</span><span class="p">)</span>
<span class="nd">@client</span><span class="o">.</span><span class="n">middleware</span><span class="o">.</span><span class="n">response</span>
<span class="k">def</span> <span class="nf">log_response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'[RESP]'</span><span class="p">,</span> <span class="n">resp</span><span class="p">)</span>
</pre></div>
</div>
<p>or transport:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">ucloud.core.transport</span> <span class="kn">import</span> <span class="n">RequestsTransport</span>
<span class="n">transport</span> <span class="o">=</span> <span class="n">RequestsTransport</span><span class="p">()</span>
<span class="nd">@transport</span><span class="o">.</span><span class="n">middleware</span><span class="o">.</span><span class="n">request</span>
<span class="k">def</span> <span class="nf">log_request</span><span class="p">(</span><span class="n">req</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'[REQ]'</span><span class="p">,</span> <span class="n">req</span><span class="p">)</span>
<span class="nd">@transport</span><span class="o">.</span><span class="n">middleware</span><span class="o">.</span><span class="n">response</span>
<span class="k">def</span> <span class="nf">log_response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'[RESP]'</span><span class="p">,</span> <span class="n">resp</span><span class="p">)</span>
<span class="n">Client</span><span class="p">({</span><span class="s1">'Region'</span><span class="p">:</span> <span class="s1">'cn-bj2'</span><span class="p">},</span> <span class="n">transport</span><span class="o">=</span><span class="n">transport</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="contents.html">ucloud-sdk-python3</a></h1>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2019, ucloud.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.5</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/usage.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>