vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sdrs/api-ref/sdrs_05_0405.html
Wei, Hongmin ab56d080fb SDRS API initial version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-26 13:51:50 +00:00

472 lines
37 KiB
HTML
Raw Blame History

<a name="sdrs_05_0405"></a><a name="sdrs_05_0405"></a>
<h1 class="topictitle1">Changing the Name of a Protection Group</h1>
<div id="body1524795306609"><div class="section" id="sdrs_05_0405__en-us_topic_0079693002_section34649765"><h4 class="sectiontitle">Function</h4><p id="sdrs_05_0405__en-us_topic_0079693002_p9084369">This API is used to change the name of a protection group.</p>
</div>
<div class="section" id="sdrs_05_0405__section11875456142718"><h4 class="sectiontitle">Constraints and Limitations</h4><p id="sdrs_05_0405__p198931756122718">None</p>
</div>
<div class="section" id="sdrs_05_0405__en-us_topic_0079693002_section39390935"><h4 class="sectiontitle">URI</h4><ul id="sdrs_05_0405__ul12243124416378"><li id="sdrs_05_0405__li124394443718">URI format<p id="sdrs_05_0405__en-us_topic_0079693002_p212314194247"><a name="sdrs_05_0405__li124394443718"></a><a name="li124394443718"></a>PUT /v1/{project_id}/server-groups/{server_group_id}</p>
</li></ul>
<ul id="sdrs_05_0405__ul15632134915375"><li id="sdrs_05_0405__li11632649203713">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0405__table8630114993720" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0405__row6630749163718"><th align="left" class="cellrowborder" valign="top" width="21.782178217821784%" id="mcps1.3.3.3.1.1.1.5.1.1"><p id="sdrs_05_0405__p1963034919376">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.3.3.1.1.1.5.1.2"><p id="sdrs_05_0405__p26301649183717">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.3.1.1.1.5.1.3"><p id="sdrs_05_0405__p96303494377">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.504950495049506%" id="mcps1.3.3.3.1.1.1.5.1.4"><p id="sdrs_05_0405__p0630949113716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0405__row19630154953719"><td class="cellrowborder" valign="top" width="21.782178217821784%" headers="mcps1.3.3.3.1.1.1.5.1.1 "><p id="sdrs_05_0405__p8630174916372">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.3.1.1.1.5.1.2 "><p id="sdrs_05_0405__p11630134917371">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.3.1.1.1.5.1.3 "><p id="sdrs_05_0405__p563084963711">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.504950495049506%" headers="mcps1.3.3.3.1.1.1.5.1.4 "><p id="sdrs_05_0405__p176305490372">Specifies the project ID.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row2630649143712"><td class="cellrowborder" valign="top" width="21.782178217821784%" headers="mcps1.3.3.3.1.1.1.5.1.1 "><p id="sdrs_05_0405__p863024910375">server_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.3.1.1.1.5.1.2 "><p id="sdrs_05_0405__p6630124963715">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.3.1.1.1.5.1.3 "><p id="sdrs_05_0405__p563034953714">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.504950495049506%" headers="mcps1.3.3.3.1.1.1.5.1.4 "><p id="sdrs_05_0405__p6630849173711">Specifies the ID of a protection group.</p>
<p id="sdrs_05_0405__p8819185417466">For details, see <a href="sdrs_05_0402.html">Querying Protection Groups</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0405__en-us_topic_0079693002_section18974100"><h4 class="sectiontitle">Request</h4><ul id="sdrs_05_0405__en-us_topic_0079693002_ul53989823"><li id="sdrs_05_0405__li59621731103815">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0405__table99621031133818" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0405__row1696263111387"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="sdrs_05_0405__p29621431163815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="sdrs_05_0405__p189621310385">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="sdrs_05_0405__p596215312382">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="sdrs_05_0405__p69621313389">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0405__row39624311385"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="sdrs_05_0405__p18962631153813">server_group</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="sdrs_05_0405__p89621031123811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="sdrs_05_0405__p9962133112381">Object</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="sdrs_05_0405__p138072222014">Specifies the information about a protection group.</p>
<p id="sdrs_05_0405__p3962143193810">For details, see <a href="#sdrs_05_0405__table920673314542">Table 1</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0405__table920673314542"></a><a name="table920673314542"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0405__table920673314542" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="sdrs_05_0405__b166011022142114">server_group</strong> field description</caption><thead align="left"><tr id="sdrs_05_0405__row1320623313547"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="sdrs_05_0405__p162061733155416"><strong id="sdrs_05_0405__b672732542120">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="sdrs_05_0405__p1820613311541">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.91%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="sdrs_05_0405__p17206143375412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.089999999999996%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="sdrs_05_0405__p14207193345412"><strong id="sdrs_05_0405__b692810203213">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0405__row122071033105418"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0405__p1120719339543">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="sdrs_05_0405__p7207103355415">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.91%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0405__p112071633145415">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.089999999999996%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0405__p889918475203">Specifies the name of a protection group.</p>
<ul id="sdrs_05_0405__ul14976121672314"><li id="sdrs_05_0405__li19976416122318">The name can contain a maximum of 64 bytes.</li><li id="sdrs_05_0405__li4976151612237">The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sdrs_05_0405__en-us_topic_0079693002_li16146366">Example request<div class="p" id="sdrs_05_0405__p0990135145216"><a name="sdrs_05_0405__en-us_topic_0079693002_li16146366"></a><a name="en-us_topic_0079693002_li16146366"></a>PUT https://{endpoint}/v1/{project_id}/server-groups/ e98cefcd-2398-4a4d-8c52-c79f00e21484<pre class="screen" id="sdrs_05_0405__screen01223485523">{
"server_group": {
"name": "my_test_server_group"
}
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0405__section11170547164"><h4 class="sectiontitle">Response</h4><ul id="sdrs_05_0405__ul9183151841716"><li id="sdrs_05_0405__li1518319181176">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0405__table0406165111820" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="sdrs_05_0405__row440719519187"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="sdrs_05_0405__p125481835111815"><strong id="sdrs_05_0405__b842352706151210">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="sdrs_05_0405__p19555143581814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="sdrs_05_0405__p756043501813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0405__row164074518182"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="sdrs_05_0405__p956473581815">server_group</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="sdrs_05_0405__p17570153513187">Object</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="sdrs_05_0405__p8573183511815">Specifies the details of a protection group.</p>
<p id="sdrs_05_0405__p640013352346">For details, see <a href="#sdrs_05_0405__table1757415616184">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0405__table1757415616184"></a><a name="table1757415616184"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0405__table1757415616184" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="sdrs_05_0405__b1483713277582">server_group</strong> field description</caption><thead align="left"><tr id="sdrs_05_0405__row5583195631810"><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_0405__p20585145611180"><strong id="sdrs_05_0405__b842352706162023">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.3%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="sdrs_05_0405__p1659095671813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.63%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="sdrs_05_0405__p45949566185"><strong id="sdrs_05_0405__b84235270615457">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0405__row115979563182"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p115981056131819">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p56047567189">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p136061156191810">Specifies the ID of a protection group.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row16608105610188"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1461045613183">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p1361511566187">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p146182564189">Specifies the name of a protection group. The name can contain a maximum of 64 bytes. The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="sdrs_05_0405__row186211756181818"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p56241456121818">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p1163155661810">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p863295615183">Specifies the description of a protection group.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row063410569183"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p963813562188">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p36431156151811">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p11647456181810">Specifies the status of a protection group.</p>
<p id="sdrs_05_0405__p1451122214538">For details, see <a href="en-us_topic_0126152930.html">Protection Group Status</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row0648115619182"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1565275691819">progress</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p17657135671811">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p1866185616181">Specifies the synchronization progress of a protection group.</p>
<p id="sdrs_05_0405__p166205616188">Unit: %</p>
</td>
</tr>
<tr id="sdrs_05_0405__row16621056181812"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p766635617183">source_availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p1867345691819">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p1924824245820">Specifies the production site AZ configured when a protection group is created.</p>
<p id="sdrs_05_0405__p17155343195615">The value does not change after a planned failover or failover.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row176761556131814"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1468065641818">target_availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p46871656101819">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p17420515169">Specifies the DR site AZ configured when a protection group is created.</p>
<p id="sdrs_05_0405__p57426515169">The value does not change after a planned failover or failover.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row1469112565186"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1969305651810">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p1470175641818">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p9703145618188">Specifies the ID of an active-active domain.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row1570635612181"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p14707156151818">domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p8714756141817">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p67181656191815">Specifies the name of an active-active domain.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row17556104203519"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1178319563187">protected_status</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p77901456111817">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p1879445681812">Specifies whether protection is enabled or not.</p>
<ul id="sdrs_05_0405__ul14795125619185"><li id="sdrs_05_0405__li157978567181"><strong id="sdrs_05_0405__b1415212501284">started</strong>: Protection is enabled.</li><li id="sdrs_05_0405__li2080212564189"><strong id="sdrs_05_0405__b136645542817">stopped</strong>: Protection is disabled.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0405__row577216515367"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p481005619182">replication_status</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p8816175661815">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p1881710568184">Specifies the data synchronization status.</p>
<ul id="sdrs_05_0405__ul8820125601814"><li id="sdrs_05_0405__li682120563186"><strong id="sdrs_05_0405__b45671721496">active</strong>: Data has been synchronized.</li><li id="sdrs_05_0405__li282445613186"><strong id="sdrs_05_0405__b1479811519913">inactive</strong>: Data is not synchronized.</li><li id="sdrs_05_0405__li12827205631815"><strong>copying</strong>: Data is being synchronized.</li><li id="sdrs_05_0405__li58301756181811"><strong id="sdrs_05_0405__b873942274910">active-stopped</strong>: Data synchronization is stopped.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0405__row1927895683616"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1783517561182">health_status</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p784175618187">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p148467566188">Specifies the health status of a protection group.</p>
<ul id="sdrs_05_0405__ul128473565188"><li id="sdrs_05_0405__li12848165615182"><strong id="sdrs_05_0405__b573101420919">normal</strong>: The protection group is normal.</li><li id="sdrs_05_0405__li19851165612182"><strong id="sdrs_05_0405__b556914181493">abnormal</strong>: The protection group is abnormal.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0405__row1271845616186"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p8723125621819">priority_station</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p15728155616189">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p127311956101816">Specifies the current production site of a protection group.</p>
<ul id="sdrs_05_0405__ul473195641813"><li id="sdrs_05_0405__li127331256171814"><strong id="sdrs_05_0405__b1684915276476">source</strong>: indicates that the current production site AZ is the <strong id="sdrs_05_0405__b1085012276479">source_availability_zone</strong> value.</li><li id="sdrs_05_0405__li16738856201818"><strong id="sdrs_05_0405__b227194564711">target</strong>: indicates that the current production site AZ is the <strong id="sdrs_05_0405__b328114512471">target_availability_zone</strong> value.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0405__row1074145651817"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1674545651819">protected_instance_num</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p1475115616184">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p1575417567185">Specifies the number of protected instances in a protection group.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row1275516561186"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p107589561186">replication_num</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p17636564184">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p6766456181810">Specifies the number of replication pairs in a protection group.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row8769115641812"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p677110568188">disaster_recovery_drill_num</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p14775185612185">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p11779185616187">Specifies the number of DR drills in a protection group.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row38536562186"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1785705612189">source_vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p9863155681814">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p88658561184">Specifies the ID of the VPC for the production site.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row9866956191813"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1087015691816">target_vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p19876175613181">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p1588010563181">Specifies the ID of the VPC for the DR site.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row1788175661816"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p98851656181818">test_vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p88918566189">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p138941156161818">Specifies the ID of the VPC used for a DR drill.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row1389555641815"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p188981956111819">dr_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p1390615561185">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p9910125610189">Specifies the deployment model. The default value is <strong id="sdrs_05_0405__b1963647298">migration</strong>, indicating migration within a VPC.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row5887172517384"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1776947114816">server_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p1476977114815">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p3878141012513">Specifies the type of managed servers.</p>
<ul id="sdrs_05_0405__ul0353139544"><li id="sdrs_05_0405__li133531091748"><strong id="sdrs_05_0405__b07020519317">ECS</strong>: indicates that ECSs are managed.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0405__row5919155610184"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p29231256121812">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p1792712563181">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p199305564189">Specifies the time when a protection group was created.</p>
<p id="sdrs_05_0405__p924015916177">The default format is as follows: "yyyy-MM-dd HH:mm:ss.S", for example, <strong id="sdrs_05_0405__b4811921151219">2019-04-01 12:00:00.0</strong>.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row593295641816"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1593614562188">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p18941756111814">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p1994413563184">Specifies the time when a protection group was updated.</p>
<p id="sdrs_05_0405__p0724191312174">The default format is as follows: "yyyy-MM-dd HH:mm:ss.S", for example, <strong id="sdrs_05_0405__b110393251215">2019-04-01 12:00:00.0</strong>.</p>
</td>
</tr>
<tr id="sdrs_05_0405__row1282310771117"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p1416763219184">protection_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p101678327184">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p137228404418">Specifies the protection mode.</p>
<ul id="sdrs_05_0405__ul1022812151351"><li id="sdrs_05_0405__li202318153510"><strong id="sdrs_05_0405__b1164910134166">null</strong>: indicates that data synchronization is performed at the replication consistency group level. No partial synchronization failure will occur.</li><li id="sdrs_05_0405__li1323461513519"><strong id="sdrs_05_0405__b159451252231">replication-pair</strong>: indicates that data synchronization is performed at the replication pair level.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0405__row28241716119"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0405__p261318522911">replication_model</p>
</td>
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0405__p96152525910">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.63%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0405__p96158524910">Specifies the protection mode.</p>
<div class="note" id="sdrs_05_0405__note86150521919"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="sdrs_05_0405__p161511521693">This parameter is reserved.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="sdrs_05_0405__en-us_topic_0079693002_ul48735027"><li id="sdrs_05_0405__en-us_topic_0079693002_li66450672">Example response<pre class="screen" id="sdrs_05_0405__screen384841528">{
"server_group": {
"id": "e98cefcd-2398-4a4d-8c52-c79f00e21484",
"name": "my_test_server_group",
"description": "test_server_group_sdrs",
"status": "available",
"progress": 0,
"source_availability_zone": "eu-de-01",
"target_availability_zone": "eu-de-02",
"domain_id": "523ab8ad-3759-4933-9436-4cf4ebb20867",
"domain_name": "my domain",
"protected_status": "stopped",
"replication_status": "active-stopped",
"health_status": "normal",
"priority_station": "source",
"protected_instance_num": 0,
"replication_num": 0,
"disaster_recovery_drill_num": 0,
"source_vpc_id": "ac784bd6-a79c-4def-9ff8-dc87940d5335",
"target_vpc_id": "ac784bd6-a79c-4def-9ff8-dc87940d5335",
"test_vpc_id": null,
"dr_type": "migration",
"server_type":"ECS",
"created_at": "2018-05-09 22:11:45.0",
"updated_at": "2018-05-09 22:11:54.0",
"protection_type": "replication-pair",
"replication_model": null
}
}</pre>
<p id="sdrs_05_0405__p44242213586">Or</p>
<pre class="screen" id="sdrs_05_0405__screen142153915582">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="sdrs_05_0405__p8424162205810">In this example, <strong id="sdrs_05_0405__b19806132614349">error</strong> represents a general error, including <strong id="sdrs_05_0405__b2806122613344">badrequest</strong> (shown below) and <strong id="sdrs_05_0405__b68071226193411">itemNotFound</strong>.</p>
<pre class="screen" id="sdrs_05_0405__screen1032115150583">{
"badrequest": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
<div class="section" id="sdrs_05_0405__en-us_topic_0079693002_section60507121"><h4 class="sectiontitle">Returned Values</h4><ul id="sdrs_05_0405__en-us_topic_0079693002_ul18743339"><li id="sdrs_05_0405__li37400248244">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0405__sdrs_05_0101_table4315991194956" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0405__sdrs_05_0101_row2336641294956"><th align="left" class="cellrowborder" valign="top" width="42.59%" id="mcps1.3.7.2.1.1.1.3.1.1"><p id="sdrs_05_0405__sdrs_05_0101_p1363125894956">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.410000000000004%" id="mcps1.3.7.2.1.1.1.3.1.2"><p id="sdrs_05_0405__sdrs_05_0101_p3039012494956">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0405__sdrs_05_0101_row507566794956"><td class="cellrowborder" valign="top" width="42.59%" headers="mcps1.3.7.2.1.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p847584694956">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.410000000000004%" headers="mcps1.3.7.2.1.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p1545496394956">The server has accepted the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sdrs_05_0405__li13951479">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0405__sdrs_05_0101_table22458872203835" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0405__sdrs_05_0101_row35704554203835"><th align="left" class="cellrowborder" valign="top" width="43.419999999999995%" id="mcps1.3.7.2.2.1.1.3.1.1"><p id="sdrs_05_0405__sdrs_05_0101_p6387753203835">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.58%" id="mcps1.3.7.2.2.1.1.3.1.2"><p id="sdrs_05_0405__sdrs_05_0101_p47646009203835">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0405__sdrs_05_0101_row34121538203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p12381163203835">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p63350108203835">The server failed to process the request.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row33280063203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p11330608203835">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p45364094203835">You must enter a username and the password to access the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row5623667203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p52863895203835">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p54117066203835">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row17291554203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p58438642203835">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p35909542203835">The server could not find the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row54750425203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p5599455203835">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p50902717203835">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row55471277203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p63988484203835">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p15684678203835">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row6944380203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p25623884203835">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__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_0405__sdrs_05_0101_row23547689203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p28314670203835">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p11786919203835">The request timed out.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row38973411203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p2729702203835">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p19779281203835">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row43795805203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p57799353203835">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p51235984203835">Failed to complete the request because of a service error.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row58470678203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p38504500203835">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__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_0405__sdrs_05_0101_row18275474203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p3918444203835">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__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_0405__sdrs_05_0101_row37973662203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p55967806203835">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__sdrs_05_0101_p37098455203835">Failed to complete the request because the system is unavailable.</p>
</td>
</tr>
<tr id="sdrs_05_0405__sdrs_05_0101_row65450640203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0405__sdrs_05_0101_p67010448203835">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0405__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_0400.html">Protection Group</a></div>
</div>
</div>
View Git Blame Copy Permalink