vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dns/api-ref/dns_api_64004.html
Qin Ying, Fan cf1007c84e DNS API 20240223 version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2024-05-16 13:48:49 +00:00

443 lines
38 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="dns_api_64004"></a><a name="dns_api_64004"></a>
<h1 class="topictitle1">Querying Record Sets in a Zone</h1>
<div id="body230999"><div class="section" id="dns_api_64004__section8391370"><h4 class="sectiontitle">Function</h4><p id="dns_api_64004__p18710936">Query all record sets in a specified zone.</p>
</div>
<div class="section" id="dns_api_64004__section8413469"><h4 class="sectiontitle">URI</h4><p id="dns_api_64004__p55297259195136">GET /v2/zones/{zone_id}/recordsets?limit={limit}&amp;offset={offset}&amp;marker={marker}&amp;tags={tags}&amp;status={status}&amp;type={type}&amp;name={name}&amp;id={id}&amp;sort_key={sort_key}&amp;sort_dir={sort_dir}</p>
<div class="p" id="dns_api_64004__p33311125141315">For details, see <a href="#dns_api_64004__table48883615">Table 1</a>.
<div class="tablenoborder"><a name="dns_api_64004__table48883615"></a><a name="table48883615"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64004__table48883615" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the URI</caption><thead align="left"><tr id="dns_api_64004__row57562809"><th align="left" class="cellrowborder" valign="top" width="17.95%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dns_api_64004__p32075938"><strong id="dns_api_64004__b162774213314533">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.11%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dns_api_64004__p48014184"><strong id="dns_api_64004__b593421527191713">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.58%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dns_api_64004__p63943666"><strong id="dns_api_64004__b84235270619112">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.36000000000001%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dns_api_64004__p12054440"><strong id="dns_api_64004__b842352706112423">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64004__row36885620"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p34945211">zone_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p11989863">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p31654880">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p13908493">Zone ID</p>
<p id="dns_api_64004__p380212115399">Obtain the public zone ID according to <a href="dns_api_62003.html">Querying Public Zones</a>.</p>
<p id="dns_api_64004__p22777371252">Obtain the private zone ID according to <a href="dns_api_63006.html">Querying Private Zones</a>.</p>
</td>
</tr>
<tr id="dns_api_64004__row58067579"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p5853458">marker</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p4368081">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p18270305">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p3966512193622">Start resource ID of pagination query</p>
<p id="dns_api_64004__p10287670114049">If the parameter is left blank, only resources on the first page are queried.</p>
</td>
</tr>
<tr id="dns_api_64004__row31497787"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p1183915">limit</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p28788263">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p50147992">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p230120311413">Number of resources on each page</p>
<p id="dns_api_64004__p147131447514">The value ranges from <strong id="dns_api_64004__b055081920536">0</strong> to <strong id="dns_api_64004__b856481995315">500</strong>.</p>
<p id="dns_api_64004__p1385813431412">Commonly used values are <strong id="dns_api_64004__b312110281292">10</strong>, <strong id="dns_api_64004__b14134192815298">20</strong>, and <strong id="dns_api_64004__b161351287299">50</strong>. The default value is <strong id="dns_api_64004__b1467091512358">500</strong>.</p>
</td>
</tr>
<tr id="dns_api_64004__row202841732113114"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p5702070419554">offset</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p5527430219554">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p4803348119554">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p35951433204916">Start offset of pagination query. The query will start from the next resource of the offset value.</p>
<p id="dns_api_64004__p18898143914915">The value ranges from <strong id="dns_api_64004__b1440560151016">0</strong> to <strong id="dns_api_64004__b8419004101">2147483647</strong>.</p>
<p id="dns_api_64004__p13209172234718">The default value is <strong id="dns_api_64004__b148491522106">0</strong>.</p>
<p id="dns_api_64004__p167712216335">If <strong id="dns_api_64004__b8771113417353">marker</strong> is not left blank, the query starts from the resource specified by <strong id="dns_api_64004__b1346633419372">marker</strong>.</p>
</td>
</tr>
<tr id="dns_api_64004__row186731721123014"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p216770371221">tags</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p110096061221">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p193628991221">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p248910051221">Resource tag</p>
<p id="dns_api_64004__p226924561221">The format is as follows: <strong id="dns_api_64004__b8423527069140">key1,value1|key2,value2</strong>.</p>
<p id="dns_api_64004__p40552875114139">Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,).</p>
<p id="dns_api_64004__p29055151221">The tags are in AND relationship.</p>
<p id="dns_api_64004__p59717447115129">For details, see <a href="dns_api_67001.html">Adding Resource Tags</a>.</p>
<p id="dns_api_64004__p1770514714203">Exact matching will work. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk.</p>
<p id="dns_api_64004__p71284149127">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64004__row1860117192306"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p77524811122"></p>
<p id="dns_api_64004__p15187431105515">status</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p21877311559">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p18187143110551">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p181873314559">Status of the record sets to be queried</p>
<p id="dns_api_64004__p447517111159">The value can be <strong id="dns_api_64004__b8423527069500">ACTIVE</strong>, <strong id="dns_api_64004__b8423527069507">ERROR</strong>, <strong id="dns_api_64004__b84235270695013">DISABLE</strong>, <strong id="dns_api_64004__b84235270695021">FREEZE</strong>, <strong id="dns_api_64004__b84235270695028">PENDING_CREATE</strong>, <strong id="dns_api_64004__b84235270695036">PENDING_UPDATE</strong>, or <strong id="dns_api_64004__b84235270695044">PENDING_DELETE</strong>.</p>
<p id="dns_api_64004__p1641444019533">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
<p id="dns_api_64004__p1289715373203">A fuzzy search will be performed.</p>
<p id="dns_api_64004__p1135030171215">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64004__row667218174302"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p4998111210116">type</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p89981512101120">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p399821215119">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p109982012141111">Type of the record sets to be queried</p>
<p id="dns_api_64004__p19268104541416">The value can be <strong id="dns_api_64004__dns_api_64003_b6491154320298">A</strong>, <strong id="dns_api_64004__dns_api_64003_b175031436295">AAAA</strong>, <strong id="dns_api_64004__dns_api_64003_b9503743202912">MX</strong>, <strong id="dns_api_64004__dns_api_64003_b6504184313296">CNAME</strong>, <strong id="dns_api_64004__dns_api_64003_b5504204316295">TXT</strong>, <strong id="dns_api_64004__dns_api_64003_b3504543152919">NS</strong>, <strong id="dns_api_64004__dns_api_64003_b19636133443013">SOA</strong>, <strong id="dns_api_64004__dns_api_64003_b155051043112918">SRV</strong>, <strong id="dns_api_64004__dns_api_64003_b1475751134712">CAA</strong> (only in public zones), or <strong id="dns_api_64004__dns_api_64003_b5506843152916">PTR</strong> (only in private zones).</p>
<p id="dns_api_64004__p111997895417">For details, see <a href="dns_api_80005.html#dns_api_80005__section1188113824413">Record Set Type</a>.</p>
<p id="dns_api_64004__p13289122841911">Exact matching will work.</p>
<p id="dns_api_64004__p8193193917127">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64004__row17597315113020"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p189276527168">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p19927752151617">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p1492719522167">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p11927252121613">Name of record sets to be queried</p>
<p id="dns_api_64004__p16251111519186">A fuzzy search will be performed.</p>
<p id="dns_api_64004__p1242174471218">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64004__row17376313103015"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p13604691913">id</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p15360960192">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p4360869195">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p173609610193">ID of record sets to be queried</p>
<p id="dns_api_64004__p20802163115183">A fuzzy search will be performed.</p>
<p id="dns_api_64004__p19284124741213">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64004__row178226411313"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p464071413114">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p76401414163117">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p166419143319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p764161483117">Sorting condition of the record set list</p>
<p id="dns_api_64004__p14641814193118">The value can be:</p>
<ul id="dns_api_64004__ul1864191483114"><li id="dns_api_64004__li4641614143119"><strong id="dns_api_64004__b568215319296">name</strong>: domain name</li><li id="dns_api_64004__li20641314163112"><strong id="dns_api_64004__b842352706192951">type</strong>: record set type</li></ul>
<p id="dns_api_64004__p1164171483115">The default value is left blank, indicating that the records are not sorted.</p>
</td>
</tr>
<tr id="dns_api_64004__row114021662226"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64004__p208891026103817">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="18.11%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64004__p4889162653813">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64004__p128891626133813">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.36000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64004__p116071347131216">Sorting order of the record set list</p>
<p id="dns_api_64004__p199381616161315">The value can be:</p>
<ul id="dns_api_64004__ul15224144943012"><li id="dns_api_64004__li172241749103014"><strong id="dns_api_64004__b1978914817290">desc</strong>: descending order</li><li id="dns_api_64004__li1222484911304"><strong id="dns_api_64004__b185691199297">asc</strong>: ascending order</li></ul>
<p id="dns_api_64004__p15614185443318">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_64004__section8612359"><h4 class="sectiontitle">Request</h4><ul id="dns_api_64004__ul35351571269"><li id="dns_api_64004__li1053565782615">Request parameters<p id="dns_api_64004__p1815201642711"><a name="dns_api_64004__li1053565782615"></a><a name="li1053565782615"></a>None</p>
</li><li id="dns_api_64004__li4109190182715">Example request<p id="dns_api_64004__p1651121054613"><a name="dns_api_64004__li4109190182715"></a><a name="li4109190182715"></a>Query record sets in the zone whose ID is 2c9eb155587194ec01587224c9f90149:</p>
<pre class="codeblock" id="dns_api_64004__codeblock18941141154120">GET https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets?limit=&amp;offset=</pre>
</li></ul>
</div>
<div class="section" id="dns_api_64004__section10402369"><h4 class="sectiontitle">Response</h4><ul id="dns_api_64004__ul34627969"><li id="dns_api_64004__li43216271">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64004__table53402119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response</caption><thead align="left"><tr id="dns_api_64004__en-us_topic_0037129969_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_64004__en-us_topic_0037129969_p12572829"><strong id="dns_api_64004__b622213314419">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_64004__en-us_topic_0037129969_p13543581"><strong id="dns_api_64004__b25811344449">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_64004__en-us_topic_0037129969_p23288300"><strong id="dns_api_64004__b280073517444">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64004__row1945012598719"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64004__a8779f70c5dc4414c8df0c2950001a653">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_64004__a51104ec0822b4bf4bf9018680539141a">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_64004__aa2a07c69de424ee5bd26b246f46c26c1">Link to the current resource or other related resources. When a response is broken into pages, a <strong id="dns_api_64004__b1531473984416">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_64004__p1226974804620">For details, see <a href="#dns_api_64004__table354521744216">Table 5</a>.</p>
</td>
</tr>
<tr id="dns_api_64004__en-us_topic_0037129969_row7304143"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64004__en-us_topic_0037129969_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_64004__en-us_topic_0037129969_p10465156">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_64004__en-us_topic_0037129969_p45797138">Record set list object. For details, see <a href="#dns_api_64004__table7192645154740">Table 3</a>.</p>
</td>
</tr>
<tr id="dns_api_64004__ra36d54752ed44415a573a743060b4dc8"><td class="cellrowborder" valign="top" width="20.41%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64004__acfae956c5b3948318d1c49c7521cace4">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_64004__aef6bb96f7ac64bef8949bb9d76432fd4">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_64004__aa2edc4c85ec14e53bf99f656877a8cb6">Total number of resources that meet the filter criteria. For details, see <a href="#dns_api_64004__table2908319718932">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="p" id="dns_api_64004__p7033048135223">
<div class="tablenoborder"><a name="dns_api_64004__table7192645154740"></a><a name="table7192645154740"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64004__table7192645154740" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="dns_api_64004__b1797613175452">recordsets</strong> field</caption><thead align="left"><tr id="dns_api_64004__r0af5587c948d46d8a15423493000e6e3"><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_64004__a8adba83845e444c7bf910c07317dc670"><strong id="dns_api_64004__b9497182017451">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_64004__abe1dbdba2c604202aafd8faf8c3cfeb1"><strong id="dns_api_64004__b18746121164512">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_64004__aa6b52f60e9a745cbb6d91de6da250130"><strong id="dns_api_64004__b8642522134512">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64004__r15a90d66e19644d2b048f68e4641dfbd"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__a4cf2a527bdf54c9aa9f24774cb97d3ef">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_64004__a54396be1dd35484ea5bbb76c4a6a97c5">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_64004__afd5e43bb0e5a4e21b27c223a3d6fede5">Record set ID</p>
</td>
</tr>
<tr id="dns_api_64004__rd729baffede54ccc905a7b1ba90560d2"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__aa48e4bbb14d640888bc92cc4f5099114">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_64004__a64dc6625596f4cc1b4009afad4ffd978">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_64004__a8431a47b4d684b84a8892686d49572a1">Record set name</p>
</td>
</tr>
<tr id="dns_api_64004__rf79f0ca4f9984aa095a1cd76e6eb67c4"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__ace30dcdf68ff463f85024b388cb4e90b">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_64004__ac14bda5751f247fc86b91f168ce4d8c0">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_64004__a6e545c57b85a45adb0b6e47b27332ebc">Record set description</p>
</td>
</tr>
<tr id="dns_api_64004__r9f4660e6890545df864cf94d9226d1eb"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__a5c1a273d855c4198abadda4ac5e784b7">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_64004__ab84442897fc845ab8bcbb24947f8e943">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_64004__a5abdb6f7c1d1497babfdc68ce867b937">Zone ID of the record set</p>
</td>
</tr>
<tr id="dns_api_64004__r5b8f62b5503b42c0a76565e98b01f37d"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__a97bb7c3123ed4896b410b56fb8b1a6e8">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_64004__ad4c239292930467d8bd59f801a2d29e2">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_64004__a0baf79ddce9f4dd7afdb0516ebb6da1e">Zone name of the record set</p>
</td>
</tr>
<tr id="dns_api_64004__r47e64be1e24d4566b613ceadf1051ca0"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__aa3fbb0a6ce484e64963d2e66d18c0d66">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_64004__a0b4010d60b6b47d1be3e8ce3e44e3a36">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_64004__a10d6bdb86d61410f8ccad0af27bf792b">Record set type</p>
<p id="dns_api_64004__p12402123818156">The value can be <strong id="dns_api_64004__dns_api_64003_b6491154320298_1">A</strong>, <strong id="dns_api_64004__dns_api_64003_b175031436295_1">AAAA</strong>, <strong id="dns_api_64004__dns_api_64003_b9503743202912_1">MX</strong>, <strong id="dns_api_64004__dns_api_64003_b6504184313296_1">CNAME</strong>, <strong id="dns_api_64004__dns_api_64003_b5504204316295_1">TXT</strong>, <strong id="dns_api_64004__dns_api_64003_b3504543152919_1">NS</strong>, <strong id="dns_api_64004__dns_api_64003_b19636133443013_1">SOA</strong>, <strong id="dns_api_64004__dns_api_64003_b155051043112918_1">SRV</strong>, <strong id="dns_api_64004__dns_api_64003_b1475751134712_1">CAA</strong> (only in public zones), or <strong id="dns_api_64004__dns_api_64003_b5506843152916_1">PTR</strong> (only in private zones).</p>
<p id="dns_api_64004__a198eb45dfea94fcfa777300551454179">For details, see <a href="dns_api_80005.html#dns_api_80005__section1188113824413">Record Set Type</a>.</p>
</td>
</tr>
<tr id="dns_api_64004__rc3c113a38d8b40e19629963991179111"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__af8f682bd90344203ba4319cb9329cd89">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_64004__abad6db87f732458d8b436c12a3210c88">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_64004__p123031523174010">Record set cache duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect.</p>
<p id="dns_api_64004__p1030317233408">If your service address is frequently changed, set TTL to a smaller value.</p>
<p id="dns_api_64004__p1042612588514">Value range: </p>
<ul id="dns_api_64004__ul1526514741611"><li id="dns_api_64004__dns_api_64001_li1127393145317">Public zone: <strong id="dns_api_64004__dns_api_64001_b148234231295">1</strong>–<strong id="dns_api_64004__dns_api_64001_b13824323152912">2147483647</strong></li><li id="dns_api_64004__dns_api_64001_li1925240145319">Private zone: <strong id="dns_api_64004__dns_api_64001_b6567113632918">1</strong>–<strong id="dns_api_64004__dns_api_64001_b9567173652918">2147483647</strong></li></ul>
<p id="dns_api_64004__p10651531171611">The default value is <strong id="dns_api_64004__dns_api_64001_b103151601234">300</strong>.</p>
</td>
</tr>
<tr id="dns_api_64004__r37b3fbaa743244edae92887f7a85879b"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__a58ffd09b95b745cea54e9c25ccb21394">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_64004__a2ae8cb48a17a4626b53ac823c85dcb6f">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_64004__aaa856de208d9486988e40aec9b072136">Record set value</p>
</td>
</tr>
<tr id="dns_api_64004__r8ce69e869cbe4417ad700242f7a60a1a"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__a3403f8ba9df44877b57d6b5b4864068f">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_64004__p187131431990">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_64004__ab6b8bf53dcfe4f50bd881bffeb86a75c">Time when the record set was created</p>
<p id="dns_api_64004__a881c9a18b1e24097982dd0f94686438a">The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.</p>
</td>
</tr>
<tr id="dns_api_64004__r38927cc028a6493ea14200a215beb5f1"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__a43961341d5e443e2ae5e866b72ec3639">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_64004__p3597341393">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_64004__a3b09a9724a904bdb9d9748d27a14e66c">Time when the record set was updated</p>
<p id="dns_api_64004__af325deb1a55e4a66b5ab735f2f65f9af">The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.</p>
</td>
</tr>
<tr id="dns_api_64004__r57ca2c0e85e948dfaf58836f4276aeca"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__ae00da26584744a278669ea88c1fe481c">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_64004__a99a92dbdb2b74fa89c839212003e4864">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_64004__a45bfe41a9b8144d5828355752733d3b3">Resource status</p>
<p id="dns_api_64004__a60294dc7e1334baba4d2a3444e020149">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_64004__ra70a82e3577641c48bfff967011a70bb"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__a4cea4ca8281e4ddfb3a451c3228e16c3">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_64004__a57ca2db911824c6ab1b680c44335b29e">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_64004__a7605345fc0f041309ebaa93830fc5e85">Whether the record set is created by default. A default record set cannot be deleted.</p>
</td>
</tr>
<tr id="dns_api_64004__re0ed521efcfb40b3a38e94bf58839201"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__ac9cfd75452ed4da39c94d7a166290d5b">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_64004__p11871840396">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_64004__p4619625201026">Project ID of the record set</p>
</td>
</tr>
<tr id="dns_api_64004__r0bab22234ef44171aff1b23e500b514a"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.2.1.2.4.1.1 "><p id="dns_api_64004__a807f36408ce243a49010e2a04724a3b7">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_64004__afdf3844ea44b4f758b42ffdb2e0064ef">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_64004__a083445bf634e4e0f977c92b1b0bb1863">Link to the current resource or other related resources. When a response is broken into pages, a <strong id="dns_api_64004__b8247734185411">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_64004__p14501402474">For details, see <a href="#dns_api_64004__table354521744216">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="dns_api_64004__table2908319718932"></a><a name="table2908319718932"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64004__table2908319718932" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Description of the <strong id="dns_api_64004__b842352706152641">metadata</strong> field</caption><thead align="left"><tr id="dns_api_64004__r1ee98e923a7c4bfcaa89e708d3fca79e"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dns_api_64004__af493c2fde22f44069c2b5ea0467dfe89"><strong id="dns_api_64004__b499414318540">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dns_api_64004__a581940a484df4c8294e51f11391a23c8"><strong id="dns_api_64004__b153351745165413">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dns_api_64004__a0301bbf5a1234ea3a88a104e1b4cff92"><strong id="dns_api_64004__b3631347185417">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64004__r7cc02a0ecbd24482bca90faa98114b18"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_64004__a9234858cb2f447539b4b85a307884322">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_64004__af14a2a2c8f0345f4811bb21dd2a9b667">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_64004__a39058f9901c84eb9a776ca5cd44ede29">Number of resources that meet the filter criteria. The number is irrelevant to <strong id="dns_api_64004__b20434135035414">limit</strong> or <strong id="dns_api_64004__b18434145019548">offset</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_64004__table354521744216"></a><a name="table354521744216"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64004__table354521744216" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the <strong id="dns_api_64004__b93221354185414">links</strong> field</caption><thead align="left"><tr id="dns_api_64004__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_64004__p654513173424"><strong id="dns_api_64004__b84891855155415">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_64004__p654551714212"><strong id="dns_api_64004__b15926125616542">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_64004__p1545141717427"><strong id="dns_api_64004__b199561657135414">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64004__row3545101710429"><td class="cellrowborder" valign="top" width="18.3018301830183%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_64004__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_64004__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_64004__p5546171744214">Link to the current resource</p>
</td>
</tr>
<tr id="dns_api_64004__row175243399495"><td class="cellrowborder" valign="top" width="18.3018301830183%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="dns_api_64004__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_64004__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_64004__p76567451365">Link to the next page</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="dns_api_64004__li58259743">Example response<pre class="screen" id="dns_api_64004__screen52131554201636">{
"links": {
"self": "https://<em id="dns_api_64004__i5248416914181">Endpoint</em>/v2/recordsets?limit=1&amp;marker=&amp;name=&amp;status=&amp;zone_id=2c9eb155587194ec01587224c9f90149",
"next": "https://<em id="dns_api_64004__i19982811117">Endpoint</em>/v2/recordsets?limit=11&amp;marker=2c9eb155587194ec01587224c9f9014a&amp;name=&amp;status=&amp;zone_id=2c9eb155587194ec01587224c9f90149"
},
"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_64004__i1162032514212">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-17T12: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_64004__i62040258142410">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-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": "PENDING_CREATE",
"links": {
"self": "https://<em id="dns_api_64004__i7005450142613">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": 3
}
}</pre>
</li></ul>
</div>
<div class="section" id="dns_api_64004__section9249181042119"><h4 class="sectiontitle">Returned Value</h4><p id="dns_api_64004__dns_api_61001_p711102924515">If a 2xx status code is returned, for example, 200, 202, or 204, the request is successful.</p>
<p id="dns_api_64004__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