vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dns/api-ref/dns_api_64003.html
Qin Ying, Fan a79d5bdbdb DNS API 1017 version 
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2022-10-20 13:26:00 +00:00

498 lines
40 KiB
HTML
Raw Blame History

<a name="dns_api_64003"></a><a name="dns_api_64003"></a>
<h1 class="topictitle1">Querying All Record Sets</h1>
<div id="body17230008"><div class="section" id="dns_api_64003__section29105235"><h4 class="sectiontitle">Function</h4><p id="dns_api_64003__p4510145165515">Query record sets in list.</p>
</div>
<div class="section" id="dns_api_64003__section60620523"><h4 class="sectiontitle">URI</h4><p id="dns_api_64003__p14179038194813">GET /v2/recordsets?zone_type={zone_type}&amp;limit={limit}&amp;marker={marker}&amp;offset={offset}&amp;tags={tags}&amp;status={status}&amp;type={type}&amp;name={name}&amp;id={id}&amp;records={records}&amp;sort_key={sort_key}&amp;sort_dir={sort_dir}</p>
<div class="p" id="dns_api_64003__p16942056191210">For details, see <a href="#dns_api_64003__table40248354">Table 1</a>.
<div class="tablenoborder"><a name="dns_api_64003__table40248354"></a><a name="table40248354"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64003__table40248354" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the URI</caption><thead align="left"><tr id="dns_api_64003__row24110047"><th align="left" class="cellrowborder" valign="top" width="17.57%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dns_api_64003__p6756797"><strong id="dns_api_64003__b162774213314533">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.81%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dns_api_64003__p10429724"><strong id="dns_api_64003__b593421527191713">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.200000000000001%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dns_api_64003__p39501348"><strong id="dns_api_64003__b84235270619112">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.419999999999995%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dns_api_64003__p45492604"><strong id="dns_api_64003__b842352706112423">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64003__row67046586114158"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p10129219114159">zone_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p15160399114159">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p20032767114159">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p12041403114159">Zone type of the record set to be queried, which can be <strong id="dns_api_64003__b842352706203526">public</strong> or <strong id="dns_api_64003__b842352706203523">private</strong></p>
<ul id="dns_api_64003__ul35829612114159"><li id="dns_api_64003__li16517498114159"><strong id="dns_api_64003__b842352706203559">public</strong>: Record sets in public zones are queried.</li><li id="dns_api_64003__li14439759114159"><strong id="dns_api_64003__b842352706203618">private</strong>: Record sets in private zones are queried.<p id="dns_api_64003__p5693402220383">If the value is left blank, record sets in public zones are queried by default.</p>
</li></ul>
<p id="dns_api_64003__p89402038132417">A fuzzy search will be performed.</p>
<p id="dns_api_64003__p189098471136">The default value is <strong id="dns_api_64003__b111369565144">public</strong>.</p>
</td>
</tr>
<tr id="dns_api_64003__row61022284"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p43857981">marker</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p62835574">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p56516768">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p3582346592940">Start resource ID of pagination query</p>
<p id="dns_api_64003__p14455523">If the parameter is left blank, only resources on the first page are queried.</p>
<p id="dns_api_64003__p1426623319131">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64003__row62990845"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p1984791">limit</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p26550365">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p3095993">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p230120311413">Number of resources on each page</p>
<p id="dns_api_64003__p147131447514">The value ranges from <strong id="dns_api_64003__b1093220785318">0</strong> to <strong id="dns_api_64003__b7944127115313">500</strong>.</p>
<p id="dns_api_64003__p1385813431412">Commonly used values are <strong id="dns_api_64003__b164131055114215">10</strong>, <strong id="dns_api_64003__b4413455184213">20</strong>, and <strong id="dns_api_64003__b4414155514210">50</strong>. The default value is <strong id="dns_api_64003__b035705674217">500</strong>.</p>
</td>
</tr>
<tr id="dns_api_64003__row78856519552"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p5702070419554">offset</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p5527430219554">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p4803348119554">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p35951433204916">Start offset of pagination query. The query will start from the next resource of the offset value.</p>
<p id="dns_api_64003__p18898143914915">The value ranges from <strong id="dns_api_64003__b55299225913">0</strong> to <strong id="dns_api_64003__b1734310193910">2147483647</strong>.</p>
<p id="dns_api_64003__p13209172234718">The default value is <strong id="dns_api_64003__b462792814914">0</strong>.</p>
<p id="dns_api_64003__p167712216335">If <strong id="dns_api_64003__b970712258117">marker</strong> is not left blank, the query starts from the resource specified by <strong id="dns_api_64003__b20707122591115">marker</strong>.</p>
</td>
</tr>
<tr id="dns_api_64003__row55044453115726"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p216770371221">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p110096061221">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p193628991221">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p248910051221">Resource tag</p>
<p id="dns_api_64003__p226924561221">The format is as follows: <strong id="dns_api_64003__b8423527069140">key1,value1|key2,value2</strong>.</p>
<p id="dns_api_64003__p40552875114139">Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,).</p>
<p id="dns_api_64003__p29055151221">The tags are in AND relationship.</p>
<p id="dns_api_64003__p59717447115129">For details, see <a href="dns_api_67001.html">Adding Resource Tags</a>.</p>
<p id="dns_api_64003__p1770514714203">An exact match will be performed. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk.</p>
<p id="dns_api_64003__p71284149127">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64003__row91871931125514"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p77524811122"></p>
<p id="dns_api_64003__p15187431105515">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p21877311559">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p18187143110551">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p181873314559">Status of the record sets to be queried</p>
<p id="dns_api_64003__p447517111159">The value can be <strong id="dns_api_64003__b8423527069500">ACTIVE</strong>, <strong id="dns_api_64003__b8423527069507">ERROR</strong>, <strong id="dns_api_64003__b84235270695013">DISABLE</strong>, <strong id="dns_api_64003__b84235270695021">FREEZE</strong>, <strong id="dns_api_64003__b84235270695028">PENDING_CREATE</strong>, <strong id="dns_api_64003__b84235270695036">PENDING_UPDATE</strong>, or <strong id="dns_api_64003__b84235270695044">PENDING_DELETE</strong>.</p>
<p id="dns_api_64003__p1641444019533">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
<p id="dns_api_64003__p1289715373203">A fuzzy search will be performed.</p>
<p id="dns_api_64003__p1135030171215">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64003__row1799821219113"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p4998111210116">type</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p89981512101120">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p399821215119">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p109982012141111">Type of the record sets to be queried</p>
<p id="dns_api_64003__p20817123416132">The value can be <strong id="dns_api_64003__dns_api_64001_b84235270693731">A</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693735">AAAA</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693738">MX</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693741">CNAME</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693746">TXT</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693755">NS</strong> (only in public zones), <strong id="dns_api_64003__dns_api_64001_b8423527069382">SRV</strong>, <strong id="dns_api_64003__dns_api_64001_b1379251315415">CAA</strong> (only in public zones), and <strong id="dns_api_64003__dns_api_64001_b8423527069385">PTR</strong> (only in private zones).</p>
<p id="dns_api_64003__p111997895417">For details, see <a href="dns_api_80005.html#dns_api_80005__section1188113824413">Record Set Type</a>.</p>
<p id="dns_api_64003__p13289122841911">An exact match will be performed.</p>
<p id="dns_api_64003__p8193193917127">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64003__row11927135213161"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p189276527168">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p19927752151617">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p1492719522167">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p11927252121613">Names of record sets to be queried</p>
<p id="dns_api_64003__p16251111519186">A fuzzy search will be performed.</p>
<p id="dns_api_64003__p1242174471218">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64003__row33603617197"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p13604691913">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p15360960192">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p4360869195">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p173609610193">IDs of record sets to be queried</p>
<p id="dns_api_64003__p20802163115183">A fuzzy search will be performed.</p>
<p id="dns_api_64003__p19284124741213">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64003__row191263112211"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p112614115211">records</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p81261211182110">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p131261311192119">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p260972615213">Value included in the values of record sets to be queried</p>
<p id="dns_api_64003__p64731727196">A fuzzy search will be performed.</p>
<p id="dns_api_64003__p6571155011120">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64003__row6672923143613"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p15674182317363">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p206741223103614">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p7674132316360">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p4674182316366">Sorting condition of the record set list</p>
<p id="dns_api_64003__p161032135113">The value can be:</p>
<ul id="dns_api_64003__ul1181955993116"><li id="dns_api_64003__li9819115973119"><strong id="dns_api_64003__b16739152220281">name</strong>: domain name</li><li id="dns_api_64003__li181945910317"><strong id="dns_api_64003__b65504239285">type</strong>: record set type</li></ul>
<p id="dns_api_64003__p980118577128">The default value is left blank, indicating that the records are not sorted.</p>
</td>
</tr>
<tr id="dns_api_64003__row11889126183816"><td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64003__p208891026103817">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64003__p4889162653813">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.200000000000001%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64003__p128891626133813">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.419999999999995%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64003__p116071347131216">Sorting order of the record set list</p>
<p id="dns_api_64003__p749316343213">The value can be:</p>
<ul id="dns_api_64003__ul18204217325"><li id="dns_api_64003__li3203210322"><strong id="dns_api_64003__b48031257142719">desc</strong>: descending order</li><li id="dns_api_64003__li162062117325"><strong id="dns_api_64003__b675075822710">asc</strong>: ascending order</li></ul>
<p id="dns_api_64003__p3562616138">The default value is left blank, indicating that the records are not sorted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="dns_api_64003__section8713795"><h4 class="sectiontitle">Request</h4><ul id="dns_api_64003__ul35351571269"><li id="dns_api_64003__li1053565782615">Request parameters<p id="dns_api_64003__p1815201642711"><a name="dns_api_64003__li1053565782615"></a><a name="li1053565782615"></a>None</p>
</li><li id="dns_api_64003__li4109190182715">Example request<p id="dns_api_64003__p1651121054613"><a name="dns_api_64003__li4109190182715"></a><a name="li4109190182715"></a>Query A record sets whose name contains <strong id="dns_api_64003__b1514323518118">www.example.com</strong> in private zones:</p>
<pre class="codeblock" id="dns_api_64003__codeblock828018404544">GET https://{DNS_Endpoint}/v2/recordsets?zone_type=private&amp;type=A&amp;name=www.example.com</pre>
</li></ul>
</div>
<div class="section" id="dns_api_64003__section11315292"><h4 class="sectiontitle">Response</h4><ul id="dns_api_64003__ul12693918"><li id="dns_api_64003__li47136405">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64003__table21574462" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response</caption><thead align="left"><tr id="dns_api_64003__row41580444"><th align="left" class="cellrowborder" valign="top" width="20.41%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dns_api_64003__p12572829"><strong id="dns_api_64003__b377729575">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.47%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dns_api_64003__p13543581"><strong id="dns_api_64003__b1341445031">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.120000000000005%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dns_api_64003__p23288300"><strong id="dns_api_64003__b1848013679">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64003__row986574513439"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64003__p977735394312">links</p>
</td>
<td class="cellrowborder" valign="top" width="23.47%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64003__p1577785318438">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.120000000000005%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64003__p1277713536436">Link to the current resource or other related resources. When a response is broken into pages, a <strong id="dns_api_64003__b320410191461">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_64003__p197771536439">For details, see <a href="#dns_api_64003__table354521744216">Table 5</a>.</p>
</td>
</tr>
<tr id="dns_api_64003__row7304143"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64003__p54764719">recordsets</p>
</td>
<td class="cellrowborder" valign="top" width="23.47%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64003__p1162515611711">Array of object</p>
</td>
<td class="cellrowborder" valign="top" width="56.120000000000005%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64003__p45797138">Record set list object. For details, see <a href="#dns_api_64003__table18580737">Table 3</a>.</p>
</td>
</tr>
<tr id="dns_api_64003__row2133747418458"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64003__p5781953918458">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="23.47%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64003__p5469790918458">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.120000000000005%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64003__p5673028518536">Total number of resources that meet the filter criteria. For details, see <a href="#dns_api_64003__table9971756154520">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="p" id="dns_api_64003__p43749884165817">
<div class="tablenoborder"><a name="dns_api_64003__table18580737"></a><a name="table18580737"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64003__table18580737" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong>recordsets</strong> field</caption><thead align="left"><tr id="dns_api_64003__rba3ac5c9022d433a9f831e45adb3139d"><th align="left" class="cellrowborder" valign="top" width="27.889999999999997%" id="mcps1.3.4.2.1.2.1.2.4.1.1"><p id="dns_api_64003__af45b6f861fca4148bdabcd3f04b3c585"><strong id="dns_api_64003__b1634256565">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.810000000000002%" id="mcps1.3.4.2.1.2.1.2.4.1.2"><p id="dns_api_64003__a7dd3d03763104b729e040e9492bc2ff8"><strong id="dns_api_64003__b568739825">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.3%" id="mcps1.3.4.2.1.2.1.2.4.1.3"><p id="dns_api_64003__ab5a394c2e4bf4013b8d26cdf12e57c24"><strong id="dns_api_64003__b160859305">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64003__r969f83cacc0d47e19b400db44bcefe5d"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__af7379915cb7e45518ad6389deb156c16">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__aed3fb97ef2c44649a4df091614a5fdd3">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__a7cf188e9e96542f4920ff0531e8a7bf3">Record set ID</p>
</td>
</tr>
<tr id="dns_api_64003__r3486bde187164f8d8778fd87d3c378f0"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__af845ec9aa4c54290a3c8253710222cbc">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__a184f428a9cd94ffc909dcb75a7f20ffd">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__a107054ce4de94723890caea30f5757d3">Record set name</p>
</td>
</tr>
<tr id="dns_api_64003__rddc62f3e40f94c23bde096ec169557a4"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__adf295748fce44c51ab15716d2fca7e7e">description</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__ac76f924adf39422283aa1be57fe006f0">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__a5b0ee15a497b4ab7a5dbb737c73626a2">Record set description</p>
</td>
</tr>
<tr id="dns_api_64003__re1cf9f7cd8b143b194cd280e116a4b9c"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__a584f07267f8348e292f92fb24c3f2fee">zone_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__ad1b9905e26094d0d88e276952e41441d">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__ad42f99ad578645c4b50dbf985a7162ab">Zone ID of the record set</p>
</td>
</tr>
<tr id="dns_api_64003__r3a794727d8344df49d5fbb7c99d30130"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__af604e2cdbefc46659353a86fd567eef0">zone_name</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__adc9bb6da8c5e47959baf489929313e42">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__a7356cfcfe3d949c8b76883578a681052">Zone name of the record set</p>
</td>
</tr>
<tr id="dns_api_64003__r398a51c6191240b9bdd29358f3410b73"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__a5bffae1635bd486cbf5ef03cdee9c0cd">type</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__a4d34d1f420ec42079710c4d92e0b7616">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__ad1150aaf4f1a44e997e3e03abe8c776e">Record set type</p>
<p id="dns_api_64003__p1351315573111">The value can be <strong id="dns_api_64003__dns_api_64001_b84235270693731_1">A</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693735_1">AAAA</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693738_1">MX</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693741_1">CNAME</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693746_1">TXT</strong>, <strong id="dns_api_64003__dns_api_64001_b84235270693755_1">NS</strong> (only in public zones), <strong id="dns_api_64003__dns_api_64001_b8423527069382_1">SRV</strong>, <strong id="dns_api_64003__dns_api_64001_b1379251315415_1">CAA</strong> (only in public zones), and <strong id="dns_api_64003__dns_api_64001_b8423527069385_1">PTR</strong> (only in private zones).</p>
<p id="dns_api_64003__p7402204505815">For details, see <a href="dns_api_80005.html#dns_api_80005__section1188113824413">Record Set Type</a>.</p>
</td>
</tr>
<tr id="dns_api_64003__r514c4f05b7164f9f9a757f7bd0b7e552"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__acc30ded7ad904dc19929667281bdf470">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__adca3e1dc109149ffbd6e40b7eb5ef0c8">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__p123031523174010">Record set cache duration (in second) on a local DNS server. The longer the duration is, the slower the update takes effect.</p>
<p id="dns_api_64003__p1030317233408">If your service address is frequently changed, set TTL to a smaller value.</p>
</td>
</tr>
<tr id="dns_api_64003__r7c6e7235e2784b7fabcc18251ddafcdc"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__a9f6e2cd5e50e4aa5847081725319268d">records</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__a691054f831a04fc6a8a0b5f8dacf3ab2">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__a8ad57aedc72349a29b1ee975b2518257">Record set value</p>
</td>
</tr>
<tr id="dns_api_64003__rf1e2aa6701db4f2a9599b86ee5c744e3"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__a18066d6aebd441efad61d00896e13f08">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__ab7a29ae554744d05875a8e818d1deec0">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__a77d8f72a4bdd45879c196c0160196f50">Time when the record set was created</p>
<p id="dns_api_64003__p1731444152613">The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.</p>
</td>
</tr>
<tr id="dns_api_64003__r442ce54f5a794788a7ccb195a4b044b1"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__a88e27c6c0c4c42819998a3fdbe2013a6">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__p15406328285">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__aa7cad34bafbc4911a8e4ee943de3d5c1">Time when the record set was updated</p>
<p id="dns_api_64003__p12611114912613">The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.</p>
</td>
</tr>
<tr id="dns_api_64003__ra1bb5c494baa45c093a0ed3ea3019fd3"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__aac1eb9d8c2344f97a7a0936bd02ef17b">status</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__a84dffb1a82884ef08a2aadb59bf7b646">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__a7a8d323b3b5740a88990f8f0a57b2d91">Resource status</p>
<p id="dns_api_64003__p1140919441254">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_64003__r1423508fa22543d8a613944e3903b99f"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__af26a0208c4c64ddd946c9b311972c864">default</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__a509867184c0e4465ab4619e9170ede0d">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__p1942025514322">Whether the record set is created by default</p>
<p id="dns_api_64003__p4056457114322">A default record set cannot be deleted.</p>
</td>
</tr>
<tr id="dns_api_64003__raf503e75a0204706bd483ee97ddbe730"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__a1c514643bb3f49c888508a07acb384cf">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__ade8bb3864367491084f4f4fe78e58a33">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__p4619625201026">Project ID of the record set</p>
</td>
</tr>
<tr id="dns_api_64003__rd3a029c667c546e295b038e8f38b71f6"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64003__a8779f70c5dc4414c8df0c2950001a653">links</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.2.1.2.4.1.2 "><p id="dns_api_64003__a51104ec0822b4bf4bf9018680539141a">Object</p>
</td>
<td class="cellrowborder" valign="top" width="48.3%" headers="mcps1.3.4.2.1.2.1.2.4.1.3 "><p id="dns_api_64003__p34781370143021">Link to the current resource or other related resources</p>
<p id="dns_api_64003__aa2a07c69de424ee5bd26b246f46c26c1">When a response is broken into pages, a <strong id="dns_api_64003__b22743378143011">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_64003__p1226974804620">For details, see <a href="#dns_api_64003__table354521744216">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="p" id="dns_api_64003__p6425142816407">
<div class="tablenoborder"><a name="dns_api_64003__table9971756154520"></a><a name="table9971756154520"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64003__table9971756154520" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="dns_api_64003__b2345340194717">metadata</strong> field</caption><thead align="left"><tr id="dns_api_64003__r1ee98e923a7c4bfcaa89e708d3fca79e"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.1.2.4.1.1"><p id="dns_api_64003__af493c2fde22f44069c2b5ea0467dfe89"><strong id="dns_api_64003__b1380816417478">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.1.2.4.1.2"><p id="dns_api_64003__a581940a484df4c8294e51f11391a23c8"><strong id="dns_api_64003__b504114029">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.1.2.4.1.3"><p id="dns_api_64003__a0301bbf5a1234ea3a88a104e1b4cff92"><strong id="dns_api_64003__b967654294720">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64003__r7cc02a0ecbd24482bca90faa98114b18"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.1.2.4.1.1 "><p id="dns_api_64003__a9234858cb2f447539b4b85a307884322">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.1.2.4.1.2 "><p id="dns_api_64003__af14a2a2c8f0345f4811bb21dd2a9b667">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.1.2.4.1.3 "><p id="dns_api_64003__a39058f9901c84eb9a776ca5cd44ede29">Number of resources that meet the filter criteria. The number is irrelevant to <strong id="dns_api_64003__b916954518478">limit</strong> or <strong id="dns_api_64003__b417094516477">offset</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="dns_api_64003__table354521744216"></a><a name="table354521744216"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64003__table354521744216" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the <strong id="dns_api_64003__b7459134715475">links</strong> field</caption><thead align="left"><tr id="dns_api_64003__row954518179427"><th align="left" class="cellrowborder" valign="top" width="18.3018301830183%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="dns_api_64003__p654513173424"><strong id="dns_api_64003__b165441648144718">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.591959195919593%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="dns_api_64003__p654551714212"><strong id="dns_api_64003__b874395339">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.10621062106211%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="dns_api_64003__p1545141717427"><strong id="dns_api_64003__b178241549144710">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64003__row3545101710429"><td class="cellrowborder" valign="top" width="18.3018301830183%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_64003__p115467171428">self</p>
</td>
<td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dns_api_64003__p254611713427">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.10621062106211%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dns_api_64003__p5546171744214">Link to the current resource</p>
</td>
</tr>
<tr id="dns_api_64003__row37670275497"><td class="cellrowborder" valign="top" width="18.3018301830183%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_64003__p136561245153620">next</p>
</td>
<td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="dns_api_64003__p19656144517367">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.10621062106211%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="dns_api_64003__p76567451365">Link to the next page</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dns_api_64003__ul47260332"><li id="dns_api_64003__li22689808">Example response<pre class="screen" id="dns_api_64003__screen9152561201329">{
"links": {
"self": "https://<em id="dns_api_64003__i38807382141736">Endpoint</em>/v2/recordsets",
"next": "https://<em id="dns_api_64003__i19982811117">Endpoint</em>/v2/recordsets?id=&amp;limit=11&amp;marker=2c9eb155587194ec01587224c9f9014a"
},
"recordsets": [
{
"id": "2c9eb155587194ec01587224c9f9014a",
"name": "example.com.",
"type": "SOA",
"ttl": 300,
"records": [
"ns1.hotrot.de. xx.example.com. (1 7200 900 1209600 300)"
],
"status": "ACTIVE",
"links": {
"self": "https://<em id="dns_api_64003__i21374734142047">Endpoint</em>/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a"
},
"zone_id": "2c9eb155587194ec01587224c9f90149",
"zone_name": "example.com.",
"create_at": "2016-11-17T11:56:03.439",
"update_at": "2016-11-17T11:56:03.827",
"default": true,
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
},
{
"id": "2c9eb155587194ec01587224c9f9014c",
"name": "example.com.",
"type": "NS",
"ttl": 172800,
"records": [
"ns2.hotrot.de.",
"ns1.hotrot.de."
],
"status": "ACTIVE",
"links": {
"self": "https://<em id="dns_api_64003__i36317351142353">Endpoint</em>/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c"
},
"zone_id": "2c9eb155587194ec01587224c9f90149",
"zone_name": "example.com.",
"create_at": "2016-11-17T11:56:03.439",
"update_at": "2016-11-17T11:56:03.827",
"default": true,
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
},
{
"id": "2c9eb155587228570158722996ca0002",
"name": "example.org.",
"type": "SOA",
"ttl": 300,
"records": [
"ns1.hotrot.de. xx.example.org. (1 7200 900 1209600 300)"
],
"status": "ACTIVE",
"links": {
"self": "https://<em id="dns_api_64003__i4181789142454">Endpoint</em>/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0002"
},
"zone_id": "2c9eb155587228570158722996c50001",
"zone_name": "example.org.",
"create_at": "2016-11-17T12:01:17.996",
"update_at": "2016-11-17T12:56:03.827",
"default": true,
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
},
{
"id": "2c9eb155587228570158722996ca0004",
"name": "example.org.",
"type": "NS",
"ttl": 172800,
"records": [
"ns2.hotrot.de.",
"ns1.hotrot.de."
],
"status": "ACTIVE",
"links": {
"self": "https://<em id="dns_api_64003__i839078142551">Endpoint</em>/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0004"
},
"zone_id": "2c9eb155587228570158722996c50001",
"zone_name": "example.org.",
"create_at": "2016-11-17T12:01:17.996",
"update_at": "2016-11-17T12:56:03.827",
"default": true,
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
},
{
"id": "2c9eb155587228570158722b6ac30007",
"name": "www.example.com.",
"description": "This is an example record set.",
"type": "A",
"ttl": 300,
"records": [
"192.168.10.2",
"192.168.10.1"
],
"status": "ACTIVE",
"links": {
"self": "https://<em id="dns_api_64003__i35815594142636">Endpoint</em>/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
},
"zone_id": "2c9eb155587194ec01587224c9f90149",
"zone_name": "example.com.",
"create_at": "2016-11-17T12:03:17.827",
"update_at": "2016-11-17T12:56:03.827",
"default": false,
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
}
],
"metadata": {
"total_count": 5
}
}
</pre>
</li></ul>
</div>
<div class="section" id="dns_api_64003__section9249181042119"><h4 class="sectiontitle">Returned Value</h4><p id="dns_api_64003__dns_api_61001_p711102924515">If the API call returns a code of 2<em id="dns_api_64003__dns_api_61001_i113378598177">xx</em>, for example, 200, 202, or 204, the request is successful.</p>
<p id="dns_api_64003__dns_api_61001_p18506102624518">For details, see <a href="dns_api_80002.html">Status Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dns_api_64000.html">Record Set Management</a></div>
</div>
</div>
View Git Blame Copy Permalink