vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vbs/api-ref/en-us_topic_0078214153.html
Wei, Hongmin 63123ef1be VBS API initial version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-25 07:47:39 +00:00

493 lines
37 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0078214153"></a><a name="EN-US_TOPIC_0078214153"></a>
<h1 class="topictitle1">Querying Backup Sharings</h1>
<div id="body1506308905097"><div class="section" id="EN-US_TOPIC_0078214153__section353862016108"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0078214153__p15777218106">This API is used to query backup sharings.</p>
</div>
<div class="section" id="EN-US_TOPIC_0078214153__section16539122018107"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0078214153__ul1978021171017"><li id="EN-US_TOPIC_0078214153__li1478172112104">URI format<p id="EN-US_TOPIC_0078214153__p167741459142818"><a name="EN-US_TOPIC_0078214153__li1478172112104"></a><a name="li1478172112104"></a>GET /v2/{project_id}/os-vendor-backup-sharing/detail</p>
</li><li id="EN-US_TOPIC_0078214153__li13781221131011">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0078214153__table145421020191019" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0078214153__row1478021111013"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="EN-US_TOPIC_0078214153__p1625418168917">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="EN-US_TOPIC_0078214153__p9254916897">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="EN-US_TOPIC_0078214153__p1254191615916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0078214153__row1378122131018"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p1025419164915">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p3254171615911">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p64170449">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0078214153__ul137802115107"><li id="EN-US_TOPIC_0078214153__li6781221181019"><strong id="EN-US_TOPIC_0078214153__b842352706213435">Request filter </strong>parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0078214153__table454752051016" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0078214153__row079122141016"><th align="left" class="cellrowborder" valign="top" width="16.16161616161616%" id="mcps1.3.2.3.1.2.1.5.1.1"><p id="EN-US_TOPIC_0078214153__p61804813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.19191919191919%" id="mcps1.3.2.3.1.2.1.5.1.2"><p id="EN-US_TOPIC_0078214153__p40133923">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.16161616161616%" id="mcps1.3.2.3.1.2.1.5.1.3"><p id="EN-US_TOPIC_0078214153__p14225104112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.484848484848484%" id="mcps1.3.2.3.1.2.1.5.1.4"><p id="EN-US_TOPIC_0078214153__p29622330">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0078214153__row167912113108"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p0791621141014">share_to_me</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p8796219109">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p1280142120108">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p48092119105">If this parameter is set to <strong id="EN-US_TOPIC_0078214153__b84235270673034">true</strong>, this API will list the backups shared with the current project. Or, this API will list the backups shared by the current project.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row12801221191016"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p1780152112108">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p1099415331413">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p158092101011">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p1580221161020">Disk ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row88052151012"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p18806213109">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p739341018">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p1381182161017">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p1381122131012">Backup name. Fuzzy match is supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row08122113103"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p1181621161019">status</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p41114341110">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p681172141015">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p1581102131018">Backup status</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row2081121101010"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p1181102101010">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p14185341911">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p4811521171017">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p281182111013">Backup ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row9816218106"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p98152116102">from_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p1522193412116">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p2082221181010">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p58342117100">ID of the project that shares the backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row1383192151017"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p168332171018">to_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p92717341119">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p1083162111105">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p383102141010">ID of the project to which the backup is shared</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row168312111020"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p5832217106">avalilability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p63219345113">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p108322171019">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p138362110103">AZ name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row1983192181010"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p11834210108">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p103617341411">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p148442111100">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p784621131017">Sorting direction</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row128417214104"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p48482161014">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p04114341413">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p1984721141016">string</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p1484142112106">Sorts by attribute. Possible values are <strong id="EN-US_TOPIC_0078214153__b84235270673358">name</strong>, <strong id="EN-US_TOPIC_0078214153__b8423527067341">status</strong>, <strong id="EN-US_TOPIC_0078214153__b84235270673411">container_format</strong>, <strong id="EN-US_TOPIC_0078214153__b84235270673417">disk_format</strong>, <strong id="EN-US_TOPIC_0078214153__b84235270673420">size</strong>, <strong id="EN-US_TOPIC_0078214153__b84235270673423">id</strong>, <strong id="EN-US_TOPIC_0078214153__b84235270673428">created_at</strong>, and <strong id="EN-US_TOPIC_0078214153__b84235270673431">updated_at</strong>. The default value is <strong id="EN-US_TOPIC_0078214153__b84235270673435">created_at</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row4841621201016"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p16841021201015">limit</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p647203415119">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p1184202114108">int</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p1984421131015">Number of sharings to be queried</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row684132114101"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214153__p084142114104">offset</p>
</td>
<td class="cellrowborder" valign="top" width="19.19191919191919%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214153__p195443410110">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214153__p785021161011">int</p>
</td>
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214153__p18854218109">Offset of the query</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0078214153__section5592152001016"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0078214153__p5852210102">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0078214153__section15592620111016"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0078214153__ul108542112102"><li id="EN-US_TOPIC_0078214153__li28582111010">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0078214153__table1760412202109" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0078214153__row178522115109"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0078214153__p1241273320221">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0078214153__p042833332211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0078214153__p142803372219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0078214153__row1586521131012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p188614218102">shared</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p15865210104">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p186521181010">Backup sharing list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row12861021111010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p98662191010">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p986192113102">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p4861214107">Backup ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row178612181019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p108614212109">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p198612191018">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p28652112106">Creation time of the backup sharing</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row4860216104"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p78682114102">from_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p188618213101">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p186142117106">ID of the project that shares the backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row16861213109"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p58662111106">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p1286102111015">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p386821111013">Backup sharing ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row186202112108"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p886621201019">to_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p14872217105">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p1487421171010">ID of the project to which the backup is shared</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row1787192141016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p487172181012">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p78715218103">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p12871121121014">Update time of the backup sharing</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row3874210102"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p148719216102">backup</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p5871321101019">dict</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p18717218107">Details about the source backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row1987162161014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p88792115106">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p687112111015">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p42822461202619">AZ where the backup resides</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row158762115101"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p13870215102">container</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p1987221191017">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p45004514202619">Container of the backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row2871521191012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p3871921171019">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p5876210102">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p1604592202619">Backup creation time</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row088142114104"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p2881217109">data_timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p168810219108">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p14905520174631">Current time</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row88802161011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p1789112141012">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p1589621171013">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p51398114202619">Backup description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row1589132151010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p489202181015">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p4897216107">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p44790369202619">Cause of the backup failure</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row198942191012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p1290182120106">has_dependent_backup</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p199012110106">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p2446587175250">Whether a dependent backup exists. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row1090421191013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p990152151012">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p1290132161014">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p60551425202619">Backup ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row15909211101"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p119018212108">is_incremental</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p1591921121017">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p16898564175250">Whether the backup is an incremental backup. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row591182181015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p13911221101018">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p169122115109">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p27753504202619">Backup name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row17916210107"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p149152181010">object_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p1692132151010">int</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p51837782202619">Number of objects on OBS for the disk data</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row8921021161020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p19921721181010">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p1592421151012">int</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p38938725202619">Backup size</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row1692182111019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p092152121011">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p119212141018">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p1617637175250">ID of the snapshot associated with the backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row793162119102"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p1293132141019">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p1093122119106">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p55194315202619">Backup status</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row893142141017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p1493182119108">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p193821181011">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p5110169017462">Update time of the backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row89317219104"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p994182141010">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p19414212101">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p39169096202619">Source disk ID of the backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row11945211101"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214153__p6941921101011">service_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0078214153__p89612115106">string</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0078214153__p10122423202619">Backup metadata</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0078214153__ul11973217100"><li id="EN-US_TOPIC_0078214153__li1697152112101">Example response<pre class="screen" id="EN-US_TOPIC_0078214153__screen138913529519">{
"shared": [
{
"backup": {
"availability_zone": "AZ1",
"container": null,
"created_at": "2017-08-08T04:03:27.456859",
"data_timestamp": "2017-08-08T04:03:27.456859",
"description": null,
"fail_reason": "Invalid InitiatorConnector protocol specified DSWARE",
"has_dependent_backups": null,
"id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
"is_incremental": null,
"name": "lbf",
"object_count": null,
"size": 1,
"snapshot_id": null,
"status": "available",
"updated_at": "2017-08-08T04:03:35.109308",
"volume_id": "a7d7783f-02b7-4645-b0e3-61df63f0ba10",
"service_metadata": null
},
"backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
"created_at": "2017-08-10T12:25:40.480424",
"from_project_id": "c13f5220dc1949b0b741ea81a7cd5554",
"id": "e842bf23-1e05-4c2c-b0f9-25222f4686da",
"to_project_id": "722513ed0a324dadaabe5b2d0fe848b9",
"updated_at": "2017-08-14T06:41:49.381069"
},
{
"backup": {
"availability_zone": "AZ1",
"container": null,
"created_at": "2017-08-08T04:03:27.456859",
"data_timestamp": "2017-08-08T04:03:27.456859",
"description": null,
"fail_reason": "Invalid InitiatorConnector protocol specified DSWARE",
"has_dependent_backups": null,
"id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
"is_incremental": null,
"name": "lbf",
"object_count": null,
"size": 1,
"snapshot_id": null,
"status": "available",
"updated_at": "2017-08-08T04:03:35.109308",
"volume_id": "a7d7783f-02b7-4645-b0e3-61df63f0ba10",
"service_metadata": null
},
"backup_id": "066b1e37-9305-4057-97e5-2e99b21fc71d",
"created_at": "2017-08-10T12:19:37.318031",
"from_project_id": "c13f5220dc1949b0b741ea81a7cd5554",
"id": "f842bf23-1e05-4c2c-b0f9-25222f4686da",
"to_project_id": "722513ed0a324dadaabe5b2d0fe848a9",
"updated_at": null
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0078214153__section368014204108"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0078214153__ul4981221151019"><li id="EN-US_TOPIC_0078214153__li998621101010">Normal<p id="EN-US_TOPIC_0078214153__p49872171017"><a name="EN-US_TOPIC_0078214153__li998621101010"></a><a name="li998621101010"></a>200</p>
</li><li id="EN-US_TOPIC_0078214153__li159815212104">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0078214153__table59178184203255" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0078214153__row54047877203255"><th align="left" class="cellrowborder" valign="top" width="43.419999999999995%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0078214153__p15801936203255">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.58%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0078214153__p4888452203255">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0078214153__row60420295203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p62205764203255">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p5502113203255">The server failed to process the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row49519019203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p51617596203255">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p20275713203255">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row48263690203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p17044857203255">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p38456209203255">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row10561563203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p50180290203255">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p38071718203255">The server could not find the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row7101146203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p38321955203255">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p17070685203255">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row19418444203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p29390130203255">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p31790300203255">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row17677246203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p22570826203255">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p16297614203255">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row12460805203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p2692305203255">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p16750186203255">The request timed out.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row16533951203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p64181621203255">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p31328812203255">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row13523855203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p21690474203255">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p12097945203255">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row41772644203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p28140973203255">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p64826302203255">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row46565809203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p13734210203255">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p38729264203255">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row13019061203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p47911033203255">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p55588428203255">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214153__row30533812203255"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0078214153__p57319716203255">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0078214153__p12385400203255">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0078214153__section1362310255432"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0078214153__p129821455154315">For details, see <a href="en-us_topic_0022472083.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0020237254.html">VBS Backups</a></div>
</div>
</div>
View Git Blame Copy Permalink