/usr/share/doc/python-getdns-doc/html/response.html is in python-getdns-doc 1.0.0~b1-1build4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 | <!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="Content-Type" content="text/html; charset=utf-8" />
<title>getdns response data — getdns v1.0.0b1 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: 'v1.0.0b1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="getdns exceptions" href="exceptions.html" />
<link rel="prev" title="getdns reference" href="functions.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="exceptions.html" title="getdns exceptions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="functions.html" title="getdns reference"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">getdns v1.0.0b1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-getdns">
<span id="getdns-response-data"></span><h1><a class="reference internal" href="#module-getdns" title="getdns: getdns response data description and explanation"><code class="xref py py-mod docutils literal"><span class="pre">getdns</span></code></a> response data<a class="headerlink" href="#module-getdns" title="Permalink to this headline">¶</a></h1>
<div class="section" id="response-data-from-queries">
<h2>Response data from queries<a class="headerlink" href="#response-data-from-queries" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="getdns.Result">
<em class="property">class </em><code class="descclassname">getdns.</code><code class="descname">Result</code><a class="headerlink" href="#getdns.Result" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div>A getdns query (<code class="docutils literal"><span class="pre">Context.address()</span></code>, <code class="docutils literal"><span class="pre">Context.hostname()</span></code>,
<code class="docutils literal"><span class="pre">Context.service()</span></code>, and <code class="docutils literal"><span class="pre">Context.general()</span></code>) returns a
Result object. A Result object is only returned from a
query and may not be instantiated by the programmer. It
is a read-only object. Contents may not be overwritten
or deleted.</div></blockquote>
<p>It has no methods but includes the following attributes:</p>
<dl class="attribute">
<dt id="getdns.Result.status">
<code class="descname">status</code><a class="headerlink" href="#getdns.Result.status" title="Permalink to this definition">¶</a></dt>
<dd><p>The <code class="docutils literal"><span class="pre">status</span></code> attribute contains the status code returned
by the query. Note that it may be the case that the
query can be successful but there are no data matching
the query parameters. Programmers using this API will
need to first check to see if the query itself was
successful, then check for the records returned.</p>
<p>The <code class="docutils literal"><span class="pre">status</span></code> attribute may have the following values:</p>
<dl class="data">
<dt id="getdns.Result.getdns.RESPSTATUS_GOOD">
<code class="descclassname">getdns.</code><code class="descname">RESPSTATUS_GOOD</code><a class="headerlink" href="#getdns.Result.getdns.RESPSTATUS_GOOD" title="Permalink to this definition">¶</a></dt>
<dd><p>At least one response was returned</p>
</dd></dl>
<dl class="data">
<dt id="getdns.Result.getdns.RESPSTATUS_NO_NAME">
<code class="descclassname">getdns.</code><code class="descname">RESPSTATUS_NO_NAME</code><a class="headerlink" href="#getdns.Result.getdns.RESPSTATUS_NO_NAME" title="Permalink to this definition">¶</a></dt>
<dd><p>Queries for the name yielded all negative responses</p>
</dd></dl>
<dl class="data">
<dt id="getdns.Result.getdns.RESPSTATUS_ALL_TIMEOUT">
<code class="descclassname">getdns.</code><code class="descname">RESPSTATUS_ALL_TIMEOUT</code><a class="headerlink" href="#getdns.Result.getdns.RESPSTATUS_ALL_TIMEOUT" title="Permalink to this definition">¶</a></dt>
<dd><p>All queries for the name timed out</p>
</dd></dl>
<dl class="data">
<dt id="getdns.Result.getdns.RESPSTATUS_NO_SECURE_ANSWERS">
<code class="descclassname">getdns.</code><code class="descname">RESPSTATUS_NO_SECURE_ANSWERS</code><a class="headerlink" href="#getdns.Result.getdns.RESPSTATUS_NO_SECURE_ANSWERS" title="Permalink to this definition">¶</a></dt>
<dd><p>The context setting for getting only secure responses was
specified, and at least one DNS response was received, but
no DNS response was determined to be secure through DNSSEC.</p>
<dl class="data">
<dt id="getdns.getdns.RESPSTATUS_ALL_BOGUS_ANSWERS">
<code class="descname">RESPSTATUS_ALL_BOGUS_ANSWERS</code><a class="headerlink" href="#getdns.getdns.RESPSTATUS_ALL_BOGUS_ANSWERS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>The context setting for getting only secure responses
was specified, and at least one DNS response was
received, but all received responses for the requested
name were bogus.</p>
</dd></dl>
</dd></dl>
<dl class="attribute">
<dt id="getdns.Result.answer_type">
<code class="descname">answer_type</code><a class="headerlink" href="#getdns.Result.answer_type" title="Permalink to this definition">¶</a></dt>
<dd><p>The <code class="docutils literal"><span class="pre">answer_type</span></code> attribute contains the type of data
that are returned (i.e., the namespace). The
<code class="docutils literal"><span class="pre">answer_type</span></code> attribute may have the following values:</p>
<dl class="data">
<dt id="getdns.Result.getdns.NAMETYPE_DNS">
<code class="descclassname">getdns.</code><code class="descname">NAMETYPE_DNS</code><a class="headerlink" href="#getdns.Result.getdns.NAMETYPE_DNS" title="Permalink to this definition">¶</a></dt>
<dd><p>Normal DNS (<span class="target" id="index-0"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc1035.html"><strong>RFC 1035</strong></a>)</p>
</dd></dl>
<dl class="data">
<dt id="getdns.Result.getdns.NAMETYPE_WINS">
<code class="descclassname">getdns.</code><code class="descname">NAMETYPE_WINS</code><a class="headerlink" href="#getdns.Result.getdns.NAMETYPE_WINS" title="Permalink to this definition">¶</a></dt>
<dd><p>The WINS name service (some reference needed)</p>
</dd></dl>
</dd></dl>
<dl class="attribute">
<dt id="getdns.Result.canonical_name">
<code class="descname">canonical_name</code><a class="headerlink" href="#getdns.Result.canonical_name" title="Permalink to this definition">¶</a></dt>
<dd><p>The value of <code class="docutils literal"><span class="pre">canonical_name</span></code> is the name that the API used for its lookup. It is in FQDN presentation format.</p>
</dd></dl>
<dl class="attribute">
<dt id="getdns.Result.just_address_answers">
<code class="descname">just_address_answers</code><a class="headerlink" href="#getdns.Result.just_address_answers" title="Permalink to this definition">¶</a></dt>
<dd><p>If the call was <code class="xref py py-meth docutils literal"><span class="pre">address()</span></code>, the
attribute
<code class="docutils literal"><span class="pre">just_address_answers</span></code> (a list) is non-null. The value of
<code class="docutils literal"><span class="pre">just_address_answers</span></code> is a list that contains all of the A
and AAAA records from the <code class="docutils literal"><span class="pre">answer</span></code> sections of any of the
replies, in the order they appear in the replies. Each item
in the list is a dict with at least two names: <code class="docutils literal"><span class="pre">address_type</span></code>
(a string whose value is either “IPv4” or
“IPv6”) and <code class="docutils literal"><span class="pre">address_data</span></code> (whose value is a string representation of
an IP address). Note
that the <code class="docutils literal"><span class="pre">dnssec_return_only_secure</span></code> extension affects what
will appear in the just_address_answers list. Also note if
later versions of the DNS return other address types, those
types will appear in this list as well.</p>
</dd></dl>
<dl class="attribute">
<dt id="getdns.Result.replies_full">
<code class="descname">replies_full</code><a class="headerlink" href="#getdns.Result.replies_full" title="Permalink to this definition">¶</a></dt>
<dd><p>The <code class="docutils literal"><span class="pre">replies_full</span></code> attribute is a Python dictionary
containing the entire set of records returned by the
query.</p>
<p>The following lists the status codes for response
objects. Note that, if the status is that there are no
responses for the query, the lists in <code class="docutils literal"><span class="pre">replies_full</span></code> and
<code class="docutils literal"><span class="pre">replies_tree</span></code> will have zero length.</p>
<p>The top level of <code class="docutils literal"><span class="pre">replies_tree</span></code> can optionally have the
following names: <code class="docutils literal"><span class="pre">canonical_name</span></code>,
<code class="docutils literal"><span class="pre">intermediate_aliases</span></code> (a list), <code class="docutils literal"><span class="pre">answer_ipv4_address</span></code>
<code class="docutils literal"><span class="pre">answer_ipv6_address</span></code>, and <code class="docutils literal"><span class="pre">answer_type</span></code>
(an integer constant.).</p>
<ul class="simple">
<li>The value of <code class="docutils literal"><span class="pre">canonical_name</span></code> is the name that the API used for its lookup. It is in FQDN presentation format.</li>
<li>The values in the <code class="docutils literal"><span class="pre">intermediate_aliases</span></code> list are domain
names from any CNAME or unsynthesized DNAME found when
resolving the original query. The list might have zero
entries if there were no CNAMEs in the path. These may
be useful, for example, for name comparisons when
following the rules in RFC 6125.</li>
<li>The value of <code class="docutils literal"><span class="pre">answer_ipv4_address</span></code> and
<code class="docutils literal"><span class="pre">answer_ipv6_address</span></code> are the addresses of the server
from which the answer was received.</li>
<li>The value of <code class="docutils literal"><span class="pre">answer_type</span></code> is the type of name service that generated the response. The values are:</li>
</ul>
<p>If the call was <code class="xref py py-meth docutils literal"><span class="pre">address()</span></code>, the
top level of <code class="docutils literal"><span class="pre">replies_tree</span></code> has an additional name,
<code class="docutils literal"><span class="pre">just_address_answers</span></code> (a list). The value of
<code class="docutils literal"><span class="pre">just_address_answers</span></code> is a list that contains all of the A
and AAAA records from the <code class="docutils literal"><span class="pre">answer</span></code> sections of any of the
replies, in the order they appear in the replies. Each item
in the list is a dict with at least two names: <code class="docutils literal"><span class="pre">address_type</span></code>
(a string whose value is either “IPv4” or
“IPv6”) and <code class="docutils literal"><span class="pre">address_data</span></code> (whose value is a string representation of
an IP address). Note
that the <code class="docutils literal"><span class="pre">dnssec_return_only_secure</span></code> extension affects what
will appear in the just_address_answers list. Also note if
later versions of the DNS return other address types, those
types will appear in this list as well.</p>
<p>The API can make service discovery through SRV records
easier. If the call was <code class="xref py py-meth docutils literal"><span class="pre">service()</span></code>, the top level of <code class="docutils literal"><span class="pre">replies_tree</span> <span class="pre">has</span></code> an
additional name, <code class="docutils literal"><span class="pre">srv_addresses</span></code> (a list). The list is ordered
by priority and weight based on the weighting algorithm in
<span class="target" id="index-1"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2782.html"><strong>RFC 2782</strong></a>, lowest priority value first. Each element of the
list is a dictionary that has at least two names: <code class="docutils literal"><span class="pre">port</span></code> and
<code class="docutils literal"><span class="pre">domain_name</span></code>. If the API was able to determine the address of
the target domain name (such as from its cache or from the
Additional section of responses), the dict for an element
will also contain <code class="docutils literal"><span class="pre">address_type</span></code> (whose value
is currently either “IPv4” or “IPv6”) and <code class="docutils literal"><span class="pre">address_data</span></code>
(whose value is a string representation of an IP address). Note that the
<code class="docutils literal"><span class="pre">dnssec_return_only_secure</span></code> extension affects what will appear
in the <code class="docutils literal"><span class="pre">srv_addresses</span></code> list.</p>
</dd></dl>
<dl class="attribute">
<dt id="getdns.Result.validation_chain">
<code class="descname">validation_chain</code><a class="headerlink" href="#getdns.Result.validation_chain" title="Permalink to this definition">¶</a></dt>
<dd><p>The <code class="docutils literal"><span class="pre">validation_chain</span></code> attribute is a Python list
containing the set of DNSSEC-related records needed for
validation of a particular response. This set comes as
validation_chain (a list) at the top level of the
response object. This list includes all resource record
dicts for all the resource records (DS, DNSKEY and their
RRSIGs) that are needed to perform the validation from
the root up.</p>
</dd></dl>
<dl class="attribute">
<dt id="getdns.Result.call_reporting">
<code class="descname">call_reporting</code><a class="headerlink" href="#getdns.Result.call_reporting" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of dictionaries containing call_debugging
information, if requested in the query.</p>
</dd></dl>
<dl class="attribute">
<dt id="getdns.Result.replies_tree">
<code class="descname">replies_tree</code><a class="headerlink" href="#getdns.Result.replies_tree" title="Permalink to this definition">¶</a></dt>
<dd><p>The names in each entry in the the <code class="docutils literal"><span class="pre">replies_tree</span></code> list for DNS
responses include <code class="docutils literal"><span class="pre">header</span></code> (a dict), <code class="docutils literal"><span class="pre">question</span></code> (a dict), <code class="docutils literal"><span class="pre">answer</span></code>
(a list), <code class="docutils literal"><span class="pre">authority</span></code> (a list), and <code class="docutils literal"><span class="pre">additional</span></code> (a list),
corresponding to the sections in the DNS message format. The
<code class="docutils literal"><span class="pre">answer</span></code>, <code class="docutils literal"><span class="pre">authority</span></code>, and <code class="docutils literal"><span class="pre">additional</span></code> lists each contain zero or
more dicts, with each dict in each list representing a
resource record.</p>
<p>The names in the <code class="docutils literal"><span class="pre">header</span></code> dict are all the fields from
<span class="target" id="index-2"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc1035.html#section-4.1.1"><strong>RFC 1035#section-4.1.1</strong></a>.
They are: <code class="docutils literal"><span class="pre">id</span></code>, <code class="docutils literal"><span class="pre">qr</span></code>, <code class="docutils literal"><span class="pre">opcode</span></code>, <code class="docutils literal"><span class="pre">aa</span></code>, <code class="docutils literal"><span class="pre">tc</span></code>, <code class="docutils literal"><span class="pre">rd</span></code>,
<code class="docutils literal"><span class="pre">ra</span></code>, <code class="docutils literal"><span class="pre">z</span></code>, <code class="docutils literal"><span class="pre">rcode</span></code>, <code class="docutils literal"><span class="pre">qdcount</span></code>, <code class="docutils literal"><span class="pre">ancount</span></code>, <code class="docutils literal"><span class="pre">nscount</span></code>, and <code class="docutils literal"><span class="pre">arcount</span></code>. All
are integers.</p>
<p>The names in the <code class="docutils literal"><span class="pre">question</span></code> dict are the three fields from
<span class="target" id="index-3"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc1035.html#section-4.1.2"><strong>RFC 1035#section-4.1.2</strong></a>: <code class="docutils literal"><span class="pre">qname</span></code>, <code class="docutils literal"><span class="pre">qtype</span></code>, and <code class="docutils literal"><span class="pre">qclass</span></code>.</p>
<p>Resource records are a bit different than headers and
question sections in that the RDATA portion often has its
own structure. The other names in the resource record dictionaries
are <code class="docutils literal"><span class="pre">name</span></code>, <code class="docutils literal"><span class="pre">type</span></code>, <code class="docutils literal"><span class="pre">class</span></code>, <code class="docutils literal"><span class="pre">ttl</span></code>,
and <code class="docutils literal"><span class="pre">rdata</span></code> (which is a dict); there is no name equivalent to the
RDLENGTH field. The OPT resource record does not have the
<code class="docutils literal"><span class="pre">class</span></code> and the <code class="docutils literal"><span class="pre">ttl</span></code> name, but instead provides
<code class="docutils literal"><span class="pre">udp_payload_size</span></code>, <code class="docutils literal"><span class="pre">extended_rcode</span></code>, <code class="docutils literal"><span class="pre">version</span></code>,
<code class="docutils literal"><span class="pre">do</span></code>, and <code class="docutils literal"><span class="pre">z</span></code>.</p>
<p>The <code class="docutils literal"><span class="pre">rdata</span></code> dictionary has different names for each response
type. There is a complete list of the types defined in the
API. For names that end in “-obsolete” or “-unknown”, the
data are the entire RDATA field. For example, the <code class="docutils literal"><span class="pre">rdata</span></code>
for an A record has a name <code class="docutils literal"><span class="pre">ipv4_address</span></code>; the
rdata for an SRV record has the names <code class="docutils literal"><span class="pre">priority</span></code>,
<code class="docutils literal"><span class="pre">weight</span></code>, <code class="docutils literal"><span class="pre">port</span></code>, and <code class="docutils literal"><span class="pre">target</span></code>.</p>
<p>Each rdata dict also has a <code class="docutils literal"><span class="pre">rdata_raw</span></code> element. This
is useful for types not defined in this version of the
API. It also might be of value if a later version of the API
allows for additional parsers. Thus, doing a query for types
not known by the API still will return a result: an <code class="docutils literal"><span class="pre">rdata</span></code>
with just a <code class="docutils literal"><span class="pre">rdata_raw</span></code>.</p>
<p>It is expected that later extensions to the API will give
some DNS types different names. It is also possible that
later extensions will change the names for some of the DNS
types listed above.</p>
<p>For example, a response to a Context.address() call for
www.example.com would look something like this:</p>
</dd></dl>
</dd></dl>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="c1"># This is the response object</span>
<span class="s2">"replies_full"</span><span class="p">:</span> <span class="p">[</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="n">the</span> <span class="n">first</span> <span class="n">response</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="n">the</span> <span class="n">second</span> <span class="n">response</span><span class="o">></span> <span class="p">],</span>
<span class="s2">"just_address_answers"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<span class="s2">"address_type"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="s2">"IPv4"</span><span class="o">></span><span class="p">,</span>
<span class="s2">"address_data"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="mh">0x0a0b0c01</span><span class="o">></span><span class="p">,</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">"address_type"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="s2">"IPv6"</span><span class="o">></span><span class="p">,</span>
<span class="s2">"address_data"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="mh">0x33445566334455663344556633445566</span><span class="o">></span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s2">"canonical_name"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="s2">"www.example.com"</span><span class="o">></span><span class="p">,</span>
<span class="s2">"answer_type"</span><span class="p">:</span> <span class="n">NAMETYPE_DNS</span><span class="p">,</span>
<span class="s2">"intermediate_aliases"</span><span class="p">:</span> <span class="p">[],</span>
<span class="s2">"replies_tree"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span> <span class="c1"># This is the first reply</span>
<span class="s2">"header"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="mi">23456</span><span class="p">,</span> <span class="s2">"qr"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"opcode"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"question"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"qname"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="s2">"www.example.com"</span><span class="o">></span><span class="p">,</span> <span class="s2">"qtype"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"qclass"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">},</span>
<span class="s2">"answer"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<span class="s2">"name"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="s2">"www.example.com"</span><span class="o">></span><span class="p">,</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"class"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">33000</span><span class="p">,</span>
<span class="s2">"rdata"</span><span class="p">:</span>
<span class="p">{</span>
<span class="s2">"ipv4_address"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="mh">0x0a0b0c01</span><span class="o">></span>
<span class="s2">"rdata_raw"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="mh">0x0a0b0c01</span><span class="o">></span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s2">"authority"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<span class="s2">"name"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="s2">"ns1.example.com"</span><span class="o">></span><span class="p">,</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"class"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">600</span><span class="p">,</span>
<span class="s2">"rdata"</span><span class="p">:</span>
<span class="p">{</span>
<span class="s2">"ipv4_address"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="mh">0x65439876</span><span class="o">></span>
<span class="s2">"rdata_raw"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="mh">0x65439876</span><span class="o">></span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="s2">"additional"</span><span class="p">:</span> <span class="p">[],</span>
<span class="s2">"canonical_name"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="s2">"www.example.com"</span><span class="o">></span><span class="p">,</span>
<span class="s2">"answer_type"</span><span class="p">:</span> <span class="n">NAMETYPE_DNS</span>
<span class="p">},</span>
<span class="p">{</span> <span class="c1"># This is the second reply</span>
<span class="s2">"header"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="mi">47809</span><span class="p">,</span> <span class="s2">"qr"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"opcode"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="o">...</span> <span class="p">},</span>
<span class="s2">"question"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"qname"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="s2">"www.example.com"</span><span class="o">></span><span class="p">,</span> <span class="s2">"qtype"</span><span class="p">:</span> <span class="mi">28</span><span class="p">,</span> <span class="s2">"qclass"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">},</span>
<span class="s2">"answer"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
<span class="s2">"name"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="s2">"www.example.com"</span><span class="o">></span><span class="p">,</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="mi">28</span><span class="p">,</span>
<span class="s2">"class"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">1000</span><span class="p">,</span>
<span class="s2">"rdata"</span><span class="p">:</span>
<span class="p">{</span>
<span class="s2">"ipv6_address"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="mh">0x33445566334455663344556633445566</span><span class="o">></span>
<span class="s2">"rdata_raw"</span><span class="p">:</span> <span class="o"><</span><span class="n">bindata</span> <span class="n">of</span> <span class="mh">0x33445566334455663344556633445566</span><span class="o">></span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s2">"authority"</span><span class="p">:</span> <span class="p">[</span> <span class="c1"># Same as for other record... ]</span>
<span class="s2">"additional"</span><span class="p">:</span> <span class="p">[],</span>
<span class="p">},</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="return-codes">
<h2>Return Codes<a class="headerlink" href="#return-codes" title="Permalink to this headline">¶</a></h2>
<p>The return codes for all the functions are:</p>
<dl class="data">
<dt id="getdns.RETURN_GOOD">
<code class="descclassname">getdns.</code><code class="descname">RETURN_GOOD</code><a class="headerlink" href="#getdns.RETURN_GOOD" title="Permalink to this definition">¶</a></dt>
<dd><p>Good</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_GENERIC_ERROR">
<code class="descclassname">getdns.</code><code class="descname">RETURN_GENERIC_ERROR</code><a class="headerlink" href="#getdns.RETURN_GENERIC_ERROR" title="Permalink to this definition">¶</a></dt>
<dd><p>Generic error</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_BAD_DOMAIN_NAME">
<code class="descclassname">getdns.</code><code class="descname">RETURN_BAD_DOMAIN_NAME</code><a class="headerlink" href="#getdns.RETURN_BAD_DOMAIN_NAME" title="Permalink to this definition">¶</a></dt>
<dd><p>Badly-formed domain name in first argument</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_BAD_CONTEXT">
<code class="descclassname">getdns.</code><code class="descname">RETURN_BAD_CONTEXT</code><a class="headerlink" href="#getdns.RETURN_BAD_CONTEXT" title="Permalink to this definition">¶</a></dt>
<dd><p>The context has internal deficiencies</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_CONTEXT_UPDATE_FAIL">
<code class="descclassname">getdns.</code><code class="descname">RETURN_CONTEXT_UPDATE_FAIL</code><a class="headerlink" href="#getdns.RETURN_CONTEXT_UPDATE_FAIL" title="Permalink to this definition">¶</a></dt>
<dd><p>Did not update the context</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_UNKNOWN_TRANSACTION">
<code class="descclassname">getdns.</code><code class="descname">RETURN_UNKNOWN_TRANSACTION</code><a class="headerlink" href="#getdns.RETURN_UNKNOWN_TRANSACTION" title="Permalink to this definition">¶</a></dt>
<dd><p>An attempt was made to cancel a callback with a transaction_id that is not recognized</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_NO_SUCH_LIST_ITEM">
<code class="descclassname">getdns.</code><code class="descname">RETURN_NO_SUCH_LIST_ITEM</code><a class="headerlink" href="#getdns.RETURN_NO_SUCH_LIST_ITEM" title="Permalink to this definition">¶</a></dt>
<dd><p>A helper function for lists had an index argument that was too high.</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_NO_SUCH_DICT_NAME">
<code class="descclassname">getdns.</code><code class="descname">RETURN_NO_SUCH_DICT_NAME</code><a class="headerlink" href="#getdns.RETURN_NO_SUCH_DICT_NAME" title="Permalink to this definition">¶</a></dt>
<dd><p>A helper function for dicts had a name argument that for a name that is not in the dict.</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_WRONG_TYPE_REQUESTED">
<code class="descclassname">getdns.</code><code class="descname">RETURN_WRONG_TYPE_REQUESTED</code><a class="headerlink" href="#getdns.RETURN_WRONG_TYPE_REQUESTED" title="Permalink to this definition">¶</a></dt>
<dd><p>A helper function was supposed to return a certain type for an item, but the wrong type was given.</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_NO_SUCH_EXTENSION">
<code class="descclassname">getdns.</code><code class="descname">RETURN_NO_SUCH_EXTENSION</code><a class="headerlink" href="#getdns.RETURN_NO_SUCH_EXTENSION" title="Permalink to this definition">¶</a></dt>
<dd><p>A name in the extensions dict is not a valid extension.</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_EXTENSION_MISFORMAT">
<code class="descclassname">getdns.</code><code class="descname">RETURN_EXTENSION_MISFORMAT</code><a class="headerlink" href="#getdns.RETURN_EXTENSION_MISFORMAT" title="Permalink to this definition">¶</a></dt>
<dd><p>One or more of the extensions have a bad format.</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_DNSSEC_WITH_STUB_DISALLOWED">
<code class="descclassname">getdns.</code><code class="descname">RETURN_DNSSEC_WITH_STUB_DISALLOWED</code><a class="headerlink" href="#getdns.RETURN_DNSSEC_WITH_STUB_DISALLOWED" title="Permalink to this definition">¶</a></dt>
<dd><p>A query was made with a context that is using stub resolution and a DNSSEC extension specified.</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_MEMORY_ERROR">
<code class="descclassname">getdns.</code><code class="descname">RETURN_MEMORY_ERROR</code><a class="headerlink" href="#getdns.RETURN_MEMORY_ERROR" title="Permalink to this definition">¶</a></dt>
<dd><p>Unable to allocate the memory required.</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_INVALID_PARAMETER">
<code class="descclassname">getdns.</code><code class="descname">RETURN_INVALID_PARAMETER</code><a class="headerlink" href="#getdns.RETURN_INVALID_PARAMETER" title="Permalink to this definition">¶</a></dt>
<dd><p>A required parameter had an invalid value.</p>
</dd></dl>
<dl class="data">
<dt id="getdns.RETURN_NOT_IMPLEMENTED">
<code class="descclassname">getdns.</code><code class="descname">RETURN_NOT_IMPLEMENTED</code><a class="headerlink" href="#getdns.RETURN_NOT_IMPLEMENTED" title="Permalink to this definition">¶</a></dt>
<dd><p>The requested API feature is not implemented.</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal"><span class="pre">getdns</span></code> response data</a><ul>
<li><a class="reference internal" href="#response-data-from-queries">Response data from queries</a></li>
<li><a class="reference internal" href="#return-codes">Return Codes</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="functions.html"
title="previous chapter"><code class="docutils literal"><span class="pre">getdns</span></code> reference</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="exceptions.html"
title="next chapter"><code class="docutils literal"><span class="pre">getdns</span></code> exceptions</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/response.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="exceptions.html" title="getdns exceptions"
>next</a> |</li>
<li class="right" >
<a href="functions.html" title="getdns reference"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">getdns v1.0.0b1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2018, Verisign Labs, NLnet Labs.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
</div>
</body>
</html>
|