liangxiaobi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sdrs/api-ref/sdrs_05_0501.html
zhangyue 55da809bbb SDRS API Doc 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-02-10 10:40:03 +00:00

356 lines
31 KiB
HTML
Raw Blame History

<a name="sdrs_05_0501"></a><a name="sdrs_05_0501"></a>
<h1 class="topictitle1">Creating a Protected Instance</h1>
<div id="body1524795306610"><div class="section" id="sdrs_05_0501__en-us_topic_0079693002_section34649765"><h4 class="sectiontitle">Function</h4><p id="sdrs_05_0501__en-us_topic_0079693002_p9084369">This API is used to create a protected instance. When a protected instance is created, the default name of the server at the DR site is the same as that of the server at the production site, but their IDs are different. To modify a server name, click the server name on the protected instance details page to switch to the server details page and modify the server name. Alternatively, you can call the API in <a href="sdrs_05_0505.html">Changing the Name of a Protected Instance</a> to modify the name.</p>
</div>
<div class="section" id="sdrs_05_0501__section15345162453414"><h4 class="sectiontitle">Constraints and Limitations</h4><ul id="sdrs_05_0501__ul26007272341"><li id="sdrs_05_0501__li1492711091912"><strong id="sdrs_05_0501__b1149752216598">status</strong> of the protection group must be <strong id="sdrs_05_0501__b3498322135913">available</strong> or <strong id="sdrs_05_0501__b1849942245912">protected</strong>.</li><li id="sdrs_05_0501__li121131017154317">No shared disk has been attached to the server. </li><li id="sdrs_05_0501__li1985112208578">One server can be used to create only one protected instance.</li><li id="sdrs_05_0501__li2631354131116">The server must be in the same VPC as the protection group.</li><li id="sdrs_05_0501__li08501011165420">The physical host housing the production site server cannot be a DeH.</li><li id="sdrs_05_0501__li1976219583318">If protection is enabled for servers created during capacity expansion of an Auto Scaling (AS) group, these servers cannot be deleted when the capacity of the AS group is reduced.</li><li id="sdrs_05_0501__li773714117292">If the server at the production site runs Windows and you choose the key login mode, ensure that the key pair of the server exists when you create a protected instance. Otherwise, the server at the DR site may fail to create, causing the protected instance creation failure.<div class="note" id="sdrs_05_0501__note1499218295429"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sdrs_05_0501__p19992129184210">If the key pair of the production site server has been deleted, create a key pair with the same name.</p>
</div></div>
</li><li id="sdrs_05_0501__li134831826131818">After you create a protected instance and enable protection on servers at the production site, modifications to the <strong id="sdrs_05_0501__sdrs_05_0406_b18397184118478">Hostname</strong>, <strong id="sdrs_05_0501__sdrs_05_0406_b9252144544710">Name</strong>, <strong id="sdrs_05_0501__sdrs_05_0406_b5574416161513">Security Group</strong>, <strong id="sdrs_05_0501__sdrs_05_0406_b1830541412399">Agency</strong>, <strong id="sdrs_05_0501__sdrs_05_0406_b472281803914">ECS Group</strong>, <strong id="sdrs_05_0501__sdrs_05_0406_b14154191951516">Tags</strong>, and <strong id="sdrs_05_0501__sdrs_05_0406_b1744317211159">Auto Recovery</strong> configurations of servers on the production site will not synchronize to the servers at the DR site. You can manually add the configuration items to the servers at the DR site on the management console.</li></ul>
</div>
<div class="section" id="sdrs_05_0501__en-us_topic_0079693002_section39390935"><h4 class="sectiontitle">URI</h4><ul id="sdrs_05_0501__en-us_topic_0079693002_ul52084342"><li id="sdrs_05_0501__en-us_topic_0079693002_li66105898">URI format<p id="sdrs_05_0501__en-us_topic_0079693002_p212314194247"><a name="sdrs_05_0501__en-us_topic_0079693002_li66105898"></a><a name="en-us_topic_0079693002_li66105898"></a>POST /v1/{project_id}/protected-instances</p>
</li><li id="sdrs_05_0501__en-us_topic_0079693002_li52977523">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0501__en-us_topic_0079693002_table63321005" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0501__en-us_topic_0079693002_row37593218"><th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="sdrs_05_0501__p156610131613">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_0501__p4668012162">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.81188118811881%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="sdrs_05_0501__p12661012161">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_0501__p16620191615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0501__en-us_topic_0079693002_row29123463"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="sdrs_05_0501__p19663013163">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_0501__p46611011166">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="sdrs_05_0501__p15672071610">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_0501__p76710011166">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0501__en-us_topic_0079693002_section18974100"><h4 class="sectiontitle">Request</h4><ul id="sdrs_05_0501__en-us_topic_0079693002_ul13105749"><li id="sdrs_05_0501__en-us_topic_0079693002_li50842877">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0501__en-us_topic_0079693002_table54932709" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0501__en-us_topic_0079693002_row41882373"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="sdrs_05_0501__p1192132112168">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_0501__p129232191617">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_0501__p12921521131614">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_0501__p49242101620">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0501__en-us_topic_0079693002_row27990155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="sdrs_05_0501__p1492121181613">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_0501__p109232171617">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_0501__p492821111618">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_0501__p1292102118162">Specifies the information about a protected instance.</p>
<p id="sdrs_05_0501__p7520116143819">For details, see <a href="#sdrs_05_0501__table1632215113348">Table 1</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0501__table1632215113348"></a><a name="table1632215113348"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0501__table1632215113348" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="sdrs_05_0501__b982833210368">protected_instance</strong> field description</caption><thead align="left"><tr id="sdrs_05_0501__row63289116346"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="sdrs_05_0501__p13330111193413"><strong id="sdrs_05_0501__b842352706151210">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_0501__p33321118343">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="sdrs_05_0501__p12333161173420">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="sdrs_05_0501__p1033516115345"><strong id="sdrs_05_0501__b84235270615457">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0501__row1234501173411"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0501__p11346141203410">server_group_id</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_0501__p834712113341">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0501__p19348101163410">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0501__p234913153415">Specifies the ID of the protection group where a protected instance is added.</p>
<p id="sdrs_05_0501__p13736203513581">For details, see <a href="sdrs_05_0402.html">Querying Protection Groups</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0501__row235010113341"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0501__p1035181183412">server_id</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_0501__p73521815349">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0501__p935411113346">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0501__p13559113412">Specifies the ID of the production site server.</p>
<div class="note" id="sdrs_05_0501__note78991219226"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="sdrs_05_0501__p862281812212">When the API is successfully invoked, the DR site server will be automatically created.</p>
</div></div>
</td>
</tr>
<tr id="sdrs_05_0501__row835613113341"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0501__p153585112349">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_0501__p735916133419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0501__p193611811345">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0501__p136417153412">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>
<tr id="sdrs_05_0501__row11364815343"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0501__p1636591143417">description</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_0501__p536717143419">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0501__p136891163411">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0501__p03692163416">Specifies the description of a protected instance. The description can contain a maximum of 64 bytes. The value cannot contain the left angle bracket (&lt;) or right angle bracket (&gt;).</p>
</td>
</tr>
<tr id="sdrs_05_0501__row1237721103415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0501__p63800123416">primary_subnet_id</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_0501__p53811214347">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0501__p2381151143415">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0501__p550919197411">Specifies the network ID of the subnet for the primary NIC on the DR site server. The value is the same as that of <strong id="sdrs_05_0501__b114542831019">neutron_network_id</strong> obtained using the VPC API.</p>
<p id="sdrs_05_0501__p182814201018">For details about how to query the subnets, see <a href="https://docs.otc.t-systems.com/en-us/api/vpc/vpc_subnet01_0003.html" target="_blank" rel="noopener noreferrer">Querying Subnets</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0501__row103848183415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0501__p1238791143415">primary_ip_address</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_0501__p1038710173418">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0501__p123871412348">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0501__p8444753191215">Specifies the IP address of the primary NIC on the DR site server.</p>
<p id="sdrs_05_0501__p73901117342">This parameter is valid only when <strong id="sdrs_05_0501__b157849402302">primary_subnet_id</strong> is specified.</p>
<p id="sdrs_05_0501__p1374413142388">If this parameter is not specified when <strong id="sdrs_05_0501__b153603593307">primary_subnet_id</strong> is specified, the system automatically assigns an IP address to the primary NIC on the DR site server</p>
</td>
</tr>
<tr id="sdrs_05_0501__row15411161381118"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0501__p1313715294258">flavorRef</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_0501__p1741214132116">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0501__p94126134118">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0501__p20413113161111">Specifies the flavor ID of the DR site server</p>
<div class="note" id="sdrs_05_0501__note34243124143"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="sdrs_05_0501__ul1367484801310"><li id="sdrs_05_0501__li1467454815139">If this parameter is not specified, the flavor ID of the DR site server is the same as that of the production site server by default.</li><li id="sdrs_05_0501__li1170216710143">Servers of different specifications have different performance, which may affect applications running on the servers. To ensure the server performance after a planned failover or failover, you are recommended to use servers of specifications (CPU and memory) same or higher than the specifications of the production site servers at the DR site.</li></ul>
</div></div>
</td>
</tr>
<tr id="sdrs_05_0501__row19388442112518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="sdrs_05_0501__p18710130115316">tags</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_0501__p771053014533">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="sdrs_05_0501__p87106309536">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="sdrs_05_0501__p15710173016533">Specifies the tag list.</p>
<p id="sdrs_05_0501__p142521954143915">For details, see <a href="#sdrs_05_0501__table114968589379">Table 2</a>.</p>
<div class="note" id="sdrs_05_0501__note01635555114"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="sdrs_05_0501__p216455510111">You can add up to 10 tags for each protected instance.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0501__table114968589379"></a><a name="table114968589379"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0501__table114968589379" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="sdrs_05_0501__b84235270695528">resource_tag</strong> field description</caption><thead align="left"><tr id="sdrs_05_0501__row54941958113716"><th align="left" class="cellrowborder" valign="top" width="11.221122112211221%" id="mcps1.3.4.2.1.3.2.5.1.1"><p id="sdrs_05_0501__p1494165817373"><strong id="sdrs_05_0501__b842352706162023">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.72177217721772%" id="mcps1.3.4.2.1.3.2.5.1.2"><p id="sdrs_05_0501__p16494058143712"><strong id="sdrs_05_0501__b84235270615447">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.04210421042104%" id="mcps1.3.4.2.1.3.2.5.1.3"><p id="sdrs_05_0501__p549495833710">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.015001500150014%" id="mcps1.3.4.2.1.3.2.5.1.4"><p id="sdrs_05_0501__p1649495811378"><strong id="sdrs_05_0501__b396938602">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0501__row1449525863716"><td class="cellrowborder" valign="top" width="11.221122112211221%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="sdrs_05_0501__p1249495833712">key</p>
</td>
<td class="cellrowborder" valign="top" width="17.72177217721772%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="sdrs_05_0501__p134946586376">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.04210421042104%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="sdrs_05_0501__p149485815371">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.015001500150014%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="sdrs_05_0501__p84941058193712">Specifies the tag key. The tag key of a resource must be unique.</p>
</td>
</tr>
<tr id="sdrs_05_0501__row4495195812376"><td class="cellrowborder" valign="top" width="11.221122112211221%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="sdrs_05_0501__p84951558153713">value</p>
</td>
<td class="cellrowborder" valign="top" width="17.72177217721772%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="sdrs_05_0501__p449585883713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.04210421042104%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="sdrs_05_0501__p849515819375">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.015001500150014%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="sdrs_05_0501__p04951458103719">Specifies the value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="sdrs_05_0501__en-us_topic_0079693002_ul53989823"><li id="sdrs_05_0501__en-us_topic_0079693002_li16146366">Example request<div class="p" id="sdrs_05_0501__p487772514510"><a name="sdrs_05_0501__en-us_topic_0079693002_li16146366"></a><a name="en-us_topic_0079693002_li16146366"></a>POST https://{Endpoint}/v1/{project_id}/protected-instances<pre class="screen" id="sdrs_05_0501__screen1813851817456">{
"protected_instance":{
"server_group_id": "523ab8ad-3759-4933-9436-4cf4ebb20867",
"server_id": "403b603d-1d91-42cc-a357-81f3c2daf43f",
"name": "test_protected_instance_name",
"description": "my description",
"primary_subnet_id": "a32217fh-3413-c313-6342-3124d3491502",
"primary_ip_address": "192.168.0.5",
"flavorRef": "s3.large.2",
"tags": [
{
"key": "key1",
"value":"value1"
},
{
"key": "key",
"value": "value3"
}
]
}
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0501__en-us_topic_0079693002_section36549175"><h4 class="sectiontitle">Response</h4><ul id="sdrs_05_0501__en-us_topic_0079693002_ul48735027"><li id="sdrs_05_0501__en-us_topic_0079693002_li35962059">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0501__table155991608555" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0501__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_0501__p125611510173">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_0501__p1456195171718">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_0501__p12561651177">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0501__row86164025512"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="sdrs_05_0501__p4561551711">job_id</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_0501__p35635121719">String</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_0501__p538173714408">Specifies the returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in <a href="sdrs_05_0101.html">Querying the Job Status</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sdrs_05_0501__en-us_topic_0079693002_li66450672">Example response<pre class="screen" id="sdrs_05_0501__screen68331720141710">{
"job_id": "0000000062db92d70162db9d200f00bb"
}</pre>
<p id="sdrs_05_0501__p101721850">Or</p>
<pre class="screen" id="sdrs_05_0501__screen196188281259">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="sdrs_05_0501__p1812211151">In this example, <strong id="sdrs_05_0501__b590682232214">error</strong> represents a general error, including <strong id="sdrs_05_0501__b19927162216227">badrequest</strong> (shown below) and <strong id="sdrs_05_0501__b3927422182215">itemNotFound</strong>.</p>
<pre class="screen" id="sdrs_05_0501__screen936637358">{
"badrequest": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="sdrs_05_0501__en-us_topic_0079693002_section60507121"><h4 class="sectiontitle">Returned Values</h4><ul id="sdrs_05_0501__en-us_topic_0079693002_ul18743339"><li id="sdrs_05_0501__li37400248244">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0501__sdrs_05_0101_table4315991194956" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p3039012494956">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p1545496394956">The server has accepted the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sdrs_05_0501__li13951479">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0501__sdrs_05_0101_table22458872203835" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p47646009203835">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p63350108203835">The server failed to process the request.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p45364094203835">You must enter a username and the password to access the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p54117066203835">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p35909542203835">The server could not find the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p50902717203835">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p15684678203835">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__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_0501__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_0501__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_0501__sdrs_05_0101_p11786919203835">The request timed out.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p19779281203835">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__sdrs_05_0101_p51235984203835">Failed to complete the request because of a service error.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__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_0501__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_0501__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_0501__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_0501__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_0501__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_0501__sdrs_05_0101_p37098455203835">Failed to complete the request because the system is unavailable.</p>
</td>
</tr>
<tr id="sdrs_05_0501__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_0501__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_0501__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>
View Git Blame Copy Permalink