lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dns/api-ref/dns_api_64001.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

476 lines
32 KiB
HTML
Raw 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_64001"></a><a name="dns_api_64001"></a>
<h1 class="topictitle1">Creating a Record Set</h1>
<div id="body1473062969376"><div class="section" id="dns_api_64001__section2763065016101"><h4 class="sectiontitle">Function</h4><p id="dns_api_64001__p27131597161013">Create a record set.</p>
</div>
<div class="section" id="dns_api_64001__section53701671161015"><h4 class="sectiontitle">URI</h4><p id="dns_api_64001__p31828320173054">POST /v2/zones/{zone_id}/recordsets</p>
<div class="p" id="dns_api_64001__p114843191213">For details, see <a href="#dns_api_64001__table30807893173129">Table 1</a>.
<div class="tablenoborder"><a name="dns_api_64001__table30807893173129"></a><a name="table30807893173129"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64001__table30807893173129" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the URI</caption><thead align="left"><tr id="dns_api_64001__row38661368173129"><th align="left" class="cellrowborder" valign="top" width="23.357664233576642%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dns_api_64001__p14212988173129"><strong id="dns_api_64001__b162774213314533">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.03799620037996%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dns_api_64001__p23287688173129"><strong id="dns_api_64001__b593421527191713">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.31826817318268%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dns_api_64001__p1215993599"><strong id="dns_api_64001__b84235270619112">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.28607139286072%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dns_api_64001__p1114682173129"><strong id="dns_api_64001__b842352706112423">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64001__row6301875173129"><td class="cellrowborder" valign="top" width="23.357664233576642%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_64001__p5124116173129">zone_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.03799620037996%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_64001__p65804667173129">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.31826817318268%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_64001__p71592310916">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.28607139286072%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_64001__p56820233173129">Zone ID</p>
<p id="dns_api_64001__p2557111672911">Obtain the public zone ID according to <a href="dns_api_62003.html">Querying Public Zones</a>.</p>
<p id="dns_api_64001__p22777371252">Obtain the private zone ID according to <a href="dns_api_63006.html">Querying Private Zones</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="dns_api_64001__section44958995161021"><h4 class="sectiontitle">Request</h4><ul id="dns_api_64001__ul18370535173152"><li id="dns_api_64001__li51947106173152">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64001__table9470531173211" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request</caption><thead align="left"><tr id="dns_api_64001__row60397351173211"><th align="left" class="cellrowborder" valign="top" width="19.25%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="dns_api_64001__p65819295173211"><strong id="dns_api_64001__b778987692">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.54%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="dns_api_64001__p42278174173211"><strong id="dns_api_64001__b11039231112234">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.809999999999999%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="dns_api_64001__p26309572173211"><strong id="dns_api_64001__b1579596136">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.4%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="dns_api_64001__p67071922173211"><strong id="dns_api_64001__b817959081">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64001__row65160710173211"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_64001__p21415905173211">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.54%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_64001__p58188388173211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_64001__p45293229173211">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.4%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_64001__p5054941173211">Fully qualified domain name (FQDN) suffixed with a zone name, which is a complete host name ended with a dot</p>
<p id="dns_api_64001__p27471407151355">A domain name is case insensitive. Uppercase letters will also be converted into lowercase letters.</p>
</td>
</tr>
<tr id="dns_api_64001__row34337486173211"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_64001__p33154613173211">description</p>
</td>
<td class="cellrowborder" valign="top" width="20.54%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_64001__p28540882173211">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_64001__p37402311173211">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.4%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_64001__p43441715173211">(Optional) Description of the domain name</p>
<p id="dns_api_64001__p9966775173211">The value cannot exceed 255 characters.</p>
<p id="dns_api_64001__p174334035418">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_64001__row52503862173211"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_64001__p4265712173211">type</p>
</td>
<td class="cellrowborder" valign="top" width="20.54%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_64001__p43588224173211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_64001__p44233480173211">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.4%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_64001__p29114279173211">Record set type</p>
<p id="dns_api_64001__p160041663916">The value can be <strong id="dns_api_64001__b84235270693731">A</strong>, <strong id="dns_api_64001__b84235270693735">AAAA</strong>, <strong id="dns_api_64001__b84235270693738">MX</strong>, <strong id="dns_api_64001__b84235270693741">CNAME</strong>, <strong id="dns_api_64001__b84235270693746">TXT</strong>, <strong id="dns_api_64001__b84235270693755">NS</strong> (only in public zones), <strong id="dns_api_64001__b8423527069382">SRV</strong>, <strong id="dns_api_64001__b44467248426">CAA</strong> (only in public zones), and <strong id="dns_api_64001__b8423527069385">PTR</strong> (only in private zones).</p>
<p id="dns_api_64001__p1656255110557">For details, see <a href="dns_api_80005.html#dns_api_80005__section1188113824413">Record Set Type</a>.</p>
</td>
</tr>
<tr id="dns_api_64001__row44235645173211"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_64001__p56753577173211">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="20.54%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_64001__p44923213173211">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_64001__p15148058212620">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.4%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_64001__p44661732103918">Caching period of the record set on a local DNS server</p>
<p id="dns_api_64001__p1995185423811">If your service address is frequently changed, set TTL to a smaller value.</p>
<p id="dns_api_64001__p258374385518">Value range: </p>
<ul id="dns_api_64001__ul12272931135310"><li id="dns_api_64001__li1127393145317">Public zone: <strong id="dns_api_64001__b148234231295">1</strong>–<strong id="dns_api_64001__b13824323152912">2147483647</strong></li><li id="dns_api_64001__li1925240145319">Private zone: <strong id="dns_api_64001__b6567113632918">1</strong>–<strong id="dns_api_64001__b9567173652918">2147483647</strong></li></ul>
<p id="dns_api_64001__p1752884719548">The default value is <strong id="dns_api_64001__b103151601234">300</strong>.</p>
</td>
</tr>
<tr id="dns_api_64001__row59750658173211"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_64001__p62596825173211">records</p>
</td>
<td class="cellrowborder" valign="top" width="20.54%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_64001__p32296167173211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_64001__p5792332173211">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="47.4%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_64001__p8321575173211">Value of the record set. The value format varies depending on record set types.</p>
<p id="dns_api_64001__p813988173211">For example, the value of an AAAA record set is the IPv6 address list mapped to the domain name.</p>
</td>
</tr>
<tr id="dns_api_64001__row11879661194927"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_64001__p24376203194927">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20.54%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_64001__p28315431194927">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_64001__p1170236162">Array of object</p>
</td>
<td class="cellrowborder" valign="top" width="47.4%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_64001__p20210224194927">Resource tag. For details, see <a href="#dns_api_64001__table7518152113230">Table 3</a>.</p>
<p id="dns_api_64001__p878665895419">The value is left blank by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_64001__table7518152113230"></a><a name="table7518152113230"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64001__table7518152113230" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="dns_api_64001__dns_api_62001_b152751649111611">tags</strong> field</caption><thead align="left"><tr id="dns_api_64001__dns_api_62001_row15361836112436"><th align="left" class="cellrowborder" valign="top" width="24.54%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="dns_api_64001__dns_api_62001_p58707511112436"><strong id="dns_api_64001__dns_api_62001_b1272512714015">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.64%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="dns_api_64001__dns_api_62001_p791763775720"><strong id="dns_api_64001__dns_api_62001_b1711073260">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.700000000000001%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="dns_api_64001__dns_api_62001_p42210623112436"><strong id="dns_api_64001__dns_api_62001_b60503934">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.12%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="dns_api_64001__dns_api_62001_p63617265112436"><strong id="dns_api_64001__dns_api_62001_b1951915416277">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64001__dns_api_62001_row35684479112436"><td class="cellrowborder" valign="top" width="24.54%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dns_api_64001__dns_api_62001_p13313439112530">key</p>
</td>
<td class="cellrowborder" valign="top" width="14.64%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dns_api_64001__dns_api_62001_p89180372570">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.700000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dns_api_64001__dns_api_62001_p35653193112436">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.12%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dns_api_64001__dns_api_62001_p011410211144">Tag key</p>
<p id="dns_api_64001__dns_api_62001_p12621122816413">A key can contain up to 36 Unicode characters. <strong id="dns_api_64001__dns_api_62001_b55081744194212">key</strong> must be specified. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).</p>
</td>
</tr>
<tr id="dns_api_64001__dns_api_62001_row20048002112436"><td class="cellrowborder" valign="top" width="24.54%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dns_api_64001__dns_api_62001_p66095544112533">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.64%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dns_api_64001__dns_api_62001_p13918103725715">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.700000000000001%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dns_api_64001__dns_api_62001_p60123528112436">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.12%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dns_api_64001__dns_api_62001_p592417401420">Tag value</p>
<p id="dns_api_64001__dns_api_62001_p3383124915419">Each value can contain up to 43 Unicode characters and can be an empty string. </p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="dns_api_64001__li60905904173155">Example request<div class="p" id="dns_api_64001__p5867121615317"><a name="dns_api_64001__li60905904173155"></a><a name="li60905904173155"></a>Add record sets for the zone whose ID is 2c9eb155587194ec01587224c9f90149:<pre class="codeblock" id="dns_api_64001__codeblock0639101313118">POST https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets</pre>
</div>
<div class="p" id="dns_api_64001__p1764514139310"><ul id="dns_api_64001__ul20645101363117"><li id="dns_api_64001__li166401313113116">A type<pre class="screen" id="dns_api_64001__screen1564051311313">{
"name": "www.example.com.",
"description": "This is an example record set.",
"type": "A",
"ttl": 3600,
"records": [
"192.168.10.1",
"192.168.10.2"
],
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</li><li id="dns_api_64001__li196401813163111">AAAA type<pre class="screen" id="dns_api_64001__screen9640131317317">{
"name": "www.example.com.",
"description": "This is an example record set.",
"type": "AAAA",
"ttl": 3600,
"records": [
"fe80:0:0:0:202:b3ff:fe1e:8329",
"ff03:0db8:85a3:0:0:8a2e:0370:7334"
],
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</li><li id="dns_api_64001__li4641201383118">MX type<pre class="screen" id="dns_api_64001__screen12641121353119">{
"name": "www.example.com.",
"description": "This is an example record set.",
"type": "MX",
"ttl": 3600,
"records": [
"1 mail.example.com"
],
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</li><li id="dns_api_64001__li16421813173114">CNAME type<pre class="screen" id="dns_api_64001__screen116421113153115">{
"name": "sale.example.com.",
"description": "This is an example record set.",
"type": "CNAME",
"ttl": 3600,
"records": [
"server1.example.com"
],
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</li><li id="dns_api_64001__li96427136316">TXT type<pre class="screen" id="dns_api_64001__screen1642121313316">{
"name": "server1.example.com.",
"description": "This is an example record set.",
"type": "TXT",
"ttl": 300,
"records": [
"\"This host is used for sale.\""
],
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</li><li id="dns_api_64001__li0643113153114">NS type<pre class="screen" id="dns_api_64001__screen46431213103112">{
"name": "server1.example.com.",
"description": "This is an example record set.",
"type": "NS",
"ttl": 300,
"records": [
"node1.example.com.",
"node2.example.com."
],
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</li><li id="dns_api_64001__li1464415137312">SRV type<pre class="screen" id="dns_api_64001__screen14644131310317">{
"name": "_sip._tcp.example.com.",
"description": "This is an example record set.",
"type": "SRV",
"ttl": 300,
"records": [
"3 60 2176 sipserver.example.com.",
"10 100 2176 sipserver.example.com."
],
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</li><li id="dns_api_64001__li9644101317310">PTR type<pre class="screen" id="dns_api_64001__screen564491323112">{
"name": "1.1.168.192.in-addr.arpa.",
"description": "This is an example record set.",
"type": "PTR",
"ttl": 300,
"records": [
"webserver.example.com."
],
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}
</pre>
</li><li id="dns_api_64001__li17645111323115">CAA type<pre class="screen" id="dns_api_64001__screen5645191323111">{
"name": "www.example.com.",
"description": "This is an example record set.",
"type": "CAA",
"ttl": 300,
"records": [
"0 issue \"example.com\"",
"0 issuewild \"www.certinomis.com\"",
"0 iodef \"mailto:xx@example.org\"",
"0 iodef \"http://iodef.example.com\""
],
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</li></ul>
</div>
</li></ul>
</div>
<div class="section" id="dns_api_64001__section40090803161031"><h4 class="sectiontitle">Response</h4><ul id="dns_api_64001__ul56136690175237"><li id="dns_api_64001__li4367003175237">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64001__table7669703175323" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameters in the response</caption><thead align="left"><tr id="dns_api_64001__row52466955175323"><th align="left" class="cellrowborder" valign="top" width="27.889999999999997%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dns_api_64001__p2769858175323"><strong id="dns_api_64001__b1264531799">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.55%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dns_api_64001__p46296309175323"><strong id="dns_api_64001__b1811662466">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.56%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dns_api_64001__p62697904175323"><strong id="dns_api_64001__b1039168415">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64001__row47909891175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p64112397175323">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p1660870175323">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p1249204175323">Record set ID</p>
</td>
</tr>
<tr id="dns_api_64001__row6942422175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p64097412175323">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p44990515175323">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p32019574175323">Record set name</p>
</td>
</tr>
<tr id="dns_api_64001__row61442071175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p51194416175323">description</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p63301991175323">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p43966660175323">Record set description</p>
</td>
</tr>
<tr id="dns_api_64001__row2176746175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p11805366175323">zone_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p1051908175323">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p10043845175323">Zone ID of the record set</p>
</td>
</tr>
<tr id="dns_api_64001__row61212722175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p8318586175323">zone_name</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p31287919175323">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p16372315175323">Zone name of the record set</p>
</td>
</tr>
<tr id="dns_api_64001__row38132372175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p37461920175323">type</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p27536075175323">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p24813356175323">Record set type</p>
<p id="dns_api_64001__p53091158147">The value can be <strong id="dns_api_64001__dns_api_64001_b84235270693731">A</strong>, <strong id="dns_api_64001__dns_api_64001_b84235270693735">AAAA</strong>, <strong id="dns_api_64001__dns_api_64001_b84235270693738">MX</strong>, <strong id="dns_api_64001__dns_api_64001_b84235270693741">CNAME</strong>, <strong id="dns_api_64001__dns_api_64001_b84235270693746">TXT</strong>, <strong id="dns_api_64001__dns_api_64001_b84235270693755">NS</strong> (only in public zones), <strong id="dns_api_64001__dns_api_64001_b8423527069382">SRV</strong>, <strong id="dns_api_64001__dns_api_64001_b44467248426">CAA</strong> (only in public zones), and <strong id="dns_api_64001__dns_api_64001_b8423527069385">PTR</strong> (only in private zones).</p>
<p id="dns_api_64001__p15442435577">For details, see <a href="dns_api_80005.html#dns_api_80005__section1188113824413">Record Set Type</a>.</p>
</td>
</tr>
<tr id="dns_api_64001__row20796819175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p4811553175323">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p47559731175323">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__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_64001__p1030317233408">If your service address is frequently changed, set TTL to a smaller value.</p>
<p id="dns_api_64001__p1042612588514">Value range: </p>
<ul id="dns_api_64001__ul1526514741611"><li id="dns_api_64001__dns_api_64001_li1127393145317">Public zone: <strong id="dns_api_64001__dns_api_64001_b148234231295">1</strong>–<strong id="dns_api_64001__dns_api_64001_b13824323152912">2147483647</strong></li><li id="dns_api_64001__dns_api_64001_li1925240145319">Private zone: <strong id="dns_api_64001__dns_api_64001_b6567113632918">1</strong>–<strong id="dns_api_64001__dns_api_64001_b9567173652918">2147483647</strong></li></ul>
<p id="dns_api_64001__p10651531171611">The default value is <strong id="dns_api_64001__dns_api_64001_b103151601234">300</strong>.</p>
</td>
</tr>
<tr id="dns_api_64001__row13978060175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p43388342175323">records</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p29596719175323">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p30492925175323">Record set value</p>
</td>
</tr>
<tr id="dns_api_64001__row23148559175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p36524189175323">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p47080972175323">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p15737135175323">Time when the record set was created</p>
<p id="dns_api_64001__p91253279589">The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.</p>
</td>
</tr>
<tr id="dns_api_64001__row33465792175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p42570937175323">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p27449776175323">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p63703533175323">Time when the record set was updated</p>
<p id="dns_api_64001__p1291282918585">The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.</p>
</td>
</tr>
<tr id="dns_api_64001__row17850883175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p36228271175323">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p6480061175323">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p65781854175323">Resource status</p>
<p id="dns_api_64001__p17497161105814">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_64001__row61184424175323"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p49633411175323">default</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p56048766175323">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p37768157175323">Whether the record set is created by default. A default record set cannot be deleted.</p>
</td>
</tr>
<tr id="dns_api_64001__row15199048201026"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p23163408201026">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p40653752201026">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p4619625201026">Project ID of the record set</p>
</td>
</tr>
<tr id="dns_api_64001__row3965248419366"><td class="cellrowborder" valign="top" width="27.889999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_64001__p2132803819366">links</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_64001__p1127763319366">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.56%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_64001__p4107308719366">Link to the current resource or other related resources. When a response is broken into pages, a <strong id="dns_api_64001__b10840111643111">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_64001__p8605123216466">For details, see <a href="#dns_api_64001__table52442344175457">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_64001__table52442344175457"></a><a name="table52442344175457"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_64001__table52442344175457" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the <strong id="dns_api_64001__b658419612357">links</strong> field</caption><thead align="left"><tr id="dns_api_64001__row58979189175457"><th align="left" class="cellrowborder" valign="top" width="18.3018301830183%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dns_api_64001__p46156243175457"><strong id="dns_api_64001__b144221717357">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.591959195919593%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dns_api_64001__p47668234175457"><strong id="dns_api_64001__b1287669028">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.10621062106211%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dns_api_64001__p35921708175457"><strong id="dns_api_64001__b1635720811358">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_64001__row54859922175457"><td class="cellrowborder" valign="top" width="18.3018301830183%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_64001__p14468674175457">self</p>
</td>
<td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_64001__p31111955175457">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.10621062106211%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_64001__p37040428175457">Link to the current resource</p>
</td>
</tr>
<tr id="dns_api_64001__row1639371017497"><td class="cellrowborder" valign="top" width="18.3018301830183%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_64001__p136561245153620">next</p>
</td>
<td class="cellrowborder" valign="top" width="19.591959195919593%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dns_api_64001__p19656144517367">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.10621062106211%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dns_api_64001__p76567451365">Link to the next page</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="dns_api_64001__li19426394175241">Example response<pre class="screen" id="dns_api_64001__screen1086592620914">{
"id": "2c9eb155587228570158722b6ac30007",
"name": "www.example.com.",
"description": "This is an example record set.",
"type": "A",
"ttl": 300,
"records": [
"192.168.10.1",
"192.168.10.2"
],
"status": "PENDING_CREATE",
"links": {
"self": "https://<em id="dns_api_64001__i46588245141657">Endpoint</em>/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
},
"zone_id": "2c9eb155587194ec01587224c9f90149",
"zone_name": "example.com.",
"create_at": "2016-11-17T12:03:17.827",
"update_at": null,
"default": false,
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
}
</pre>
</li></ul>
</div>
<div class="section" id="dns_api_64001__section9249181042119"><h4 class="sectiontitle">Returned Value</h4><p id="dns_api_64001__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_64001__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