vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_2106.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

232 lines
18 KiB
HTML
Raw Blame History

<a name="evs_04_2106"></a><a name="evs_04_2106"></a>
<h1 class="topictitle1">Creating a Disk Transfer</h1>
<div id="body8662426"><div class="section" id="evs_04_2106__en-us_topic_0092887872_section44805042171914"><h4 class="sectiontitle">Function</h4><p id="evs_04_2106__en-us_topic_0092887872_p3755185734611">This API is used to create a disk transfer. After the transfer has been created, a transfer ID and an authentication key are returned.</p>
<p id="evs_04_2106__p252372120371">After a disk transfer is created, the disk status changes from <strong id="evs_04_2106__b842352706173933">available</strong> to <strong id="evs_04_2106__b842352706173942">awaiting-transfer</strong>. Once the disk transfer is accepted, the disk status changes to <strong id="evs_04_2106__b2081555072173958">available</strong> again.</p>
</div>
<div class="section" id="evs_04_2106__en-us_topic_0092887872_section47607821172029"><h4 class="sectiontitle">Constraints</h4><p id="evs_04_2106__p11564013175018">A disk transfer can be created only when the disk status is <strong id="evs_04_2106__b84235270692552">available</strong>. The detailed constraints are as follows:</p>
<ul id="evs_04_2106__ul64892280151422"><li id="evs_04_2106__en-us_topic_0093691164_en-us_topic_0092887872_li171556610508">Encrypted EVS disks cannot be transferred.</li><li id="evs_04_2106__en-us_topic_0093691164_en-us_topic_0092887872_li4567911125014">EVS disks with backups and snapshots available cannot be transferred.</li><li id="evs_04_2106__en-us_topic_0093691164_en-us_topic_0092887872_li780416329501">EVS disks associated with backup policies cannot be transferred.</li><li id="evs_04_2106__en-us_topic_0093691164_li1827361512598">EVS disks used as system disks cannot be transferred.</li><li id="evs_04_2106__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_2106__note33554014172829"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="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_2106__section1351917332235"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2106__ul102141029243"><li id="evs_04_2106__li172142220249">URI format<p id="evs_04_2106__p62141623241"><a name="evs_04_2106__li172142220249"></a><a name="li172142220249"></a>POST /v2/{project_id}/os-volume-transfer</p>
</li><li id="evs_04_2106__li142141128241">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2106__table12146232414" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2106__row1221412122414"><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_2106__p17214424242">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_2106__p7214122102419">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_2106__p1021542202417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2106__row202151428245"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2106__p32155212418">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_2106__p721519211241">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_2106__p6215122152416">The project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2106__en-us_topic_0092887872_section3832507172056"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2106__ul390613356229"><li id="evs_04_2106__li19654399">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2106__table42671863" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2106__row12592542"><th align="left" class="cellrowborder" valign="top" width="19.17%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="evs_04_2106__p13362997">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.15%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="evs_04_2106__p8661001">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.380000000000003%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="evs_04_2106__p30452481">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.300000000000004%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="evs_04_2106__p50731910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2106__row5187493615377"><td class="cellrowborder" valign="top" width="19.17%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="evs_04_2106__p4112025815377">transfer</p>
</td>
<td class="cellrowborder" valign="top" width="18.15%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="evs_04_2106__p4240658415377">Object</p>
</td>
<td class="cellrowborder" valign="top" width="17.380000000000003%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="evs_04_2106__p1238131615377">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.300000000000004%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="evs_04_2106__p6336250715377">The transfer creation marker. For details, see <a href="#evs_04_2106__li55316081111336">Parameters in the transfer field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2106__ul18954313111336"><li id="evs_04_2106__li55316081111336"><a name="evs_04_2106__li55316081111336"></a><a name="li55316081111336"></a>Parameters in the <strong id="evs_04_2106__b1865113654">transfer</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2106__en-us_topic_0092887872_table881415614117" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2106__en-us_topic_0092887872_row168152061012"><th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.4.3.1.2.1.5.1.1"><p id="evs_04_2106__en-us_topic_0092887872_p17815961816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.4.3.1.2.1.5.1.2"><p id="evs_04_2106__en-us_topic_0092887872_p9815116514">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.4.3.1.2.1.5.1.3"><p id="evs_04_2106__en-us_topic_0092887872_p11815176017">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.43434343434344%" id="mcps1.3.4.3.1.2.1.5.1.4"><p id="evs_04_2106__en-us_topic_0092887872_p881596417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2106__en-us_topic_0092887872_row6815269119"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="evs_04_2106__en-us_topic_0092887872_p15774191420418">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="evs_04_2106__en-us_topic_0092887872_p11815126917">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="evs_04_2106__en-us_topic_0092887872_p178154611118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="evs_04_2106__en-us_topic_0092887872_p88151664117">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2106__en-us_topic_0092887872_row48151561014"><td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="evs_04_2106__en-us_topic_0092887872_p1781517616118">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="evs_04_2106__en-us_topic_0092887872_p10815136119">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="evs_04_2106__en-us_topic_0092887872_p98151467115">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="evs_04_2106__en-us_topic_0092887872_p17815196917">The transfer name, which can contain a maximum of 255 bytes.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2106__li40388735111414">Example request<pre class="screen" id="evs_04_2106__en-us_topic_0092887872_screen6454553819564">{
"transfer": {
"volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37",
"name": "first volume"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2106__en-us_topic_0092887872_section23586530172122"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2106__ul10293659111447"><li id="evs_04_2106__li1867294416213">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2106__table367317440212" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2106__row167314412210"><th align="left" class="cellrowborder" valign="top" width="24.05%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="evs_04_2106__p467324415210">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.05%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="evs_04_2106__p156746441427">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.9%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="evs_04_2106__p8674134413213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2106__row196747441326"><td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2106__p967411441324">transfer</p>
</td>
<td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2106__p106741844324">Object</p>
</td>
<td class="cellrowborder" valign="top" width="51.9%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2106__p1067484418216">The transfer information. For details, see <a href="#evs_04_2106__li32419762111447">Parameters in the transfer field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2106__li32419762111447"><a name="evs_04_2106__li32419762111447"></a><a name="li32419762111447"></a>Parameters in the <strong id="evs_04_2106__b1529653672">transfer</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2106__en-us_topic_0092887872_table6685576181553" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2106__en-us_topic_0092887872_row1296752181553"><th align="left" class="cellrowborder" valign="top" width="24.05%" id="mcps1.3.5.2.2.2.1.4.1.1"><p id="evs_04_2106__en-us_topic_0092887872_p37928058181553">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.05%" id="mcps1.3.5.2.2.2.1.4.1.2"><p id="evs_04_2106__en-us_topic_0092887872_p52273840181553">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.9%" id="mcps1.3.5.2.2.2.1.4.1.3"><p id="evs_04_2106__en-us_topic_0092887872_p42375363181553">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2106__en-us_topic_0092887872_row45833953181553"><td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2106__en-us_topic_0092887872_p21562735181553">auth_key</p>
</td>
<td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2106__en-us_topic_0092887872_p1751085181553">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.9%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2106__en-us_topic_0092887872_p13253466181553">The authentication key of the transfer.</p>
</td>
</tr>
<tr id="evs_04_2106__en-us_topic_0092887872_row12974480107"><td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2106__en-us_topic_0092887872_p1097410819109">links</p>
</td>
<td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2106__p171701480532">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.9%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2106__en-us_topic_0092887872_p17974484101">The links of the transfer. See <a href="#evs_04_2106__li121313126558">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2106__en-us_topic_0092887872_row862121220101"><td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2106__en-us_topic_0092887872_p1762112141010">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2106__en-us_topic_0092887872_p4623123109">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.9%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2106__en-us_topic_0092887872_p186221213104">The time when the transfer was created.</p>
<p id="evs_04_2106__p189414591376">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2106__en-us_topic_0092887872_row569771417102"><td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2106__en-us_topic_0092887872_p369761461010">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2106__en-us_topic_0092887872_p769712143104">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.9%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2106__en-us_topic_0092887872_p56979145107">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2106__en-us_topic_0092887872_row2457217151019"><td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2106__en-us_topic_0092887872_p94571174106">id</p>
</td>
<td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2106__en-us_topic_0092887872_p174577172105">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.9%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2106__en-us_topic_0092887872_p18457171718107">The transfer ID.</p>
</td>
</tr>
<tr id="evs_04_2106__en-us_topic_0092887872_row527752431012"><td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2106__en-us_topic_0092887872_p10277112415105">name</p>
</td>
<td class="cellrowborder" valign="top" width="24.05%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2106__en-us_topic_0092887872_p4277132441017">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.9%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2106__en-us_topic_0092887872_p827720241108">The transfer name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2106__li121313126558"><a name="evs_04_2106__li121313126558"></a><a name="li121313126558"></a>Parameters in the <strong id="evs_04_2106__b1754218465545">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2106__table162261214556" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2106__row18211312205520"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.3.2.1.4.1.1"><p id="evs_04_2106__p17211712165510">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_2106__p52112120550">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_2106__p162141235511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2106__row52151211555"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2106__p92115128555">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_2106__p162181215551">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_2106__p172111285516">The corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2106__row11211912165515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2106__p1021121225519">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_2106__p72181212553">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_2106__p32181285518">The shortcut link marker name.</p>
<p id="evs_04_2106__p14211812145510">The default value is <strong id="evs_04_2106__b1997514131472">next</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2106__li52315707111516">Example response<pre class="screen" id="evs_04_2106__screen50358992103933">{
"transfer": {
"id": "1a7059f5-8ed7-45b7-8d05-2811e5d09f24",
"created_at": "2015-02-25T03:56:53.081642",
"name": "first volume",
"volume_id": "c86b9af4-151d-4ead-b62c-5fb967af0e37",
"auth_key": "9266c59563c84664",
"links": [
{
"href": "https://localhost/v2/firstproject/os-volume-transfer/3",
"rel": "self"
},
{
"href": "https://localhost/firstproject/os-volume-transfer/3",
"rel": "bookmark"
}
]
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2106__en-us_topic_0092887872_section10353980172239"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2106__ul19693556115535"><li id="evs_04_2106__li6453736115535">Normal<p id="evs_04_2106__p50494725174145"><a name="evs_04_2106__li6453736115535"></a><a name="li6453736115535"></a>202</p>
</li></ul>
</div>
<div class="section" id="evs_04_2106__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2106__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