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

211 lines
15 KiB
HTML
Raw Blame History

<a name="evs_04_2111"></a><a name="evs_04_2111"></a>
<h1 class="topictitle1">Querying Details of All Disk Transfers</h1>
<div id="body8662426"><div class="section" id="evs_04_2111__en-us_topic_0092902037_section44805042171914"><h4 class="sectiontitle">Function</h4><p id="evs_04_2111__en-us_topic_0092902035_p3755185734611">This API is used to query the details of all disk transfers, including the transfer creation time, transfer IDs, and transfer names.</p>
</div>
<div class="section" id="evs_04_2111__en-us_topic_0092887872_section21748494171940"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2111__ul62624805105042"><li id="evs_04_2111__li41712664105042">URI format<p id="evs_04_2111__p66548798105824"><a name="evs_04_2111__li41712664105042"></a><a name="li41712664105042"></a>GET /v2/{project_id}/os-volume-transfer/detail</p>
</li><li id="evs_04_2111__li37112768105832">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2111__table5162674110529" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2111__row4741724810529"><th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2111__p1559190910529">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2111__p5498513910529">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.9%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_2111__p2461124910529">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2111__row4735411910529"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2111__p1047843010529">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2111__p4344649310529">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2111__p2950506910529">The project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2111__li96915283546">Request filter parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2111__evs_04_2110_table114096539515" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2111__evs_04_2110_row64913538519"><th align="left" class="cellrowborder" valign="top" width="17.82178217821782%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_2111__evs_04_2110_p14491115311514">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.82178217821782%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_2111__evs_04_2110_p54911753125116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.772277227722775%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_2111__evs_04_2110_p10491105315113">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.584158415841586%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_2111__evs_04_2110_p16491553125110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2111__evs_04_2110_row64916530515"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2111__evs_04_2110_p14491953135112">limit</p>
</td>
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2111__evs_04_2110_p15491185365111">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="22.772277227722775%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2111__evs_04_2110_p349155345117">No</p>
</td>
<td class="cellrowborder" valign="top" width="41.584158415841586%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2111__evs_04_2110_p12491175314513">The maximum number of query results that can be returned.</p>
<p id="evs_04_2111__evs_04_2110_p116095293163">The value ranges from <strong id="evs_04_2111__evs_04_2110_b547819185558">1</strong> to <strong id="evs_04_2111__evs_04_2110_b44801218165518">1000</strong>, and the default value is <strong id="evs_04_2111__evs_04_2110_b8481181813556">1000</strong>. The returned value cannot exceed this limit.</p>
</td>
</tr>
<tr id="evs_04_2111__evs_04_2110_row12491135365118"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2111__evs_04_2110_p54911153165115">offset</p>
</td>
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2111__evs_04_2110_p0491145315116">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="22.772277227722775%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2111__evs_04_2110_p549165318518">No</p>
</td>
<td class="cellrowborder" valign="top" width="41.584158415841586%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2111__evs_04_2110_p164913532515">The query offset. All disk transfers after this offset will be queried. The value must be an integer greater than 0 but less than the number of disk transfers.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2111__section45527389"><h4 class="sectiontitle">Request</h4><p id="evs_04_2111__p8131165310442">The following example shows how to query details of the disk transfers whose limit is no more than 50.</p>
<ul id="evs_04_2111__ul28722627"><li id="evs_04_2111__li57177053">Example request<pre class="screen" id="evs_04_2111__screen13806089161140">GET https://{endpoint}/v2/{project_id}/os-volume-transfer/detail?limit=50</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2111__en-us_topic_0092902037_section23586530172122"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2111__ul1442152203714"><li id="evs_04_2111__li11442929372">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2111__table44421424377" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2111__row16442202183720"><th align="left" class="cellrowborder" valign="top" width="23.377662233776622%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2111__p044210213713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.377662233776622%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2111__p1944232103719">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.24467553244675%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2111__p104421529376">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2111__row1944316223713"><td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2111__p124437213370">transfers</p>
</td>
<td class="cellrowborder" valign="top" width="23.377662233776622%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2111__p1944332193718">List&lt;Transfer&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2111__p124439263715">The list of transfer details. For details, see <a href="#evs_04_2111__li39411666114933">Parameters in the transfers field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2111__ul38533821114933"><li id="evs_04_2111__li39411666114933"><a name="evs_04_2111__li39411666114933"></a><a name="li39411666114933"></a>Parameters in the <strong id="evs_04_2111__b4853152121116">transfers</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2111__en-us_topic_0092902037_table6685576181553" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2111__en-us_topic_0092902037_row1296752181553"><th align="left" class="cellrowborder" valign="top" width="23.41765823417658%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="evs_04_2111__p6080130411503">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.337666233376662%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="evs_04_2111__p2595862911503">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.24467553244675%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="evs_04_2111__p5937927111503">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2111__en-us_topic_0092902037_row12974480107"><td class="cellrowborder" valign="top" width="23.41765823417658%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2111__en-us_topic_0092902037_p1097410819109">links</p>
</td>
<td class="cellrowborder" valign="top" width="23.337666233376662%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2111__p16501484535">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2111__en-us_topic_0092902036_p17974484101">The links of the transfer. See <a href="#evs_04_2111__li137688431586">Parameters in the Link field</a>.</p>
</td>
</tr>
<tr id="evs_04_2111__en-us_topic_0092902037_row862121220101"><td class="cellrowborder" valign="top" width="23.41765823417658%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2111__en-us_topic_0092902037_p1762112141010">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.337666233376662%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2111__en-us_topic_0092902037_p4623123109">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2111__en-us_topic_0092902037_p186221213104">The time when the transfer was created.</p>
<p id="evs_04_2111__p418335273815"><span id="evs_04_2111__text164869573817">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2111__en-us_topic_0092902037_row569771417102"><td class="cellrowborder" valign="top" width="23.41765823417658%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2111__en-us_topic_0092902037_p369761461010">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.337666233376662%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2111__en-us_topic_0092902037_p769712143104">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2111__en-us_topic_0092902037_p56979145107">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2111__en-us_topic_0092902037_row2457217151019"><td class="cellrowborder" valign="top" width="23.41765823417658%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2111__en-us_topic_0092902037_p94571174106">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.337666233376662%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2111__en-us_topic_0092902037_p174577172105">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2111__p20497649115033">The transfer ID.</p>
</td>
</tr>
<tr id="evs_04_2111__en-us_topic_0092902037_row527752431012"><td class="cellrowborder" valign="top" width="23.41765823417658%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="evs_04_2111__en-us_topic_0092902037_p10277112415105">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.337666233376662%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="evs_04_2111__en-us_topic_0092902037_p4277132441017">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.24467553244675%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="evs_04_2111__p44618758115033">The transfer name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2111__li137688431586"><a name="evs_04_2111__li137688431586"></a><a name="li137688431586"></a>Parameters in the <strong id="evs_04_2111__b453517855618">Link</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2111__table187765436581" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2111__row6776104325818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.2.1.4.1.1"><p id="evs_04_2111__p1477615432589">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.2.1.4.1.2"><p id="evs_04_2111__p14776194316589">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.2.1.4.1.3"><p id="evs_04_2111__p4776743115810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2111__row20776104385818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.2.1.4.1.1 "><p id="evs_04_2111__p277684314581">href</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.2.1.4.1.2 "><p id="evs_04_2111__p37762043115811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.2.1.4.1.3 "><p id="evs_04_2111__p677684385819">The corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2111__row4776124310583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.2.1.4.1.1 "><p id="evs_04_2111__p977644316588">rel</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.2.1.4.1.2 "><p id="evs_04_2111__p2776743195816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.2.1.4.1.3 "><p id="evs_04_2111__p1877617432587">The shortcut link marker name.</p>
<p id="evs_04_2111__p77761543105820">The default value is <strong id="evs_04_2111__b63531329145614">next</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2111__ul40409631115128"><li id="evs_04_2111__li41503933115128">Example response<pre class="screen" id="evs_04_2111__screen13772658104411">{
"transfers": [
{
"id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
"created_at": "2015-02-25T03:56:53.081642",
"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"
}
]
},
{
"id": "f26c0dee-d20d-4e80-8dee-a8d91b9742a1",
"created_at": "2015-03-25T03:56:53.081642",
"name": "second volume transfer",
"volume_id": "673db275-379f-41af-8371-e1652132b4c1",
"links": [
{
"href": "https://localhost/v2/firstproject/os-volume-transfer/2",
"rel": "self"
},
{
"href": "https://localhost/firstproject/os-volume-transfer/2",
"rel": "bookmark"
}
]
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2111__en-us_topic_0092902037_section10353980172239"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2111__evs_04_2109_ul19693556115535"><li id="evs_04_2111__evs_04_2109_li6453736115535">Normal<p id="evs_04_2111__evs_04_2109_p50494725174145"><a name="evs_04_2111__evs_04_2109_li6453736115535"></a><a name="evs_04_2109_li6453736115535"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2111__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2111__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