mirror of
https://github.com/VinylDNS/vinyldns
synced 2025-09-05 08:45:11 +00:00
181 lines
18 KiB
HTML
181 lines
18 KiB
HTML
|
<html><head><title>VinylDNS: Get Batch Change</title><meta charset="utf-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /><meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="VinylDNS" /><meta name="description" content="DNS Management Platform" /><meta name="og:image" content="/img/poster.png" /><meta name="og:title" content="VinylDNS: Get Batch Change" /><meta name="og:site_name" content="VinylDNS" /><meta name="og:url" content="http://vinyldns.io" /><meta name="og:type" content="website" /><meta name="og:description" content="DNS Management Platform" /><link rel="icon" type="image/png" href="/img/favicon.png" /><meta name="twitter:title" content="VinylDNS: Get Batch Change" /><meta name="twitter:image" content="http://vinyldns.ioimg/poster.png" /><meta name="twitter:description" content="DNS Management Platform" /><meta name="twitter:card" content="summary_large_image" /><link rel="icon" type="image/png" sizes="16x16" href="/img/favicon16x16.png" /><link rel="icon" type="image/png" sizes="24x24" href="/img/favicon24x24.png" /><link rel="icon" type="image/png" sizes="32x32" href="/img/favicon32x32.png" /><link rel="icon" type="image/png" sizes="48x48" href="/img/favicon48x48.png" /><link rel="icon" type="image/png" sizes="57x57" href="/img/favicon57x57.png" /><link rel="icon" type="image/png" sizes="60x60" href="/img/favicon60x60.png" /><link rel="icon" type="image/png" sizes="64x64" href="/img/favicon64x64.png" /><link rel="icon" type="image/png" sizes="70x70" href="/img/favicon70x70.png" /><link rel="icon" type="image/png" sizes="72x72" href="/img/favicon72x72.png" /><link rel="icon" type="image/png" sizes="76x76" href="/img/favicon76x76.png" /><link rel="icon" type="image/png" sizes="96x96" href="/img/favicon96x96.png" /><link rel="icon" type="image/png" sizes="114x114" href="/img/favicon114x114.png" /><link rel="icon" type="image/png" sizes="120x120" href="/img/favicon120x120.png" /><link rel="icon" type="image/png" sizes="128x128" href="/img/favicon128x128.png" /><link rel="icon" type="image/png" sizes="144x144" href="/img/favicon144x144.png" /><link rel="icon" type="image/png" sizes="150x150" href="/img/favicon150x150.png" /><link rel="icon" type="image/png" sizes="152x152" href="/img/favicon152x152.png" /><link rel="icon" type="image/png" sizes="196x196" href="/img/favicon196x196.png" /><link rel="icon" type="image/png" sizes="310x310" href="/img/favicon310x310.png" /><link rel="icon" type="image/png" sizes="310x150" href="/img/favicon310x150.png" /><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" /><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" /><link rel="stylesheet" href="/highlight/styles/default.css" /><link rel="stylesheet" href="/css/style.css" /><link rel="stylesheet" href="/css/palette.css" /><link rel="stylesheet" href="/css/codemirror.css" /><link rel="stylesheet" href="/css/custom.css" /></head><body class="docs"><div id="wrapper"><div id="sidebar-wrapper"><ul id="sidebar" class="sidebar-nav"><li class="sidebar-brand"><a href="/" class="brand"><div class="brand-wrapper"><span>VinylDNS</span></div></a></li> <li><a href="/api/index" class="">API documentation</a></li> <li><a href="/api/auth-mechanism.html" class="">Authentication</a></li> <li><a href="/api/zone-model.html" class="">Zone</a> <ul class="sub_section"> <li><a href="/api/zone-model.html" class="">Zone Model</a></li> <li><a href="/api/create-zone.html" class="">Create Zone</a></li> <li><a href="/api/update-zone.html" class="">Update Zone</a></li> <li><a href="/api/delete-zone.html" class="">Delete Zone</a></li> <li><a href="/api/get-zone-by-id.html" class="">Get Zone by ID</a></li> <li><a href="/api/get-zone-by-name.html" class="">Get Zone by Name</a></li> <li><a href="/api/list-zones.html" class="">List / Search Zone</a></li> <li><a href="/api/sync-zone.html" class="">Sync Zone</a></li> <li><a href="/api/list-zone-changes.html" class="">List Zone Changes
|
||
|
|
|
||
|
|
<p>Retrieves a batch change given the batch change ID. Only the user who created a batch change and VinylDNS administrators will have access to get it.</p>
|
||
|
|
|
||
|
|
<h4 id="http-request">HTTP REQUEST</h4>
|
||
|
|
|
||
|
|
<blockquote>
|
||
|
|
<p>GET /zones/batchrecordchanges/{id}</p>
|
||
|
|
</blockquote>
|
||
|
|
|
||
|
|
<h4 id="http-request-params">HTTP REQUEST PARAMS</h4>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>name</th>
|
||
|
|
<th style="text-align: left">type</th>
|
||
|
|
<th>required?</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>id</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td>yes</td>
|
||
|
|
<td style="text-align: left">Unique identifier assigned to each created batch change.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h4 id="http-response-types">HTTP RESPONSE TYPES</h4>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Code</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>200</td>
|
||
|
|
<td style="text-align: left"><strong>OK</strong> - The batch change is returned in response body.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>403</td>
|
||
|
|
<td style="text-align: left"><strong>Forbidden</strong> - The user does not have the access required to perform the action.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>404</td>
|
||
|
|
<td style="text-align: left"><strong>Not Found</strong> - Batch change not found.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h4 id="http-response-attributes-">HTTP RESPONSE ATTRIBUTES <a id="http-response-attributes"></a></h4>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>name</th>
|
||
|
|
<th style="text-align: left">type</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>userId</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">The unique identifier of the user that created the batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>userName</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">The username of the user that created the batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>comments</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">Optional comments about the batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>createdTimestamp</td>
|
||
|
|
<td style="text-align: left">date-time</td>
|
||
|
|
<td style="text-align: left">The timestamp (UTC) when the batch change was created.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>changes</td>
|
||
|
|
<td style="text-align: left">Array of SingleChange</td>
|
||
|
|
<td style="text-align: left">Array of single changes within a batch change. A <em>SingleChange</em> can either be a <a href="../api/batchchange-model#singleaddchange-attributes">SingleAddChange</a> or a <a href="../api/batchchange-model#singledeleterrsetchange-">SingleDeleteRRSetChange</a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>status</td>
|
||
|
|
<td style="text-align: left">BatchChangeStatus</td>
|
||
|
|
<td style="text-align: left"><a href="../api/batchchange-model#batchchange-attributes">Status of the batch change</a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>id</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">The unique identifier for this batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>scheduledTime</td>
|
||
|
|
<td style="text-align: left">date-time</td>
|
||
|
|
<td style="text-align: left">Optional requested date and time to process the batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>approvalStatus</td>
|
||
|
|
<td style="text-align: left">BatchChangeApprovalStatus</td>
|
||
|
|
<td style="text-align: left"><a href="../api/batchchange-model#batchchange-attributes">Approval status of the batch change</a>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>reviewerId</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">Optional identifier of reviewer if batch change required manual review</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>reviewComment</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">Optional comment by reviewer if batch change required manual review</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>reviewTimestamp</td>
|
||
|
|
<td style="text-align: left">date-time</td>
|
||
|
|
<td style="text-align: left">Optional timestamp (UTC) when the batch change was reviewed if manual review was required.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>cancelledTimestamp</td>
|
||
|
|
<td style="text-align: left">date-time</td>
|
||
|
|
<td style="text-align: left">Optional timestamp (UTC) if the batch change was cancelled by the creator</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h4 id="example-response">EXAMPLE RESPONSE</h4>
|
||
|
|
|
||
|
|
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nt">"userId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"userName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl201"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"comments"</span><span class="p">:</span><span class="w"> </span><span class="s2">"this is optional"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"createdTimestamp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-05-09T14:19:34Z"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"changes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nt">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Add"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"parent.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"ttl"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"record"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nt">"address"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4.5.6.7"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"recordName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"parent.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"zoneName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"parent.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"zoneId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"74e93bfc-7296-4b86-83d3-1ffcb0eb3d13"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"recordChangeId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a07299ce-5f81-11e8-9c2d-fa7ae01bbebc"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"recordSetId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0729f00-5f81-11e8-9c2d-fa7ae01bbebc"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7573ca11-3e30-45a8-9ba5-791f7d6ae7a7"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nt">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DeleteRecordSet"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"deleting.parent.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CNAME"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"recordName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"deleting"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"zoneName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"parent.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"zoneId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"74e93bfc-7296-4b86-83d3-1ffcb0eb3d13"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"recordChangeId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bed15986-5f82-11e8-9c2d-fa7ae01bbebc"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"recordSetId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c089e52c-5f82-11e8-9c2d-fa7ae01bbebc"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7573ca11-3e30-45a8-9ba5-791f7d6ae7a7"</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span><span class="p">],</span><span class="w">
|
||
|
|
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PendingProcessing"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"02bd95f4-a32c-443b-82eb-54dbaa55b31a"</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span></code></pre>
|
||
|
|
</div>
|
||
|
|
</section><div class="edit-button"><a href="https://github.com/VinylDNS/vinyldns/edit/master/modules/docs/src/main/tut/api/get-batchchange.md" class="btn-sm btn-info">Improve this page</a></div></div></div></div></div><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js"></script><script src="/highlight/highlight.pack.js"></script><script>hljs.configure({languages:['scala','java','bash']});
|
||
|
|
hljs.initHighlighting();
|
||
|
|
</script><script>((window.gitter = {}).chat = {}).options = {
|
||
|
|
room: 'vinyldns/Lobby'};</script><script src="https://sidecar.gitter.im/dist/sidecar.v1.js"></script><script src="/js/main.js"></script></body></html>
|