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>
462 lines
35 KiB
HTML
462 lines
35 KiB
HTML
<a name="sdrs_05_0505"></a><a name="sdrs_05_0505"></a>
|
|
|
|
<h1 class="topictitle1">Changing the Name of a Protected Instance</h1>
|
|
<div id="body1526287242061"><div class="section" id="sdrs_05_0505__section136351762416"><h4 class="sectiontitle">Function</h4><p id="sdrs_05_0505__p1997876164113">This API is used to change the name of a protected instance.</p>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0505__section1981616408367"><h4 class="sectiontitle">Constraints and Limitations</h4><p id="sdrs_05_0505__p1666664210363">None</p>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0505__section063716154119"><h4 class="sectiontitle">URI</h4><ul id="sdrs_05_0505__ul189784614411"><li id="sdrs_05_0505__li1978186164114">URI format<p id="sdrs_05_0505__p1297814614116"><a name="sdrs_05_0505__li1978186164114"></a><a name="li1978186164114"></a>PUT /v1/{project_id}/protected-instances/{protected_instance_id}</p>
|
|
</li><li id="sdrs_05_0505__li14978166134113">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__table6643196154115" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0505__row1597836144112"><th align="left" class="cellrowborder" valign="top" width="21.65%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="sdrs_05_0505__p697818644112">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.430000000000001%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="sdrs_05_0505__p797815694112">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.4%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="sdrs_05_0505__p8978165418">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.519999999999996%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="sdrs_05_0505__p89781667413">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__row397818620412"><td class="cellrowborder" valign="top" width="21.65%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="sdrs_05_0505__p2097819614412">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="sdrs_05_0505__p1697820613414">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.4%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="sdrs_05_0505__p29785614117">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="sdrs_05_0505__p397813654113">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row109781263417"><td class="cellrowborder" valign="top" width="21.65%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="sdrs_05_0505__p297817618419">protected_instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="sdrs_05_0505__p1797820616417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.4%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="sdrs_05_0505__p13978166184111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.519999999999996%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="sdrs_05_0505__p119787694116">Specifies the ID of a protected instance.</p>
|
|
<p id="sdrs_05_0505__p04812811294">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_0505__section1765717610416"><h4 class="sectiontitle">Request</h4><ul id="sdrs_05_0505__ul149781967419"><li id="sdrs_05_0505__li99781465411">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__table36621563418" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0505__row99786615414"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="sdrs_05_0505__p797876124115">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_0505__p14978266416">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_0505__p1797819614117">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_0505__p1197826144119">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__row1798010624116"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="sdrs_05_0505__p798006114113">protected_instance</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_0505__p098017615410">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_0505__p3980166184115">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_0505__p189809611416">Specifies the information about a protected instance.</p>
|
|
<p id="sdrs_05_0505__p292815511559">For details, see <a href="#sdrs_05_0505__table920673314542">Table 1</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="sdrs_05_0505__table920673314542"></a><a name="table920673314542"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__table920673314542" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="sdrs_05_0505__b5941203593213">protected_instance</strong> field description</caption><thead align="left"><tr id="sdrs_05_0505__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_0505__p162061733155416"><strong id="sdrs_05_0505__b18805393321">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_0505__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_0505__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_0505__p14207193345412"><strong id="sdrs_05_0505__b18140134103215">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__row122071033105418"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0505__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_0505__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_0505__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_0505__p17207193315415">Specifies the name of a protected instance. 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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="sdrs_05_0505__ul129801862417"><li id="sdrs_05_0505__li189801164412">Example request<div class="p" id="sdrs_05_0505__p1661711618337"><a name="sdrs_05_0505__li189801164412"></a><a name="li189801164412"></a>PUT https://{Endpoint}/v1/{project_id}/protected-instances/00000000632302f501632305f63c000e<pre class="screen" id="sdrs_05_0505__screen36319363320">{
|
|
"protected_instance": {
|
|
"name": "test_protected_instance_name"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0505__section6674106144116"><h4 class="sectiontitle">Response</h4><ul id="sdrs_05_0505__ul119809694118"><li id="sdrs_05_0505__li198086164113">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__table196814619413" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0505__row59801618417"><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_0505__p1298017624114">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_0505__p498014624119">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_0505__p198076154119">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__row298018617416"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="sdrs_05_0505__p1998010614118">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_0505__p119800616417">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_0505__p1198019611416">Specifies the details about a protected instance.</p>
|
|
<p id="sdrs_05_0505__p1966085311438">For details, see <a href="#sdrs_05_0505__table568913617418">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="sdrs_05_0505__table568913617418"></a><a name="table568913617418"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__table568913617418" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="sdrs_05_0505__b11455135514325">protected_instance</strong> field description</caption><thead align="left"><tr id="sdrs_05_0505__row098116184110"><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_0505__p3981864413">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="sdrs_05_0505__p6981126184117">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.49%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="sdrs_05_0505__p698120618412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__row129811610416"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p49811669412">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p398126164114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p998110618412">Specifies the ID of a protected instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row49811761410"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p1598110634119">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p1898126194119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p1398146124116">Specifies the name of a protected instance. The name can contain a maximum of 64 bytes consisting of 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_0505__row79814604116"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p09811867416">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p1298106134118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p111181444212">Specifies the description of a protected instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row949569266"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p1982169411">server_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p189824694115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p1498212619418">Specifies the ID of a protection group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row109812618417"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p129812614415">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p69813615417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p1798166144110">Specifies the status of a protected instance. For details, see <a href="en-us_topic_0126152931.html">Protected Instance Status</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row13362142710269"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p14745142282317">progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p931104919418">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p1330727191818">Specifies the synchronization progress of a protected instance.</p>
|
|
<p id="sdrs_05_0505__p12307127121818">Unit: %</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row1398113684118"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p89811961413">source_server</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p149811761411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p898115618413">Specifies the production site server ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row398114654117"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p2981156174110">target_server</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p798217674114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p29820613412">Specifies the DR site server ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row1698236124120"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p798220619412">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p179821064418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p99821062416">Specifies the time when a protected instance was created.</p>
|
|
<p id="sdrs_05_0505__p161887311319">The default format is as follows: "yyyy-MM-dd HH:mm:ss.S", for example, <strong id="sdrs_05_0505__b112579431311">2019-04-01 12:00:00.0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row998211694110"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p99821165411">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p149820694118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p698236134110">Specifies the time when a protected instance was updated.</p>
|
|
<p id="sdrs_05_0505__p0670511678">The default format is as follows: "yyyy-MM-dd HH:mm:ss.S", for example, <strong id="sdrs_05_0505__b1619159141317">2019-04-01 12:00:00.0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row1448212132711"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p10235944142418">priority_station</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p10235154410245">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p382553192519">Specifies the current production site AZ of the protection group containing the protected instance.</p>
|
|
<ul id="sdrs_05_0505__ul782135312518"><li id="sdrs_05_0505__li18900933195819"><strong id="sdrs_05_0505__b4933185132512">source</strong>: indicates that the current production site AZ is the <strong id="sdrs_05_0505__b49341151122516">source_availability_zone</strong> value.</li><li id="sdrs_05_0505__li1387855513251"><strong id="sdrs_05_0505__b10418185762510">target</strong>: indicates that the current production site AZ is the <strong id="sdrs_05_0505__b3419155717254">target_availability_zone</strong> value.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row208821610535"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p1374517342565">attachment</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p474543475616">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p1674513345564">Specifies the attached replication pairs.</p>
|
|
<p id="sdrs_05_0505__p248022019511">For details, see <a href="#sdrs_05_0505__table179273775819">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row11988241937"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p198281231145613">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p20771154912569">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p15241635617">Specifies the tag list.</p>
|
|
<p id="sdrs_05_0505__p94647391453">For details, see <a href="#sdrs_05_0505__table537215313717">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row6217281633"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="sdrs_05_0505__p6472615185719">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="sdrs_05_0505__p457217441413">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="sdrs_05_0505__p370974645720">Specifies the metadata of a protected instance.</p>
|
|
<p id="sdrs_05_0505__p370155313511">For details, see <a href="#sdrs_05_0505__table18286124016331">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="sdrs_05_0505__table179273775819"></a><a name="table179273775819"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__table179273775819" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="sdrs_05_0505__b18748022154711">attachment</strong> field description</caption><thead align="left"><tr id="sdrs_05_0505__row1492813755816"><th align="left" class="cellrowborder" valign="top" width="28.9028902890289%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="sdrs_05_0505__p292811711582"><strong id="sdrs_05_0505__b1555672414474">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.331733173317332%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="sdrs_05_0505__p11928107165814"><strong id="sdrs_05_0505__b122552614478">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.765376537653765%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="sdrs_05_0505__p129289712588"><strong id="sdrs_05_0505__b15145327144714">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__row792810795814"><td class="cellrowborder" valign="top" width="28.9028902890289%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="sdrs_05_0505__p392816745818">replication</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.331733173317332%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="sdrs_05_0505__p69286711582">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.765376537653765%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="sdrs_05_0505__p14719113310">Specifies the ID of a replication pair.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row69284725813"><td class="cellrowborder" valign="top" width="28.9028902890289%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="sdrs_05_0505__p139281074588">device</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.331733173317332%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="sdrs_05_0505__p1192813705820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.765376537653765%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="sdrs_05_0505__p99281876589">Specifies the device name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="sdrs_05_0505__table537215313717"></a><a name="table537215313717"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__table537215313717" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="sdrs_05_0505__b117411131184712">tags</strong> field description</caption><thead align="left"><tr id="sdrs_05_0505__row133739314717"><th align="left" class="cellrowborder" valign="top" width="29.13291329132913%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="sdrs_05_0505__p23731337718"><strong id="sdrs_05_0505__b204511732124716">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.071707170717072%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="sdrs_05_0505__p53739312717"><strong id="sdrs_05_0505__b3740833124710">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.7953795379538%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="sdrs_05_0505__p193731731972"><strong id="sdrs_05_0505__b44281134194719">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__row12373831710"><td class="cellrowborder" valign="top" width="29.13291329132913%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="sdrs_05_0505__p1337323171">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.071707170717072%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="sdrs_05_0505__p5373831670">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.7953795379538%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="sdrs_05_0505__p1688242248">Specifies the tag key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__row163731831173"><td class="cellrowborder" valign="top" width="29.13291329132913%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="sdrs_05_0505__p1237315315710">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.071707170717072%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="sdrs_05_0505__p163731338716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.7953795379538%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="sdrs_05_0505__p1237320316714">Specifies the tag value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="sdrs_05_0505__table18286124016331"></a><a name="table18286124016331"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__table18286124016331" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="sdrs_05_0505__b14141337154718">metadata</strong> field description</caption><thead align="left"><tr id="sdrs_05_0505__row1228734016335"><th align="left" class="cellrowborder" valign="top" width="29.14291429142914%" id="mcps1.3.5.2.1.5.2.4.1.1"><p id="sdrs_05_0505__p18958174419296"><strong id="sdrs_05_0505__b1412618117485">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.511751175117514%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="sdrs_05_0505__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_0505__p395816448297"><strong id="sdrs_05_0505__b14359821487">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__row132895406331"><td class="cellrowborder" valign="top" width="29.14291429142914%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="sdrs_05_0505__p1558353082720">__system__frozen</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.511751175117514%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="sdrs_05_0505__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_0505__p958313303271">Specifies whether the resource is frozen.</p>
|
|
<ul id="sdrs_05_0505__ul529114370311"><li id="sdrs_05_0505__li152921437183118"><strong id="sdrs_05_0505__b386119204484">true</strong>: indicates that the resource is frozen.</li><li id="sdrs_05_0505__li1108121319326">Empty: indicates that the resource is not frozen.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="sdrs_05_0505__ul698286134113"><li id="sdrs_05_0505__li12982769412">Example response<pre class="screen" id="sdrs_05_0505__screen148701830154217">{
|
|
"protected_instance": {
|
|
"id": "00000000632302f501632305f63c000e",
|
|
"name": "test_protected_instance_name",
|
|
"description": "_sdrs_protected_instance",
|
|
"server_group_id": "00000000632302f501632305ac75000a",
|
|
"status": "available",
|
|
"progress": 0,
|
|
"source_server": "5597a320-7a36-4462-9f85-a0d01edfb416",
|
|
"target_server": "e37ed7de-bd76-4189-8445-be747205322d",
|
|
"created_at": "2018-05-02 22:43:03.0",
|
|
"updated_at": "2018-05-02 22:47:27.0",
|
|
"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_0505__p33171657161416">Or</p>
|
|
<pre class="screen" id="sdrs_05_0505__screen138651935157">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
<p id="sdrs_05_0505__p14317125711143">In this example, <strong id="sdrs_05_0505__b142091643183715">error</strong> represents a general error, including <strong id="sdrs_05_0505__b20210194319373">badrequest</strong> (shown below) and <strong id="sdrs_05_0505__b52101343173715">itemNotFound</strong>.</p>
|
|
<pre class="screen" id="sdrs_05_0505__screen8942888156">{
|
|
"badrequest": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sdrs_05_0505__section19734136174120"><h4 class="sectiontitle">Returned Values</h4><ul id="sdrs_05_0505__en-us_topic_0079693002_ul18743339"><li id="sdrs_05_0505__li37400248244">Normal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__sdrs_05_0101_table4315991194956" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p3039012494956">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p1545496394956">The server has accepted the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="sdrs_05_0505__li13951479">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0505__sdrs_05_0101_table22458872203835" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p47646009203835">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p63350108203835">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p45364094203835">You must enter a username and the password to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p54117066203835">You are forbidden to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p35909542203835">The server could not find the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p50902717203835">You are not allowed to use the method specified in the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p15684678203835">The response generated by the server could not be accepted by the client.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__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_0505__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_0505__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_0505__sdrs_05_0101_p11786919203835">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p19779281203835">The request could not be processed due to a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__sdrs_05_0101_p51235984203835">Failed to complete the request because of a service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__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_0505__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_0505__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_0505__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_0505__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_0505__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_0505__sdrs_05_0101_p37098455203835">Failed to complete the request because the system is unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sdrs_05_0505__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_0505__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_0505__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>
|
|
|