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

316 lines
26 KiB
HTML
Raw Permalink Blame History

<a name="dns_api_63009"></a><a name="dns_api_63009"></a>
<h1 class="topictitle1">Modifying a Private Zone</h1>
<div id="body1508845327200"><div class="section" id="dns_api_63009__section3569153217343"><h4 class="sectiontitle">Function</h4><p id="dns_api_63009__p2420228517348">Modify a private zone.</p>
</div>
<div class="section" id="dns_api_63009__section6163262617350"><h4 class="sectiontitle">URI</h4><p id="dns_api_63009__en-us_topic_0080995382_p554371517266">PATCH /v2/zones/{zone_id}</p>
<div class="p" id="dns_api_63009__en-us_topic_0080995382_p454702216814">For details, see <a href="#dns_api_63009__tacd282d91a914e70a7e35f44180b61aa">Table 1</a>.
<div class="tablenoborder"><a name="dns_api_63009__tacd282d91a914e70a7e35f44180b61aa"></a><a name="tacd282d91a914e70a7e35f44180b61aa"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63009__tacd282d91a914e70a7e35f44180b61aa" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the URI</caption><thead align="left"><tr id="dns_api_63009__r461951832c9c4a788d3a29813fd6006d"><th align="left" class="cellrowborder" valign="top" width="15.459999999999999%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dns_api_63009__acf0cac48978e4f96b71afbec7f79576e"><strong id="dns_api_63009__b891385144">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.459999999999999%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dns_api_63009__ac42fd57c878140d7b0459137e8babd55"><strong id="dns_api_63009__b209869611416">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.53%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dns_api_63009__aabaec6aa7c8443d59fa706845ff1d28b"><strong id="dns_api_63009__b197520720411">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.55%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dns_api_63009__ae870f28af9f7424185040e4540001949"><strong id="dns_api_63009__b1977916814413">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63009__r458847e9fb5647bf9d773276361fe788"><td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dns_api_63009__ab6bccc4405ed4594930f55ae38209450">zone_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.459999999999999%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dns_api_63009__a2d45a5f16c804754aa263637564eec4c">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dns_api_63009__a10129d8fbda642759f1eb05715b5b5bc">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.55%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dns_api_63009__ae6c59bfcf6a341dd9d9d8b7908c7db8a">ID of the zone to be modified</p>
<p id="dns_api_63009__p1669018482183">You can obtain the value by calling the API in <a href="dns_api_63006.html">Querying Private Zones</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="dns_api_63009__section4207148117353"><h4 class="sectiontitle">Request</h4><ul id="dns_api_63009__uf4c2bf60e6cc4253998687ce336522b1"><li id="dns_api_63009__le294db46c5584b359cedad1b744f97cf">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63009__tc108ce509e2d411fa6cfb6f193f37133" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request</caption><thead align="left"><tr id="dns_api_63009__r139885ec379f4f19b8d830dd368d368e"><th align="left" class="cellrowborder" valign="top" width="16.33%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="dns_api_63009__adcd0fcfe879d404ca45d675c00467a67"><strong id="dns_api_63009__b111098511997">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="dns_api_63009__en-us_topic_0080995382_p473035017742"><strong id="dns_api_63009__b207451152592">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.37%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="dns_api_63009__en-us_topic_0080995382_p386753717742"><strong id="dns_api_63009__b417115411912">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.059999999999995%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="dns_api_63009__af771f63bb344447ca66df90f12e29e47"><strong id="dns_api_63009__b18330655590">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63009__r79d4ffb128df44eea2fe028e9ee95caf"><td class="cellrowborder" valign="top" width="16.33%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63009__a09232732617f4165b17554a4a672d0b8">description</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63009__en-us_topic_0080995382_p759162017742">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63009__afc615a782a7c4f438473ad20495eaff1">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63009__a55e92ec653404fe69560006cf9dc32f0">Description of the zone, which cannot exceed 255 characters</p>
<p id="dns_api_63009__en-us_topic_0080995382_p37540522006">If this parameter is left blank, the value will not be changed.</p>
<p id="dns_api_63009__en-us_topic_0080995382_p474692155919">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_63009__rc1f8751e7f854985901c5de652daa580"><td class="cellrowborder" valign="top" width="16.33%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63009__afab6fc762eb743c29c1cb7f17b880a85">email</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63009__en-us_topic_0080995382_p650279617742">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63009__ab8eae8645e994984aa6ff68bf125f05e">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63009__a540d928c47974814bb0784174ff1d23f">Email address of the administrator managing the zone</p>
<p id="dns_api_63009__en-us_topic_0080995382_p16253220614">If this parameter is left blank, the value will not be changed.</p>
<p id="dns_api_63009__a28fb1a83bf20491b87499617246a4e58">The value is left blank by default.</p>
</td>
</tr>
<tr id="dns_api_63009__ra92fe0b0bea5467696ded2189261f7e1"><td class="cellrowborder" valign="top" width="16.33%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dns_api_63009__a14a07b00a14d405aa692873540c982cc">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dns_api_63009__a85d682d35d8146f88b4efa38861c2441">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dns_api_63009__a40f021a44f29448d975126c695fb4e94">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.059999999999995%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dns_api_63009__a968c40752cbb4776b95995372f3b7c1a">Caching period of the SOA record set (in seconds)</p>
<p id="dns_api_63009__affaa28ae17564304bca18b476a63f0b4">The value ranges from <strong id="dns_api_63009__b72181596290">1</strong> to <strong id="dns_api_63009__b1710495916488">2147483647</strong>.</p>
<p id="dns_api_63009__en-us_topic_0080995382_p52661425313">If this parameter is left blank, the value will not be changed.</p>
<p id="dns_api_63009__abf25df523584405790017ac5004fb6f5">The value is left blank by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="dns_api_63009__l2438f0cba2ca47b98d87a480f10e442d">Example request<p id="dns_api_63009__accca9be3f6d14c5ea0f97bf6ee14dce8"><a name="dns_api_63009__l2438f0cba2ca47b98d87a480f10e442d"></a><a name="l2438f0cba2ca47b98d87a480f10e442d"></a>Modify the zone whose ID is 2c9eb155587194ec01587224c9f90149:</p>
<pre class="codeblock" id="dns_api_63009__codeblock8589122325110">PATCH https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149</pre>
<pre class="screen" id="dns_api_63009__screen1381762845118">{
"description": "This is an example zone.",
"email": "xx@example.org",
"ttl": 300
}</pre>
</li></ul>
</div>
<div class="section" id="dns_api_63009__section2142173017358"><h4 class="sectiontitle">Response</h4><ul id="dns_api_63009__ul24043226171010"><li id="dns_api_63009__li61921720171010">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63009__table54601120171039" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response</caption><thead align="left"><tr id="dns_api_63009__r318933e6ce9c44e2a969016a56f54b87"><th align="left" class="cellrowborder" valign="top" width="17.990000000000002%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dns_api_63009__afdb5e5497eb64a139f0d2c21f6ff1d94"><strong id="dns_api_63009__b13925416189">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.77%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dns_api_63009__a4c97f3baac734b45ae85d89e44bef37e"><strong id="dns_api_63009__b437820581816">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.239999999999995%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dns_api_63009__aa1f0887180484d7db960c625ed02b017"><strong id="dns_api_63009__b1874286191810">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63009__r94cb17ae3b13430e98670a32a63a5caa"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__a351211b9573245c7ace8b11f91e5aac5">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__a47667ac4d8b34540a85f994f7bb88f3e">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__ad6877fe93324416aab90b84e6d04169d">Zone ID, which is a UUID used to identify the zone</p>
</td>
</tr>
<tr id="dns_api_63009__r2229bfd978d44b73814a6e7d879b6454"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__af8bb7c6911a841379501b3d3313e2c00">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__aa17915fbec1f4b118c7c85033f381a59">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__ad8eefd35bde147c68ae7abe18f72c2d6">Zone name</p>
</td>
</tr>
<tr id="dns_api_63009__r993e4cdcd1be41bb83c1f85c3fb6d7d6"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__a5da8a442117c4dc6b2c9175ec6e6ddee">description</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__a1887e3805d0343e8acf2185e6853652a">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a34c95c53bd9b46a698bcdcac2d17e7e9">Zone description</p>
</td>
</tr>
<tr id="dns_api_63009__r59fc719cd95348fe8a030e073b85a209"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__ae2111a24793940ef80c619950e599192">email</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__en-us_topic_0057311027_p336297171039">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a147f90e4636f4ae3b13182d32996c6c5">Email address of the administrator managing the zone</p>
</td>
</tr>
<tr id="dns_api_63009__rbaa55719838a49d8ade18f21c00b1bd6"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__a43a238d9dfe041cfa878dd5b96760604">zone_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__a95e13dfe14c942ccb9b1f2b560c7430c">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__p9394279212">Zone type, which can be <strong id="dns_api_63009__b1910912018181">public</strong> or <strong id="dns_api_63009__b611062017181">private</strong></p>
</td>
</tr>
<tr id="dns_api_63009__re3b052108fa34b5e9c0a6bb456009250"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__afafe865e8e534c168eec8c44822c10a9">ttl</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__a9bd9de54fdcb4a77bc408a76a9f7a999">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a3a912cb7fb2e4d579e84296f9637a0dc">TTL value of the SOA record set in the zone</p>
<p id="dns_api_63009__p0662131993410">The value ranges from <strong id="dns_api_63009__dns_api_63002_b19998125511334">1</strong> to <strong id="dns_api_63009__dns_api_63002_b1899825519334">2147483647</strong>.</p>
<p id="dns_api_63009__p7662111973418">The default value is <strong id="dns_api_63009__dns_api_63002_b1947775585810">300</strong>.</p>
</td>
</tr>
<tr id="dns_api_63009__race7c02633d648eeb49e7fcf89da86ad"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__adc16ebab44594ab096fb4516c4f597e3">serial</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__a123548da301b40baa49f08a0f8f4129c">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__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_63009__p7524749171039">This parameter is not used currently.</p>
</td>
</tr>
<tr id="dns_api_63009__re58847a4e7ac4c16af7f937d50f6be75"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__ae7b5fed19fe444a481e02e979ce2c3e3">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__a482a529c94cb443bafc545b8b309c654">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a30277a50368848b38e746604761c5d65">Resource status</p>
<p id="dns_api_63009__en-us_topic_0057311027_p878313571410">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_63009__r106f4bb096fe493895f95610909a5695"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__a55ed88eabe20430dbb7c174ccb9f9098">record_num</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__ad6b67a0a5d8247c48c27e3f98b580421">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a23d48313d540467893d2e8ed2745df7f">Number of record sets in the zone</p>
</td>
</tr>
<tr id="dns_api_63009__r836f1aa44d6d4677957fcd1b16d80b05"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__aba20c68200f546629198b4c7ae4b51e5">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__a042da40702f840c4ad8c5854ca7c130b">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a3fd761e1538a41dab5a2accafe081021">Pool ID of the zone, which is assigned by the system</p>
</td>
</tr>
<tr id="dns_api_63009__r297bd05aa41f4ea49a13759d9418f43e"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__a61fe74ffa6624d65ba007fe8d3d01ede">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__ae0bffeb0816e42b789c4d583e004818f">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__p8704812171039">Project ID of the zone</p>
</td>
</tr>
<tr id="dns_api_63009__r8463bc32c80b46e5aea56e1008192352"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__a5f328d90b9494167974374d31c2fbbd8">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__ade042db7b99e42f589039904ed0d1c9b">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a0a619f7bac0c48acbf17c43865c0dafb">Time when the zone was created</p>
<p id="dns_api_63009__p583516468316">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_63009__r42fdbc0229d94cf78b006ba57b634f2e"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__a10297bac5cde43b3a82a514ab7c3b51f">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__a83919e1000ce4c20811d75e9d5572c7a">String</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a05f275c2fe0d4ba38dc5f2942b24e0a2">Time when the zone was updated</p>
<p id="dns_api_63009__en-us_topic_0057311027_p799714202510">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
</td>
</tr>
<tr id="dns_api_63009__ra3bcb082cd044c249c0384dbc9d797ce"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__en-us_topic_0057311027_p288749251572">links</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__en-us_topic_0057311027_p571676251572">Object</p>
<p id="dns_api_63009__p7650618171011"></p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a070f1d50477745b5882c7d4f45018aff">Link to the current resource or other related resources.</p>
<p id="dns_api_63009__en-us_topic_0057311027_p660161572">When a response is broken into pages, a <strong id="dns_api_63009__b549244872214">next</strong> link is provided to retrieve all results.</p>
<p id="dns_api_63009__p4628317174618">For details, see <a href="#dns_api_63009__table52442344175457">Table 4</a>.</p>
</td>
</tr>
<tr id="dns_api_63009__rc90495e06a7e4457b95cc2d940940567"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__afcba5be99ef0439f8b0ca0e558f90e8b">masters</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__a24cc31056df64a4794ccb3989b481240">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__aecd21264341f447998b070e439eca8a0">Master DNS servers, from which the slave servers get DNS information</p>
<p id="dns_api_63009__en-us_topic_0057311027_p9475575518">This parameter is not used currently.</p>
</td>
</tr>
<tr id="dns_api_63009__r926630e41cb24a96818249071f58c48a"><td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dns_api_63009__a3c260ed464664ec7a1078e96c6fa2e82">routers</p>
</td>
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dns_api_63009__af4d8729ebfa6438aaa842810310f4cec">Array of object</p>
</td>
<td class="cellrowborder" valign="top" width="62.239999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dns_api_63009__a1ab67663b21049b49f722e4cef72c56c">Information about the VPC associated with the zone. For details, see <a href="#dns_api_63009__table4448008117179">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63009__table52442344175457"></a><a name="table52442344175457"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63009__table52442344175457" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameters in the <strong id="dns_api_63009__b104558173233">links</strong> field</caption><thead align="left"><tr id="dns_api_63009__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_63009__p46156243175457"><strong id="dns_api_63009__b1813101982311">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_63009__p47668234175457"><strong id="dns_api_63009__b118620102315">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_63009__p35921708175457"><strong id="dns_api_63009__b8919122014234">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63009__row54859922175457"><td class="cellrowborder" valign="top" width="18.3018301830183%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dns_api_63009__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_63009__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_63009__p37040428175457">Link to the current resource</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dns_api_63009__table4448008117179"></a><a name="table4448008117179"></a><table cellpadding="4" cellspacing="0" summary="" id="dns_api_63009__table4448008117179" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Description of the <strong id="dns_api_63009__b825913811254">routers</strong> field</caption><thead align="left"><tr id="dns_api_63009__row6132935617179"><th align="left" class="cellrowborder" valign="top" width="18.538146185381464%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dns_api_63009__p36588677171719"><strong id="dns_api_63009__b1740331052519">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.668033196680334%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dns_api_63009__p9906869171719"><strong id="dns_api_63009__b15591191119259">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.79382061793821%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dns_api_63009__p64258954171719"><strong id="dns_api_63009__b18437171213253">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dns_api_63009__row1024510342619"><td class="cellrowborder" valign="top" width="18.538146185381464%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_63009__p38120631175524">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.668033196680334%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_63009__p57184665175519">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.79382061793821%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_63009__p1635999216648">Resource status</p>
<p id="dns_api_63009__p656495918714">For details, see <a href="dns_api_80005.html#dns_api_80005__section33673592114748">Resource Status</a>.</p>
</td>
</tr>
<tr id="dns_api_63009__row266872817179"><td class="cellrowborder" valign="top" width="18.538146185381464%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_63009__p25118582171719">router_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.668033196680334%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_63009__p50755907171719">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.79382061793821%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_63009__p17587794171719">ID of the associated VPC</p>
</td>
</tr>
<tr id="dns_api_63009__row6657832817179"><td class="cellrowborder" valign="top" width="18.538146185381464%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dns_api_63009__p3709384171719">router_region</p>
</td>
<td class="cellrowborder" valign="top" width="19.668033196680334%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dns_api_63009__p43861924171719">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.79382061793821%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dns_api_63009__p63154928171719">Region of the VPC</p>
<p id="dns_api_63009__p38645142171939">If it is left blank, the region of the project in the token takes effect by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="dns_api_63009__li7863653171013">Example response<pre class="screen" id="dns_api_63009__screen6413204020223">{
"id": "ff8080825b8fc86c015b94bc6f8712c3",
"name": "example.com.",
"description": "This is an example zone.",
"email": "xx@example.com",
"ttl": 300,
"serial": 1,
"masters": [],
"status": "ACTIVE",
"links": {
"self": "https://<em id="dns_api_63009__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": "2017-04-22T08:17:10.849",
"record_num": 2,
"routers": [
{
"status": "ACTIVE",
"router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
"router_region": "xx"
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="dns_api_63009__section9249181042119"><h4 class="sectiontitle">Returned Value</h4><p id="dns_api_63009__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_63009__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