forked from laiweijian4/doc-exports
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Lu, Huayi <luhuayi@huawei.com> Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
297 lines
32 KiB
HTML
297 lines
32 KiB
HTML
<a name="EN-US_TOPIC_0000001224645689"></a><a name="EN-US_TOPIC_0000001224645689"></a>
|
|
|
|
<h1 class="topictitle1">Restoring a Cluster</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_s4bb187ea1af94154b7c794fc9f01b061"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p36702580">This API is used to restore clusters using the snapshot.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_s6a55719cec1c4188a8156444c922d0d5"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_ul20119003"><li id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_li46853302">URI format<pre class="screen" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_screen1344933114013">POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions</pre>
|
|
</li><li id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_li37021121">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_table64754634" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_row57662920"><th align="left" class="cellrowborder" valign="top" width="17.7%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p40184969"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b84235270617228">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.18%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p33757095"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b6167984116271">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.6%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p49970185"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b145791954142914">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.519999999999996%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p21053208"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b127886559295">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_row27588283"><td class="cellrowborder" valign="top" width="17.7%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p20058459">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.18%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p14122463">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p3068848">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.519999999999996%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p2031732215610"><span id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_text1033617398342">Project ID</span>. For details about how to obtain the ID, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_radbf3bb5426943b68cb03a24c2cf64b2"><td class="cellrowborder" valign="top" width="17.7%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_a03c8eca6755c43a48a273c9bf1365e53">snapshot_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.18%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_a3bba5ae3c1bc4bcda5c516b68eb651ef">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_a7b0d688b70084f788ae2a5621c89bb0c">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.519999999999996%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_ad85c0540149049c9bbaec6f01f90fa8d">ID of the snapshot to be restored</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_sa8d6a7d82f7142a0b8f412a419261ad6"><h4 class="sectiontitle">Request Message</h4><ul id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_u4b25cc42cce24618829ab99136712beb"><li id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_li41230146196">Request example<pre class="screen" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_s883724b546c94463a23541334cdcb66a">POST /v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/actions
|
|
{"restore": {
|
|
"name": "dws-1",
|
|
"subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
|
|
"security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
|
|
"vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
|
|
"availability_zone": "eu-de-01",
|
|
"port": 8000,
|
|
"public_ip": {
|
|
"public_bind_type": "auto_assign",
|
|
"eip_id": ""
|
|
},
|
|
"enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_ul18476557"><li id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_li32071293">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_requestParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row03311836131918"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p113431936111913"><strong id="EN-US_TOPIC_0000001224645689__b154044491">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p14344123619194"><strong id="EN-US_TOPIC_0000001224645689__b1367989790">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p53492360199"><strong id="EN-US_TOPIC_0000001224645689__b83955091">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p143502036161916"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b9775181120307">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row8332736121918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1935243614191">restore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p3353036101915">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p735413367197"><a href="#EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_table1765163917178">Restore</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p14356193616195">Object to be restored</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_table1765163917178"></a><a name="en-us_topic_0000001145816475_table1765163917178"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_table1765163917178" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Restore</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row167674399176"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1416984811814"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b11531165474511">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p61697489183"><strong id="EN-US_TOPIC_0000001224645689__b1761228279">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1717094816182"><strong id="EN-US_TOPIC_0000001224645689__b51313750">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p617084871811"><strong id="EN-US_TOPIC_0000001224645689__b1724586522">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row1876733915177"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p119321110101814">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p8932410131811">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1293210100186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p89331101185">Cluster name, which must be unique. The cluster name must contain 4 to 64 characters, which must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row19768103961713"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p615418363185">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p515416363186">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1315473619187">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p131541236111813">Subnet ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row10768939151713"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p78696331910">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p12869173181912">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1686912318192">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1787113316195">Security group ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row476863961714"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p269941731914">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p370010170196">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p13701617131912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1770114171195">VPC ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row876912391178"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p797232916193">availability_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p19973129141913">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p797520294198">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p497542951915">AZ of a cluster. The default value is the same as that of the original cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row147691239141713"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p296425131913">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p179651151141916">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1196512517199">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p2965155191912">Service port of a cluster. The value ranges from 8000 to 30000. The default value is <strong id="EN-US_TOPIC_0000001224645689__b9401115517294">8000</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row076943912176"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1035610614200">public_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p835710652010">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p7358669202"><a href="#EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_request_public_ip">PublicIp</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1336115662010">Public IP address. If the parameter is not specified, public connection is not used by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row2077063961718"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p34891819132015">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p14899195202">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p13489181992012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p8489719192015">Enterprise project. The default enterprise project ID is <strong id="EN-US_TOPIC_0000001224645689__b163620177052457">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_request_public_ip"></a><a name="en-us_topic_0000001145816475_request_public_ip"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_request_public_ip" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PublicIp</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row843233611916"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.1.3.2.5.1.1"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1343523611913"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b13916410174815">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.1.3.2.5.1.2"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1543743631919"><strong id="EN-US_TOPIC_0000001224645689__b569224894">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.1.3.2.5.1.3"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1843963621917"><strong id="EN-US_TOPIC_0000001224645689__b1787558526">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.1.3.2.5.1.4"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p24441236171918"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b71088497478">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row154321836181913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p19446136151914">public_bind_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1544713616194">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p64491536151915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.1.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__p10825429174912">Binding type of an EIP. The value can be one of the following:</p>
|
|
<ul id="EN-US_TOPIC_0000001224645689__ul1482562974920"><li id="EN-US_TOPIC_0000001224645689__li88251329184918"><strong id="EN-US_TOPIC_0000001224645689__b17702121194310"><span id="EN-US_TOPIC_0000001224645689__ph1325141272918">auto_assign</span></strong></li><li id="EN-US_TOPIC_0000001224645689__li1224625212133"><strong id="EN-US_TOPIC_0000001224645689__b2111141554314">not_use</strong></li><li id="EN-US_TOPIC_0000001224645689__li11155202914139"><strong id="EN-US_TOPIC_0000001224645689__b42181613434">bind_existing</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row34321036141917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p5451143616192">eip_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p17452736171914">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p6453163614197">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.1.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p74596363199">EIP ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_sb3ef013c33a348739e46163a3251532e"><h4 class="sectiontitle">Response Message</h4><ul id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_ul10023380"><li id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_lccc74578ef5c4def9b780aa76cf2a3d7">Example response<pre class="screen" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_s20efcda16e1f4ff286ec2312a7e3a61f">{
|
|
"cluster": {
|
|
"id": "7d85f602-a948-4a30-afd4-e84f47471c15"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_ul14075498"><li id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_li59570626">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_responseParameter" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row246403612194"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p4498113621912"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b123421621134813">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1349983631912"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b196222111484">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1050133651915"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b5199162213306">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row3464836181910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p450317360199">cluster</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p16508136141917"><a href="#EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_response_cluster">Cluster</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p450973620199">Cluster object</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_response_cluster"></a><a name="en-us_topic_0000001145816475_response_cluster"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_response_cluster" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Cluster</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row85101836111910"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p8512193611919"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b162382644812">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p135141036151918"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b16101126184815">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p1151673671917"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b71201227114816">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_row151003619193"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p115170363198">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p15518103641913">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_p11520113620193">Cluster ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_s47782db7ac574d0596c1a51df09a94cc"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_ul27303998"><li id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_li44409397">Normal<p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p64140254"><a name="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_li44409397"></a><a name="en-us_topic_0000001145816475_en-us_topic_0084768514_li44409397"></a>200</p>
|
|
</li><li id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_li40391380">Exception
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_table27978103" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Returned values</caption><thead align="left"><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_row60105532"><th align="left" class="cellrowborder" valign="top" width="40.239999999999995%" id="mcps1.3.5.2.2.1.2.3.1.1"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p36709949"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b842352706141543">Returned Value</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.760000000000005%" id="mcps1.3.5.2.2.1.2.3.1.2"><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p20715931"><strong id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_b12673132713015">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_row268861"><td class="cellrowborder" valign="top" width="40.239999999999995%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p21777804">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.760000000000005%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p19171695">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_row38327532"><td class="cellrowborder" valign="top" width="40.239999999999995%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p17522377">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.760000000000005%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p10026414">Authorization failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_row23128868"><td class="cellrowborder" valign="top" width="40.239999999999995%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p61498985">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.760000000000005%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p15361866">No operation permission.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_row4039073"><td class="cellrowborder" valign="top" width="40.239999999999995%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p58729529">404 Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.760000000000005%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p59471393">No resources found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_row65480490"><td class="cellrowborder" valign="top" width="40.239999999999995%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p2319502">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.760000000000005%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p53661974">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_row13195723"><td class="cellrowborder" valign="top" width="40.239999999999995%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p62220677">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.760000000000005%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001224645689__en-us_topic_0000001145816475_en-us_topic_0084768514_p6710104">The service is unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0023.html">Snapshot Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|