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

411 lines
31 KiB
HTML
Raw Permalink Blame History

<a name="dns_api_63002"></a><a name="dns_api_63002"></a>
<h1 class="topictitle1">Creating a Private Zone</h1>
<div id="body1492847418237"><div class="section" id="dns_api_63002__section3569153217343"><h4 class="sectiontitle">Function</h4><p id="dns_api_63002__p2420228517348">Create a private zone.</p>
</div>
<div class="section" id="dns_api_63002__section6163262617350"><h4 class="sectiontitle">URI</h4><p id="dns_api_63002__p5527305017659">POST /v2/zones</p>
</div>
<div class="section" id="dns_api_63002__section4207148117353"><h4 class="sectiontitle">Request</h4><ul id="dns_api_63002__ul5122522817716"><li id="dns_api_63002__li5604781117716">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63002__table3720408817742" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request</caption><thead align="left"><tr id="dns_api_63002__row6225671717742"><th align="left" class="cellrowborder" valign="top" width="18.970000000000002%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="dns_api_63002__p5153686617742"><strong id="dns_api_63002__b162774213314533">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.18%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="dns_api_63002__p473035017742"><strong id="dns_api_63002__b593421527191713">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.72%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="dns_api_63002__p386753717742"><strong id="dns_api_63002__b84235270619112">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.13%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="dns_api_63002__p5956810717742"><strong id="dns_api_63002__b842352706112423">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63002__row1329410717742"><td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63002__p3414560317742">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.18%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63002__p6603174617742">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.72%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63002__p360216817742">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.13%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63002__p2651334817742">Domain name of the zone to be created</p>
<ul id="dns_api_63002__ul1536534155329"><li id="dns_api_63002__li13093589155329">If a domain name is ended with a dot (.), it cannot exceed 254 characters.</li><li id="dns_api_63002__li5289935151252">Otherwise, the domain name cannot exceed 253 characters.</li><li id="dns_api_63002__li932560893722">A domain name cannot exceed 63 characters. Multiple domain names are separated with dots (.).</li></ul>
<p id="dns_api_63002__p61100872151329">A domain name is case insensitive. Uppercase letters will also be converted into lowercase letters.</p>
</td>
</tr>
<tr id="dns_api_63002__row1973909717742"><td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63002__p5474826717742">description</p>
</td>
<td class="cellrowborder" valign="top" width="19.18%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63002__p759162017742">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.72%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63002__p3220634117742">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.13%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63002__p3586421511957">Description of the domain name, which cannot exceed 255 characters</p>
<p id="dns_api_63002__p10578150184319">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_63002__row3526956217742"><td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63002__p5656791917742">zone_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.18%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63002__p2306625217742">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.72%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63002__p5927915117742">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.13%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63002__p92377632066">Zone type</p>
<p id="dns_api_63002__p59986333111018">The value must be <strong id="dns_api_63002__b60062277144632">private</strong>, indicating private zones accessible only to hosts in specified VPCs will be created.</p>
<p id="dns_api_63002__p96596832066">For details about creating a public zone, see section <a href="dns_api_62001.html">Creating a Public Zone</a>.</p>
</td>
</tr>
<tr id="dns_api_63002__row4358988017742"><td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63002__p6536976617742">email</p>
</td>
<td class="cellrowborder" valign="top" width="19.18%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63002__p650279617742">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.72%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63002__p2054573717742">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.13%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63002__p1997196517742">Email address of the administrator managing the zone</p>
<p id="dns_api_63002__p1609108834">The default value is the service email address.</p>
</td>
</tr>
<tr id="dns_api_63002__row13489593141045"><td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63002__p18915273141045">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="19.18%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63002__p55742162141045">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.72%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63002__p18821243141045">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.13%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63002__p3447255141334">Caching period of the SOA record set (in seconds)</p>
<p id="dns_api_63002__p5335091141210">The value ranges from <strong id="dns_api_63002__b19998125511334">1</strong> to <strong id="dns_api_63002__b1899825519334">2147483647</strong>.</p>
<p id="dns_api_63002__p977916161437">The default value is <strong id="dns_api_63002__b1947775585810">300</strong>.</p>
</td>
</tr>
<tr id="dns_api_63002__row18045881171648"><td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63002__p20204595171650">router</p>
</td>
<td class="cellrowborder" valign="top" width="19.18%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63002__p25959495171650">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.72%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63002__p22344380171650">Object</p>
</td>
<td class="cellrowborder" valign="top" width="49.13%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63002__p49598957105941">Router information (VPC associated with the private zone)</p>
<p id="dns_api_63002__p2202488111957">For details, see <a href="#dns_api_63002__table4448008117179">Table 2</a>.</p>
</td>
</tr>
<tr id="dns_api_63002__row3748545412107"><td class="cellrowborder" valign="top" width="18.970000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63002__p6123289312107">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.18%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63002__p6091732812107">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.72%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63002__p3535651512107">Array of object</p>
</td>
<td class="cellrowborder" valign="top" width="49.13%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63002__p4530543812107">Resource tag. For details, see <a href="#dns_api_63002__table58807309208">Table 3</a>.</p>
<p id="dns_api_63002__p39666299312">The value is left blank by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63002__table4448008117179"></a><a name="table4448008117179"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63002__table4448008117179" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Description of the <strong id="dns_api_63002__b84235270611438">router</strong> field</caption><thead align="left"><tr id="dns_api_63002__row6132935617179"><th align="left" class="cellrowborder" valign="top" width="13.900000000000002%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="dns_api_63002__p36588677171719"><strong id="dns_api_63002__b809615677">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.15%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="dns_api_63002__p06011644121012"><strong id="dns_api_63002__b913052101">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.580000000000002%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="dns_api_63002__p9906869171719"><strong id="dns_api_63002__b1092108285">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.37%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="dns_api_63002__p64258954171719"><strong id="dns_api_63002__b1609968898">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63002__row266872817179"><td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dns_api_63002__p25118582171719">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dns_api_63002__p11602144151017">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.580000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dns_api_63002__p50755907171719">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.37%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dns_api_63002__p17587794171719">ID of the associated VPC</p>
</td>
</tr>
<tr id="dns_api_63002__row6657832817179"><td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dns_api_63002__p3709384171719">router_region</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dns_api_63002__p8602134413102">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.580000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dns_api_63002__p43861924171719">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.37%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dns_api_63002__p63154928171719">Region of the VPC</p>
<p id="dns_api_63002__p38645142171939">If it is left blank, the region of the project in the token takes effect by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63002__table58807309208"></a><a name="table58807309208"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63002__table58807309208" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="dns_api_63002__dns_api_62001_b152751649111611">tags</strong> field</caption><thead align="left"><tr id="dns_api_63002__dns_api_62001_row15361836112436"><th align="left" class="cellrowborder" valign="top" width="24.54%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="dns_api_63002__dns_api_62001_p58707511112436"><strong id="dns_api_63002__dns_api_62001_b1272512714015">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.64%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="dns_api_63002__dns_api_62001_p791763775720"><strong id="dns_api_63002__dns_api_62001_b1711073260">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.700000000000001%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="dns_api_63002__dns_api_62001_p42210623112436"><strong id="dns_api_63002__dns_api_62001_b60503934">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.12%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="dns_api_63002__dns_api_62001_p63617265112436"><strong id="dns_api_63002__dns_api_62001_b1951915416277">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63002__dns_api_62001_row35684479112436"><td class="cellrowborder" valign="top" width="24.54%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="dns_api_63002__dns_api_62001_p13313439112530">key</p>
</td>
<td class="cellrowborder" valign="top" width="14.64%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="dns_api_63002__dns_api_62001_p89180372570">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.700000000000001%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="dns_api_63002__dns_api_62001_p35653193112436">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.12%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="dns_api_63002__dns_api_62001_p011410211144">Tag key</p>
<p id="dns_api_63002__dns_api_62001_p12621122816413">A key can contain up to 36 Unicode characters. <strong id="dns_api_63002__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_63002__dns_api_62001_row20048002112436"><td class="cellrowborder" valign="top" width="24.54%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="dns_api_63002__dns_api_62001_p66095544112533">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.64%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="dns_api_63002__dns_api_62001_p13918103725715">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.700000000000001%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="dns_api_63002__dns_api_62001_p60123528112436">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.12%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="dns_api_63002__dns_api_62001_p592417401420">Tag value</p>
<p id="dns_api_63002__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_63002__li3969179817718">Example request<div class="p" id="dns_api_63002__p440643212210"><a name="dns_api_63002__li3969179817718"></a><a name="li3969179817718"></a>Create a private zone named <strong id="dns_api_63002__b113511533133617">example.com</strong>.<pre class="codeblock" id="dns_api_63002__codeblock1259512301224">POST https://{DNS_Endpoint}/v2/zones</pre>
<pre class="screen" id="dns_api_63002__screen9596193042211">{
"name": "example.com.",
"description": "This is an example zone.",
"zone_type": "private",
"email": "xx@example.org",
"router": {
"router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
"router_region": "xx"
},
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="dns_api_63002__section2142173017358"><h4 class="sectiontitle">Response</h4><ul id="dns_api_63002__ul24043226171010"><li id="dns_api_63002__li61921720171010">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63002__table54601120171039" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameters in the response</caption><thead align="left"><tr id="dns_api_63002__row54125868171039"><th align="left" class="cellrowborder" valign="top" width="18.37%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dns_api_63002__p46128019171039"><strong id="dns_api_63002__b621192730">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.32%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dns_api_63002__p61288737171039"><strong id="dns_api_63002__b863149862">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.31%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dns_api_63002__p39427830171039"><strong id="dns_api_63002__b784257635">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63002__row3275315171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p13677558171039">id</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p31480160171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p55186322171039">Zone ID, which is a UUID used to identify the zone</p>
</td>
</tr>
<tr id="dns_api_63002__row62038903171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p21725743171039">name</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p55078653171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p65545475171039">Zone name</p>
</td>
</tr>
<tr id="dns_api_63002__row24663709171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p56112529171039">description</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p46656524171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p31778607171039">Zone description</p>
</td>
</tr>
<tr id="dns_api_63002__row34212800171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p51657401171039">email</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p336297171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p66322352171039">Email address of the administrator managing the zone</p>
</td>
</tr>
<tr id="dns_api_63002__row45341886171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p22374403171039">zone_type</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p16323247171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p9394279212">Zone type, which can be <strong id="dns_api_63002__b18789125023712">public</strong> or <strong id="dns_api_63002__b11791205063712">private</strong></p>
</td>
</tr>
<tr id="dns_api_63002__row36905265171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p4888971171039">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p16027579171039">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p41240291171039">TTL value of the SOA record set in the zone</p>
<p id="dns_api_63002__p0662131993410">The value ranges from <strong id="dns_api_63002__dns_api_63002_b19998125511334">1</strong> to <strong id="dns_api_63002__dns_api_63002_b1899825519334">2147483647</strong>.</p>
<p id="dns_api_63002__p7662111973418">The default value is <strong id="dns_api_63002__dns_api_63002_b1947775585810">300</strong>.</p>
</td>
</tr>
<tr id="dns_api_63002__row29641334171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p63311148171039">serial</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p26678057171039">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p201115484116">Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server</p>
<p id="dns_api_63002__p7524749171039">This parameter is not used currently.</p>
</td>
</tr>
<tr id="dns_api_63002__row44990376171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p30244483171039">status</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p47406357171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p9822846171039">Resource status</p>
<p id="dns_api_63002__p878313571410">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_63002__row1454557171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p51202644171039">record_num</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p32016130171039">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p53878535171039">Number of record sets in the zone</p>
</td>
</tr>
<tr id="dns_api_63002__row48476716171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p54136527171039">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p48020249171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p63987755171039">Pool ID of the zone, which is assigned by the system</p>
</td>
</tr>
<tr id="dns_api_63002__row49967872171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p35791512171039">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p10454086171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p8704812171039">Project ID of the zone</p>
</td>
</tr>
<tr id="dns_api_63002__row27690345171039"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p48529730171039">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p59988242171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p9292793171039">Time when the zone was created</p>
<p id="dns_api_63002__p583516468316">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_63002__row4377608115654"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p5844041115654">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p3605288915654">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p3460290715654">Time when the zone was updated</p>
<p id="dns_api_63002__p799714202510">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_63002__row384676871572"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p288749251572">links</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p571676251572">Object</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p50014989155938">Link to the current resource or other related resources.</p>
<p id="dns_api_63002__p660161572">When a response is broken into pages, a <strong id="dns_api_63002__b84235270695245">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_63002__p1967113511455">For details, see <a href="#dns_api_63002__table52442344175457">Table 5</a>.</p>
</td>
</tr>
<tr id="dns_api_63002__row177328815945"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p1595959815945">masters</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p1765902715945">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p2109506015945">Master DNS servers, from which the slave servers get DNS information</p>
<p id="dns_api_63002__p9475575518">This parameter is not used currently.</p>
</td>
</tr>
<tr id="dns_api_63002__row57448667171910"><td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63002__p3560499171932">router</p>
</td>
<td class="cellrowborder" valign="top" width="17.32%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63002__p19965041171932">Object</p>
</td>
<td class="cellrowborder" valign="top" width="64.31%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63002__p6555635171932">Information about the VPC associated with the zone. For details, see <a href="#dns_api_63002__table4512106017551">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63002__table52442344175457"></a><a name="table52442344175457"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63002__table52442344175457" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the <strong id="dns_api_63002__b17566129154510">links</strong> field</caption><thead align="left"><tr id="dns_api_63002__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_63002__p46156243175457"><strong id="dns_api_63002__b33722119454">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_63002__p47668234175457"><strong id="dns_api_63002__b490928333">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_63002__p35921708175457"><strong id="dns_api_63002__b138112129456">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63002__row54859922175457"><td class="cellrowborder" valign="top" width="18.3018301830183%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63002__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_63002__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_63002__p37040428175457">Link to the current resource</p>
</td>
</tr>
<tr id="dns_api_63002__row54251544174716"><td class="cellrowborder" valign="top" width="18.3018301830183%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63002__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_63002__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_63002__p76567451365">Link to the next page</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63002__table4512106017551"></a><a name="table4512106017551"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63002__table4512106017551" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Description of the <strong id="dns_api_63002__b1255672014455">router</strong> field</caption><thead align="left"><tr id="dns_api_63002__row2225931917551"><th align="left" class="cellrowborder" valign="top" width="18.54%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dns_api_63002__p5817443517551"><strong id="dns_api_63002__b17361926174518">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.46%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dns_api_63002__p3436442517551"><strong id="dns_api_63002__b323407241">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dns_api_63002__p3205505917551"><strong id="dns_api_63002__b79571246184614">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63002__row4470351134"><td class="cellrowborder" valign="top" width="18.54%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_63002__p38120631175524">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_63002__p57184665175519">String</p>
</td>
<td class="cellrowborder" valign="top" width="62%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_63002__p1635999216648">Resource status</p>
<p id="dns_api_63002__p656495918714">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_63002__row4632297717551"><td class="cellrowborder" valign="top" width="18.54%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_63002__p6117366017551">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_63002__p4937778317551">String</p>
</td>
<td class="cellrowborder" valign="top" width="62%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_63002__p4017744717551">Router ID (VPC ID)</p>
</td>
</tr>
<tr id="dns_api_63002__row2605270417551"><td class="cellrowborder" valign="top" width="18.54%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_63002__p2989427417551">router_region</p>
</td>
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_63002__p4423327117551">String</p>
</td>
<td class="cellrowborder" valign="top" width="62%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_63002__p2612521117551">Region of the VPC</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="dns_api_63002__li7863653171013">Example response<pre class="screen" id="dns_api_63002__screen6413204020223">{
"id": "ff8080825b8fc86c015b94bc6f8712c3",
"name": "example.com.",
"description": "This is an example zone.",
"email": "xx@example.com",
"ttl": 300,
"serial": 1,
"masters": [],
"status": "PENDING_CREATE",
"links": {
"self": "https://<em id="dns_api_63002__i45374312141510">Endpoint</em>/v2/zones/ff8080825b8fc86c015b94bc6f8712c3"
},
"pool_id": "ff8080825ab738f4015ab7513298010e",
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
"zone_type": "private",
"created_at": "2017-04-22T08:17:08.997",
"updated_at": null,
"record_num": 0,
"router": {
"status": "PENDING_CREATE",
"router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
"router_region": "xx"
}
}</pre>
</li></ul>
</div>
<div class="section" id="dns_api_63002__section9249181042119"><h4 class="sectiontitle">Returned Value</h4><p id="dns_api_63002__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_63002__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_63000.html">Private Zone Management</a></div>
</div>
</div>
View Git Blame Copy Permalink