forked from docs/doc-exports
Wei, Hongmin
ab56d080fb
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
412 lines
33 KiB
HTML
412 lines
33 KiB
HTML
<a name="sdrs_05_0504"></a><a name="sdrs_05_0504"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About a Protected Instance</h1>
|
|
<div id="body1524795306610"><div class="section" id="sdrs_05_0504__en-us_topic_0079693002_section34649765"><h4 class="sectiontitle">Function</h4><p id="sdrs_05_0504__en-us_topic_0079693002_p9084369">This API is used to query the details about a protected instance, such as the protected instance ID and name.</p>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0504__section11919721173610"><h4 class="sectiontitle">Constraints and Limitations</h4><p id="sdrs_05_0504__p31611624203610">None</p>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0504__en-us_topic_0079693002_section39390935"><h4 class="sectiontitle">URI</h4><ul id="sdrs_05_0504__en-us_topic_0079693002_ul52084342"><li id="sdrs_05_0504__en-us_topic_0079693002_li66105898">URI format<p id="sdrs_05_0504__en-us_topic_0079693002_p212314194247"><a name="sdrs_05_0504__en-us_topic_0079693002_li66105898"></a><a name="en-us_topic_0079693002_li66105898"></a>GET /v1/{project_id}/protected-instances/{protected_instance_id}</p>
|
|
</li><li id="sdrs_05_0504__en-us_topic_0079693002_li52977523">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0504__en-us_topic_0079693002_table63321005" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0504__en-us_topic_0079693002_row37593218"><th align="left" class="cellrowborder" valign="top" width="19.801980198019802%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="sdrs_05_0504__p12357172051911">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="sdrs_05_0504__p2357132017191">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="sdrs_05_0504__p336018202195">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.504950495049506%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="sdrs_05_0504__p12360720181917">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0504__en-us_topic_0079693002_row29123463"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="sdrs_05_0504__p153601520131916">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="sdrs_05_0504__p3360920181914">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="sdrs_05_0504__p7360172041919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.504950495049506%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="sdrs_05_0504__p83606200194">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__row36505554367"><td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="sdrs_05_0504__p173602206193">protected_instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="sdrs_05_0504__p1360192001914">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="sdrs_05_0504__p13606201197">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.504950495049506%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="sdrs_05_0504__p336052015194">Specifies the ID of a protected instance.</p>
|
|
<p id="sdrs_05_0504__p431715368536">You can obtain this value by calling the API described in <a href="sdrs_05_0503.html">Querying Protected Instances</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0504__en-us_topic_0079693002_section18974100"><h4 class="sectiontitle">Request</h4><ul id="sdrs_05_0504__ul456035817515"><li id="sdrs_05_0504__li186521722515">Request parameters<p id="sdrs_05_0504__p83441271114"><a name="sdrs_05_0504__li186521722515"></a><a name="li186521722515"></a>None</p>
|
|
</li><li id="sdrs_05_0504__li145601358155117">Example request<p id="sdrs_05_0504__p10581201085210"><a name="sdrs_05_0504__li145601358155117"></a><a name="li145601358155117"></a>GET https://{Endpoint}/v1/{project_id}/protected-instances/50f5091e-9e9e-473c-a932-2a2cbcbeb1ff</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0504__en-us_topic_0079693002_section36549175"><h4 class="sectiontitle">Response</h4><ul id="sdrs_05_0504__en-us_topic_0079693002_ul48735027"><li id="sdrs_05_0504__en-us_topic_0079693002_li35962059">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0504__table155991608555" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0504__row460510055518"><th align="left" class="cellrowborder" valign="top" width="29.07%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="sdrs_05_0504__p14250742111914">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="sdrs_05_0504__p15250184231911">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.49%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="sdrs_05_0504__p13250154213194">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0504__row86164025512"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="sdrs_05_0504__p825044241918">protected_instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="sdrs_05_0504__p725034219195">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="sdrs_05_0504__p625024241915">Specifies the details about a protected instance.</p>
|
|
<p id="sdrs_05_0504__p17342112914428">For details, see <a href="#sdrs_05_0504__table503353570">Table 1</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="sdrs_05_0504__table503353570"></a><a name="table503353570"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0504__table503353570" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="sdrs_05_0504__sdrs_05_0503_b13641202262711">protected_instances</strong> field description</caption><thead align="left"><tr id="sdrs_05_0504__sdrs_05_0503_row131163505710"><th align="left" class="cellrowborder" valign="top" width="29.07%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="sdrs_05_0504__sdrs_05_0503_p19375192311238">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.34%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="sdrs_05_0504__sdrs_05_0503_p137512392315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.59%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="sdrs_05_0504__sdrs_05_0503_p183751523192314">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0504__sdrs_05_0503_row1829133585715"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p7375132315239">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p237592310236">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p937518232232">Specifies the ID of a protected instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row1472144614199"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p13751523152316">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p1537592313235">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p7375102312318">Specifies the name of a protected instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row1845264811918"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p1266741153611">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p826674111364">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p19266104123612">Specifies the description of a protected instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row555943910310"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p14377923112315">server_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p18377823152317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p1237702319235">Specifies the ID of a protection group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row2503145051917"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p8375223142315">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p17377723182310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p26171744195317">Specifies the status of a protected instance.</p>
|
|
<p id="sdrs_05_0504__sdrs_05_0503_p11377122372317">For details, see <a href="en-us_topic_0126152931.html">Protected Instance Status</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row168521941147"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p14745142282317">progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p1830712716181">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p1330727191818">Specifies the synchronization progress of a protected instance.</p>
|
|
<p id="sdrs_05_0504__sdrs_05_0503_p12307127121818">Unit: %</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row156171333144116"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p33771237238">source_server</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p837714234239">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p8377152312314">Specifies the production site server ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row473463515411"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p1037702317238">target_server</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p23779231233">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p12377192316233">Specifies the DR site server ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row022814014120"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p12377923192314">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p737762314230">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p4377182318230">Specifies the time when a protected instance was created.</p>
|
|
<p id="sdrs_05_0504__sdrs_05_0503_p1078620139012">The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, <strong id="sdrs_05_0504__sdrs_05_0503_b1618132120140">2019-04-01 12:00:00.000</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row757514214419"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p1937717234231">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p1377323132313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p1937716237235">Specifies the time when a protected instance was updated.</p>
|
|
<p id="sdrs_05_0504__sdrs_05_0503_p1942786173519">The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, <strong id="sdrs_05_0504__sdrs_05_0503_b810333131517">2019-04-01 12:00:00.000</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row08503318414"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p10235944142418">priority_station</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p10235154410245">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p382553192519">Specifies the current production site AZ of the protection group containing the protected instance.</p>
|
|
<ul id="sdrs_05_0504__sdrs_05_0503_ul782135312518"><li id="sdrs_05_0504__sdrs_05_0503_li15823536258"><strong id="sdrs_05_0504__sdrs_05_0503_b17653238122310">source</strong>: indicates that the current production site AZ is the <strong id="sdrs_05_0504__sdrs_05_0503_b1665418386237">source_availability_zone</strong> value.</li><li id="sdrs_05_0504__sdrs_05_0503_li1387855513251"><strong id="sdrs_05_0504__sdrs_05_0503_b1278154814238">target</strong>: indicates that the current production site AZ is the <strong id="sdrs_05_0504__sdrs_05_0503_b187838483234">target_availability_zone</strong> value.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row1974415342560"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p1374517342565">attachment</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p474543475616">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p1674513345564">Specifies the attached replication pairs.</p>
|
|
<p id="sdrs_05_0504__sdrs_05_0503_p94849197376">For details, see <a href="sdrs_05_0503.html#sdrs_05_0503__table1575342962014">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row1511716165613"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p198281231145613">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p20771154912569">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p15241635617">Specifies the tag list.</p>
|
|
<p id="sdrs_05_0504__sdrs_05_0503_p139197593379">For details, see <a href="sdrs_05_0503.html#sdrs_05_0503__table12339146338">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row1347091555717"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p6472615185719">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p10709144620575">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p1786654614533">Specifies the metadata of a protected instance.</p>
|
|
<p id="sdrs_05_0504__sdrs_05_0503_p370974645720">For details, see <a href="sdrs_05_0503.html#sdrs_05_0503__table8582730112710">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0504__table179273775819" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="sdrs_05_0504__sdrs_05_0503_b1262385652719">attachment</strong> field description</caption><thead align="left"><tr id="sdrs_05_0504__sdrs_05_0503_row157542290208"><th align="left" class="cellrowborder" valign="top" width="29.062906290629066%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="sdrs_05_0504__sdrs_05_0503_p167541029122015"><strong id="sdrs_05_0504__sdrs_05_0503_b9456951154117">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.42174217421742%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="sdrs_05_0504__sdrs_05_0503_p77541429102015">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.51535153515352%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="sdrs_05_0504__sdrs_05_0503_p13754172912015"><strong id="sdrs_05_0504__sdrs_05_0503_b1982665274115">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0504__sdrs_05_0503_row57541029192012"><td class="cellrowborder" valign="top" width="29.062906290629066%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p197541729112016">replication</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.42174217421742%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p197546293203">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.51535153515352%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p11754162962013">Specifies the ID of a replication pair.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row7754122902018"><td class="cellrowborder" valign="top" width="29.062906290629066%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p17754152962012">device</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.42174217421742%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p1754132902020">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.51535153515352%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p97541729162014">Specifies the device name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0504__table537215313717" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="sdrs_05_0504__sdrs_05_0503_b1954114574315">tags</strong> field description</caption><thead align="left"><tr id="sdrs_05_0504__sdrs_05_0503_row43396416331"><th align="left" class="cellrowborder" valign="top" width="29.01290129012902%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="sdrs_05_0504__sdrs_05_0503_p13396473310"><strong id="sdrs_05_0504__sdrs_05_0503_b8226188154419">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.401740174017398%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="sdrs_05_0504__sdrs_05_0503_p7339247336"><strong id="sdrs_05_0504__sdrs_05_0503_b5715144294014">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.58535853585359%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="sdrs_05_0504__sdrs_05_0503_p7339343338"><strong id="sdrs_05_0504__sdrs_05_0503_b57498420443">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0504__sdrs_05_0503_row43406415336"><td class="cellrowborder" valign="top" width="29.01290129012902%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p7340204133310">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.401740174017398%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p1334016412332">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.58535853585359%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p9340164163314">Specifies the tag key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0503_row113401848337"><td class="cellrowborder" valign="top" width="29.01290129012902%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p193401449333">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.401740174017398%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p12340546334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.58535853585359%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p1234015416337">Specifies the tag value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0504__table18286124016331" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Field <strong id="sdrs_05_0504__sdrs_05_0503_b842352706195118">metadata</strong> description</caption><thead align="left"><tr id="sdrs_05_0504__sdrs_05_0503_row13583230202711"><th align="left" class="cellrowborder" valign="top" width="29.01290129012902%" id="mcps1.3.5.2.1.5.2.4.1.1"><p id="sdrs_05_0504__sdrs_05_0503_p18958174419296"><strong id="sdrs_05_0504__sdrs_05_0503_b3445153418161">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.64176417641764%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="sdrs_05_0504__sdrs_05_0503_p12958154420296">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.34533453345335%" id="mcps1.3.5.2.1.5.2.4.1.3"><p id="sdrs_05_0504__sdrs_05_0503_p395816448297"><strong id="sdrs_05_0504__sdrs_05_0503_b930512361165">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0504__sdrs_05_0503_row6583930152715"><td class="cellrowborder" valign="top" width="29.01290129012902%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="sdrs_05_0504__sdrs_05_0503_p1558353082720">__system__frozen</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.64176417641764%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="sdrs_05_0504__sdrs_05_0503_p11583730102710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.34533453345335%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="sdrs_05_0504__sdrs_05_0503_p958313303271">Specifies whether the resource is frozen.</p>
|
|
<ul id="sdrs_05_0504__sdrs_05_0503_ul529114370311"><li id="sdrs_05_0504__sdrs_05_0503_li152921437183118"><strong id="sdrs_05_0504__sdrs_05_0503_b12328157201913">true</strong>: indicates that the resource is frozen.</li><li id="sdrs_05_0504__sdrs_05_0503_li1108121319326">Empty: indicates that the resource is not frozen.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="sdrs_05_0504__ul10822125034216"><li id="sdrs_05_0504__li17822145018420">Example response<pre class="screen" id="sdrs_05_0504__screen18215505427">{
|
|
"protected_instance": {
|
|
"id": "50f5091e-9e9e-473c-a932-2a2cbcbeb1ff",
|
|
"name": "ecs_sdrs_test",
|
|
"description": "1111",
|
|
"server_group_id": "943c7d15-0371-4b89-b1a6-db1ef35c9263",
|
|
"status": "available",
|
|
"progress": 0,
|
|
"source_server": "5fb92d6c-b0cb-46c9-824b-b90ec5500ae6",
|
|
"target_server": "c6c0ff54-fa1f-43ef-9ccc-1774e40c8745",
|
|
"created_at": "2018-11-06 09:27:52.258",
|
|
"updated_at": "2018-11-06 09:44:59.853",
|
|
"priority_station": "target",
|
|
"attachment": [
|
|
{
|
|
"replication": "6568f7c4-0510-4f39-929d-8ffccbd4fd47",
|
|
"device": "/dev/vda"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"key": "aaaaaaa",
|
|
"value": "01234567889"
|
|
},
|
|
{
|
|
"key": "ffffff",
|
|
"value": "dddd"
|
|
}
|
|
],
|
|
"metadata": {}
|
|
}
|
|
}
|
|
</pre>
|
|
<p id="sdrs_05_0504__p198221450194213">Or</p>
|
|
<pre class="screen" id="sdrs_05_0504__screen982295064211">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
<p id="sdrs_05_0504__p1882210506425">In this example, <strong id="sdrs_05_0504__b18802832163412">error</strong> represents a general error, including <strong id="sdrs_05_0504__b68036325344">badrequest</strong> (shown below) and <strong id="sdrs_05_0504__b178051932183416">itemNotFound</strong>.</p>
|
|
<pre class="screen" id="sdrs_05_0504__screen1822195013426">{
|
|
"badrequest": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0504__en-us_topic_0079693002_section60507121"><h4 class="sectiontitle">Returned Values</h4><ul id="sdrs_05_0504__en-us_topic_0079693002_ul18743339"><li id="sdrs_05_0504__li37400248244">Normal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0504__sdrs_05_0101_table4315991194956" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0504__sdrs_05_0101_row2336641294956"><th align="left" class="cellrowborder" valign="top" width="42.59%" id="mcps1.3.6.2.1.1.1.3.1.1"><p id="sdrs_05_0504__sdrs_05_0101_p1363125894956">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.410000000000004%" id="mcps1.3.6.2.1.1.1.3.1.2"><p id="sdrs_05_0504__sdrs_05_0101_p3039012494956">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0504__sdrs_05_0101_row507566794956"><td class="cellrowborder" valign="top" width="42.59%" headers="mcps1.3.6.2.1.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p847584694956">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.410000000000004%" headers="mcps1.3.6.2.1.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p1545496394956">The server has accepted the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="sdrs_05_0504__li13951479">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0504__sdrs_05_0101_table22458872203835" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0504__sdrs_05_0101_row35704554203835"><th align="left" class="cellrowborder" valign="top" width="43.419999999999995%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="sdrs_05_0504__sdrs_05_0101_p6387753203835">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.58%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="sdrs_05_0504__sdrs_05_0101_p47646009203835">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0504__sdrs_05_0101_row34121538203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p12381163203835">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p63350108203835">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row33280063203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p11330608203835">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p45364094203835">You must enter a username and the password to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row5623667203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p52863895203835">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p54117066203835">You are forbidden to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row17291554203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p58438642203835">404 Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p35909542203835">The server could not find the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row54750425203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p5599455203835">405 Method Not Allowed</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p50902717203835">You are not allowed to use the method specified in the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row55471277203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p63988484203835">406 Not Acceptable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p15684678203835">The response generated by the server could not be accepted by the client.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row6944380203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p25623884203835">407 Proxy Authentication Required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p62268733203835">You must use the proxy server for authentication so that the request can be processed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row23547689203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p28314670203835">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p11786919203835">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row38973411203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p2729702203835">409 Conflict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p19779281203835">The request could not be processed due to a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row43795805203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p57799353203835">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p51235984203835">Failed to complete the request because of a service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row58470678203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p38504500203835">501 Not Implemented</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p31856770203835">Failed to complete the request because the server does not support the requested function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row18275474203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p3918444203835">502 Bad Gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p48958538203835">Failed to complete the request because the server receives an invalid response from an upstream server.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row37973662203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p55967806203835">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p37098455203835">Failed to complete the request because the system is unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0504__sdrs_05_0101_row65450640203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0504__sdrs_05_0101_p67010448203835">504 Gateway Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0504__sdrs_05_0101_p59137180203835">A gateway timeout error occurred.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="sdrs_05_0500.html">Protected Instance</a></div>
|
|
</div>
|
|
</div>
|
|
|