vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_2107.html
zhangyue ccbf63b495 EVS API DOC 
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-05-16 09:08:21 +00:00

212 lines
16 KiB
HTML
Raw Blame History

<a name="evs_04_2107"></a><a name="evs_04_2107"></a>
<h1 class="topictitle1">Accepting a Disk Transfer</h1>
<div id="body8662426"><div class="section" id="evs_04_2107__en-us_topic_0092901819_section44805042171914"><h4 class="sectiontitle">Function</h4><p id="evs_04_2107__en-us_topic_0092901819_p3755185734611">This API is used to accept a disk transfer through the transfer ID and authentication key.</p>
</div>
<div class="section" id="evs_04_2107__en-us_topic_0092901819_section47607821172029"><h4 class="sectiontitle">Constraints</h4><ul id="evs_04_2107__ul64892280151422"><li id="evs_04_2107__en-us_topic_0093691164_en-us_topic_0092887872_li171556610508">Encrypted EVS disks cannot be transferred.</li><li id="evs_04_2107__en-us_topic_0093691164_en-us_topic_0092887872_li4567911125014">EVS disks with backups and snapshots available cannot be transferred.</li><li id="evs_04_2107__en-us_topic_0093691164_en-us_topic_0092887872_li780416329501">EVS disks associated with backup policies cannot be transferred.</li><li id="evs_04_2107__en-us_topic_0093691164_li1827361512598">EVS disks used as system disks cannot be transferred.</li><li id="evs_04_2107__en-us_topic_0093691164_en-us_topic_0092887872_li7697829115010">EVS disks in EVS replication pairs cannot be transferred.</li></ul>
<div class="note" id="evs_04_2107__note30956716173438"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="evs_04_2107__evs_04_2106_p33550677172829">If the disk transfer is created using one of the unsupported disks, error code 400 will be returned.</p>
</div></div>
</div>
<div class="section" id="evs_04_2107__section1165125022416"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2107__ul3275626112518"><li id="evs_04_2107__li32759261251">URI format<p id="evs_04_2107__p17275102652519"><a name="evs_04_2107__li32759261251"></a><a name="li32759261251"></a>POST /v2/{project_id}/os-volume-transfer/{transfer_id}/accept</p>
</li><li id="evs_04_2107__li1127562632515">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2107__table2027517263253" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2107__row102761226182515"><th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.3.2.2.1.1.4.1.1"><p id="evs_04_2107__p162762026162519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.3.2.2.1.1.4.1.2"><p id="evs_04_2107__p127642622515">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.9%" id="mcps1.3.3.2.2.1.1.4.1.3"><p id="evs_04_2107__p8276926112511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2107__row18276426132517"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2107__p7276126172516">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2107__p122761326192517">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2107__p827712613258">The project ID.</p>
</td>
</tr>
<tr id="evs_04_2107__row127732632517"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2107__p12277192622513">transfer_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2107__p927792682512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2107__p19277626182515">The transfer ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2107__en-us_topic_0092901819_section3832507172056"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2107__evs_04_2106_ul390613356229"><li id="evs_04_2107__evs_04_2106_li19654399">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2107__evs_04_2106_table42671863" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2107__evs_04_2106_row12592542"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="evs_04_2107__evs_04_2106_p13362997">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="evs_04_2107__evs_04_2106_p8661001">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="evs_04_2107__evs_04_2106_p30452481">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="evs_04_2107__evs_04_2106_p50731910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2107__evs_04_2106_row5187493615377"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="evs_04_2107__evs_04_2106_p4112025815377">accept</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="evs_04_2107__evs_04_2106_p4240658415377">Object</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="evs_04_2107__evs_04_2106_p1238131615377">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="evs_04_2107__evs_04_2106_p6336250715377">The transfer acceptance marker. For details, see <a href="#evs_04_2107__li55316081111336">Parameter in the accept field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2107__ul18954313111336"><li id="evs_04_2107__li55316081111336"><a name="evs_04_2107__li55316081111336"></a><a name="li55316081111336"></a>Parameter in the <strong id="evs_04_2107__b09651012967">accept</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2107__en-us_topic_0092887872_table881415614117" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2107__en-us_topic_0092887872_row168152061012"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.3.1.2.1.5.1.1"><p id="evs_04_2107__en-us_topic_0092887872_p17815961816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.3.1.2.1.5.1.2"><p id="evs_04_2107__en-us_topic_0092887872_p9815116514">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.3.1.2.1.5.1.3"><p id="evs_04_2107__en-us_topic_0092887872_p11815176017">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41%" id="mcps1.3.4.3.1.2.1.5.1.4"><p id="evs_04_2107__en-us_topic_0092887872_p881596417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2107__en-us_topic_0092887872_row6815269119"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="evs_04_2107__p64366674111553">auth_key</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="evs_04_2107__p46318102111553">String</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="evs_04_2107__p60778811111553">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="41%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="evs_04_2107__p24136681111553">The authentication key of the transfer.</p>
<p id="evs_04_2107__p1338232914415">An authentication key will be returned when a disk transfer is created.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2107__li31331955111621">Example request<pre class="screen" id="evs_04_2107__screen33915656104116">{
"accept": {
"auth_key": "9266c59563c84664"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2107__en-us_topic_0092901819_section23586530172122"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2107__ul24619052111714"><li id="evs_04_2107__li56491057297">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2107__table1265065712913" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2107__row565045719919"><th align="left" class="cellrowborder" valign="top" width="24.67753224677532%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="evs_04_2107__p965065715915">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.67753224677532%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="evs_04_2107__p1465018571910">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.64493550644935%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="evs_04_2107__p14650857797">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2107__row1465012571994"><td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2107__p176508571198">transfer</p>
</td>
<td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2107__p165035718911">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.64493550644935%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2107__p665065715911">The transfer information. For details, see <a href="#evs_04_2107__li12496189111714">Parameters in the transfer field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2107__li12496189111714"><a name="evs_04_2107__li12496189111714"></a><a name="li12496189111714"></a>Parameters in the <strong id="evs_04_2107__b17391584417">transfer</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2107__en-us_topic_0092901819_table6685576181553" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2107__en-us_topic_0092901819_row1296752181553"><th align="left" class="cellrowborder" valign="top" width="24.67753224677532%" id="mcps1.3.5.2.2.2.1.4.1.1"><p id="evs_04_2107__en-us_topic_0092901819_p37928058181553">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.67753224677532%" id="mcps1.3.5.2.2.2.1.4.1.2"><p id="evs_04_2107__en-us_topic_0092901819_p52273840181553">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.64493550644935%" id="mcps1.3.5.2.2.2.1.4.1.3"><p id="evs_04_2107__en-us_topic_0092901819_p42375363181553">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2107__en-us_topic_0092901819_row569771417102"><td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2107__en-us_topic_0092901819_p369761461010">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2107__en-us_topic_0092901819_p769712143104">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.64493550644935%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2107__en-us_topic_0092901819_p56979145107">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2107__en-us_topic_0092901819_row2457217151019"><td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2107__en-us_topic_0092901819_p94571174106">id</p>
</td>
<td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2107__en-us_topic_0092901819_p174577172105">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.64493550644935%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2107__en-us_topic_0092901819_p18457171718107">The transfer ID.</p>
</td>
</tr>
<tr id="evs_04_2107__en-us_topic_0092901819_row527752431012"><td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2107__en-us_topic_0092901819_p10277112415105">name</p>
</td>
<td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2107__en-us_topic_0092901819_p4277132441017">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.64493550644935%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2107__en-us_topic_0092901819_p827720241108">The transfer name.</p>
</td>
</tr>
<tr id="evs_04_2107__en-us_topic_0092901819_row10511614102910"><td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2107__en-us_topic_0092901819_p19144131917296">links</p>
</td>
<td class="cellrowborder" valign="top" width="24.67753224677532%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2107__p184591084537">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.64493550644935%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2107__en-us_topic_0092901819_p184902291294">The links of the transfer. For details, see <a href="#evs_04_2107__li12225016174715">Parameters in the links field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="evs_04_2107__p188701611174720"></p>
</li><li id="evs_04_2107__li12225016174715"><a name="evs_04_2107__li12225016174715"></a><a name="li12225016174715"></a>Parameters in the <strong id="evs_04_2107__b444745215116">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2107__table6233316104714" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2107__row62338165478"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.3.2.1.4.1.1"><p id="evs_04_2107__p123351624716">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.3.2.1.4.1.2"><p id="evs_04_2107__p72336166476">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.2.3.2.1.4.1.3"><p id="evs_04_2107__p0233151620475">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2107__row16233416204711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2107__p82331116134715">href</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2107__p142331616184710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2107__p5233161674714">The corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2107__row1823321614474"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2107__p17233111617471">rel</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2107__p17233416134711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2107__p16233916114720">The shortcut link marker name.</p>
<p id="evs_04_2107__p923312161476">The default value is <strong id="evs_04_2107__b1713014795211">next</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2107__li33760358111839">Example response<pre class="screen" id="evs_04_2107__en-us_topic_0092901819_screen58672335182352">{
"transfer": {
"id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
"name": "first volume transfer",
"volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
"links": [
{
"href": "https://localhost/v2/firstproject/os-volume-transfer/1",
"rel": "self"
},
{
"href": "https://localhost/firstproject/os-volume-transfer/1",
"rel": "bookmark"
}
]
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2107__en-us_topic_0092901819_section10353980172239"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2107__evs_04_2106_ul19693556115535"><li id="evs_04_2107__evs_04_2106_li6453736115535">Normal<p id="evs_04_2107__evs_04_2106_p50494725174145"><a name="evs_04_2107__evs_04_2106_li6453736115535"></a><a name="evs_04_2106_li6453736115535"></a>202</p>
</li></ul>
</div>
<div class="section" id="evs_04_2107__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2107__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_2105.html">Disk Transfer Management</a></div>
</div>
</div>
View Git Blame Copy Permalink