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_0078214152.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

159 lines
13 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0078214152"></a><a name="EN-US_TOPIC_0078214152"></a>
<h1 class="topictitle1">Canceling Sharing of a Backup</h1>
<div id="body1506308905097"><div class="section" id="EN-US_TOPIC_0078214152__section544019571099"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0078214152__p260315719912">This API is used to cancel the sharing of a backup.</p>
</div>
<div class="section" id="EN-US_TOPIC_0078214152__section13440155715912"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0078214152__ul1360335712919"><li id="EN-US_TOPIC_0078214152__li46031057893">URI format<p id="EN-US_TOPIC_0078214152__p8817115512817"><a name="EN-US_TOPIC_0078214152__li46031057893"></a><a name="li46031057893"></a>DELETE /v2/{project_id}/os-vendor-backup-sharing/{id}</p>
</li><li id="EN-US_TOPIC_0078214152__li560315573919">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0078214152__table1844111577915" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0078214152__row460316570916"><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_0078214152__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_0078214152__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_0078214152__p1254191615916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0078214152__row1160318571791"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p64170449">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__row760419577912"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0078214152__p160410571093">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_0078214152__p10604457494">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_0078214152__p9604057595">Backup ID or backup sharing ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0078214152__ul136041957091"><li id="EN-US_TOPIC_0078214152__li196041357293"><strong id="EN-US_TOPIC_0078214152__b842352706213347">Request filter</strong> parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0078214152__table134501957896" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0078214152__row1260455718919"><th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.2.3.1.2.1.5.1.1"><p id="EN-US_TOPIC_0078214152__p61804813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.189999999999998%" id="mcps1.3.2.3.1.2.1.5.1.2"><p id="EN-US_TOPIC_0078214152__p40133923">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.2.3.1.2.1.5.1.3"><p id="EN-US_TOPIC_0078214152__p14225104112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.51%" id="mcps1.3.2.3.1.2.1.5.1.4"><p id="EN-US_TOPIC_0078214152__p29622330">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0078214152__row1460414575915"><td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0078214152__p26041257992">is_backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.189999999999998%" headers="mcps1.3.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0078214152__p1260465716920">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0078214152__p166046577915">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50.51%" headers="mcps1.3.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0078214152__p16041057199">Whether the ID in the URL is a backup sharing ID or a backup ID. The value <strong id="EN-US_TOPIC_0078214152__b84235270672643">true</strong> indicates a backup ID, and all backup sharings of this backup will be canceled. The value <strong id="EN-US_TOPIC_0078214152__b842352706172833">false</strong> indicates a backup sharing ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0078214152__li23960570162236">Example request<pre class="screen" id="EN-US_TOPIC_0078214152__screen5589539210132">Canceling a specific backup sharing:
DELETE /v2/{project_id}/os-vendor-backup-sharing/e842bf23-1e05-4c2c-b0f9-25222f4686da
Canceling sharing of a backup:
DELETE /v2/{project_id}/os-vendor-backup-sharing</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0078214152__section34568571495"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0078214152__p3605185713910">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0078214152__section045619572090"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0078214152__p14605757895">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0078214152__section64561557197"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0078214152__ul166051571496"><li id="EN-US_TOPIC_0078214152__li3605155715914">Normal<p id="EN-US_TOPIC_0078214152__p1160520571694"><a name="EN-US_TOPIC_0078214152__li3605155715914"></a><a name="li3605155715914"></a>200</p>
</li><li id="EN-US_TOPIC_0078214152__li15605205718919">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0078214152__table59178184203255" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p4888452203255">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p5502113203255">The server failed to process the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p20275713203255">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p38456209203255">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p38071718203255">The server could not find the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p17070685203255">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p31790300203255">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p16297614203255">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p16750186203255">The request timed out.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p31328812203255">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p12097945203255">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p64826302203255">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p38729264203255">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p55588428203255">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0078214152__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_0078214152__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_0078214152__p12385400203255">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0078214152__section1362310255432"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0078214152__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