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

198 lines
14 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0067142130"></a><a name="EN-US_TOPIC_0067142130"></a>
<h1 class="topictitle1">Querying All Backup Policy Tags</h1>
<div id="body1500448542447"><div class="section" id="EN-US_TOPIC_0067142130__section63962185"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0067142130__p23236933">This API is used to query tags of all backup policies.</p>
</div>
<div class="section" id="EN-US_TOPIC_0067142130__section38788755"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0067142130__ul3143429"><li id="EN-US_TOPIC_0067142130__li28290863">URI format<p id="EN-US_TOPIC_0067142130__p9858548"><a name="EN-US_TOPIC_0067142130__li28290863"></a><a name="li28290863"></a>GET /v2/{project_id}/backuppolicy/tags</p>
</li><li id="EN-US_TOPIC_0067142130__li21618074">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0067142130__table60344938" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0067142130__row59011071"><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_0067142130__p15167431">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_0067142130__p20602375">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_0067142130__p58179688">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0067142130__row14934289"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142130__p1717931">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_0067142130__p4934750">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_0067142130__p64170449">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0067142130__li23960570162236">Example request<pre class="screen" id="EN-US_TOPIC_0067142130__screen5589539210132">GET /v2/{project_id}/backuppolicy/tags</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0067142130__section13554483"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0067142130__p46526530153034">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0067142130__section54881489"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0067142130__ul20896204"><li id="EN-US_TOPIC_0067142130__li2520711120254">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0067142130__table2553741120254" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0067142130__row84520220254"><th align="left" class="cellrowborder" valign="top" width="25.842584258425845%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0067142130__p1431817452527">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.342034203420344%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0067142130__p14225104112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.815381538153815%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0067142130__p29622330">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0067142130__row894248020254"><td class="cellrowborder" valign="top" width="25.842584258425845%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142130__p34048608151944">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20.342034203420344%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142130__p4563373217131">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.815381538153815%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142130__p1948402220254">List of tag details</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row15240089153211"><td class="cellrowborder" valign="top" width="25.842584258425845%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142130__p42050300153340">key</p>
</td>
<td class="cellrowborder" valign="top" width="20.342034203420344%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142130__p7483329153340">string</p>
</td>
<td class="cellrowborder" valign="top" width="53.815381538153815%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142130__p2169918153340">Tag key</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row49142966153315"><td class="cellrowborder" valign="top" width="25.842584258425845%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142130__p38366875153340">values</p>
</td>
<td class="cellrowborder" valign="top" width="20.342034203420344%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142130__p66829450153340">list&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.815381538153815%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142130__p1076418181925">List of tag values</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row4113847020254"><td class="cellrowborder" valign="top" width="25.842584258425845%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142130__p4388173520254">message</p>
</td>
<td class="cellrowborder" valign="top" width="20.342034203420344%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142130__p534483917131">string</p>
</td>
<td class="cellrowborder" valign="top" width="53.815381538153815%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142130__p1103955520254">Error message returned after an error occurs</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row3224713720254"><td class="cellrowborder" valign="top" width="25.842584258425845%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0067142130__p6188131520254">code</p>
</td>
<td class="cellrowborder" valign="top" width="20.342034203420344%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0067142130__p3027879417131">string</p>
</td>
<td class="cellrowborder" valign="top" width="53.815381538153815%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0067142130__p6179451720254">Error code returned after an error occurs</p>
<p id="EN-US_TOPIC_0067142130__p1927974620254">For details about error codes, see <a href="en-us_topic_0022472083.html">Error Codes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0067142130__li53848109">Example response<pre class="screen" id="EN-US_TOPIC_0067142130__screen1930569315384">{
"tags": [
{
"key": "RUNNING",
"values":[
"0781095c-b8ab-4ce5-99f3-4c5f6ff75319",
"2016-12-03T06:24:34.467"
]
},
{
"key": "WAITING",
"values":[
"0781095c-b8ab-4ce5-99f3-4c5f6ff75319",
"2016-12-03T06:24:34.467"
]
}
]
}</pre>
<p id="EN-US_TOPIC_0067142130__p36388601">or</p>
<pre class="screen" id="EN-US_TOPIC_0067142130__screen20692691101149">{
"error": {
"code": "XXXX",
"message": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0067142130__section24171358"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0067142130__ul59834015"><li id="EN-US_TOPIC_0067142130__li1635228">Normal<p id="EN-US_TOPIC_0067142130__p14717055"><a name="EN-US_TOPIC_0067142130__li1635228"></a><a name="li1635228"></a>200</p>
</li><li id="EN-US_TOPIC_0067142130__li65344633">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0067142130__table51230787" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0067142130__row60503138"><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_0067142130__p1807185">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_0067142130__p12164329">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0067142130__row45786577"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p17725233">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_0067142130__p26457778">The server failed to process the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row36793414"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p27476571">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_0067142130__p11009764">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row31979016"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p40163483">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_0067142130__p32016662">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row4499052116376"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p2035357816376">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_0067142130__p3802708716376">The server could not find the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row8462523163725"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p14375766163725">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_0067142130__p23586373163725">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row60343628163758"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p55995701163758">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_0067142130__p39357967163758">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row32079544163754"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p48306260163754">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_0067142130__p20492948163754">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row28680770163738"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p41441040163738">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_0067142130__p1281119163738">The request timed out.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row65552906164354"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p8185203164354">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_0067142130__p59021712164354">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row19714506"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p53371190">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_0067142130__p28099101">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row32688750164938"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p30543097164938">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_0067142130__p58071768164938">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row11809518164943"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p17046908164943">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_0067142130__p38622347164943">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row38399341164956"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p23338889164956">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_0067142130__p11401882164956">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0067142130__row51565323"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0067142130__p16041657">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_0067142130__p24305815">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0067142130__section1362310255432"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0067142130__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_0043410516.html">Backup Policies</a></div>
</div>
</div>
View Git Blame Copy Permalink