vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/csbs/api-ref/en-us_topic_0098635097.html
Wei, Hongmin 8ce662c4dc CSBS 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-24 21:06:50 +00:00

204 lines
14 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0098635097"></a><a name="EN-US_TOPIC_0098635097"></a>
<h1 class="topictitle1">Querying Backup Policy Tags of a Project</h1>
<div id="body1519724141416"><div class="section" id="EN-US_TOPIC_0098635097__section66080062"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="EN-US_TOPIC_0098635097__p36189605">This API is used to query a tenant's tag set in a specific region and of a specific resource type.</p>
<p class="msonormal" id="EN-US_TOPIC_0098635097__p57270992">TMS uses this API to list tags created by a tenant to facilitate tag creation and resource filtering on the console.</p>
</div>
<div class="section" id="EN-US_TOPIC_0098635097__section57849650"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0098635097__ul8438801"><li id="EN-US_TOPIC_0098635097__li8840353">URI format<p id="EN-US_TOPIC_0098635097__p12454319"><a name="EN-US_TOPIC_0098635097__li8840353"></a><a name="li8840353"></a>GET https://{endpoint}/v1/{project_id}/csbs_backup_policy/tags</p>
</li><li id="EN-US_TOPIC_0098635097__li44980012">Request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635097__table2166929" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header</caption><thead align="left"><tr id="EN-US_TOPIC_0098635097__row65022077"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0098635097__p209623317216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0098635097__p15962193221">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0098635097__p99783315213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0098635097__p6978835213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635097__row6053677"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635097__p20585813">Content-type</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635097__p33411215287">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635097__p56838133">MIME type of the body in the request</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635097__p58146239">application/json</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635097__row53554111"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635097__p42915720">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635097__p233917151284">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635097__p53621294">User token</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635097__p24645678">-</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0098635097__ul48633258"><li id="EN-US_TOPIC_0098635097__li35046145">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635097__table46979855" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635097__row34292765"><th align="left" class="cellrowborder" valign="top" width="25.252525252525253%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="EN-US_TOPIC_0098635097__p16803133832618">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.151515151515152%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="EN-US_TOPIC_0098635097__p1380316381266">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="EN-US_TOPIC_0098635097__p281913872612">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.45454545454546%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="EN-US_TOPIC_0098635097__p5819103802617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635097__row4089365"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635097__p62803112">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635097__p53887349">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635097__p2799138">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635097__p65779720">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635097__section50884809"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0098635097__ul24432171"><li id="EN-US_TOPIC_0098635097__li18562954">Parameter description</li></ul>
<p class="msonormal" id="EN-US_TOPIC_0098635097__p32848863">None</p>
<ul id="EN-US_TOPIC_0098635097__ul27204315"><li id="EN-US_TOPIC_0098635097__li43512247">Example request<pre class="screen" id="EN-US_TOPIC_0098635097__screen829184220338">GET https://{endpoint}/v1/{project_id}/csbs_backup_policy/tags</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635097__section55310098"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0098635097__ul45044734"><li id="EN-US_TOPIC_0098635097__li2749429">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635097__table22647000" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635097__row39481153"><th align="left" class="cellrowborder" valign="top" width="29.409999999999997%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0098635097__p167251543142614">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.470000000000002%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0098635097__p172574302613">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.120000000000005%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0098635097__p197251743132614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635097__row14925917"><td class="cellrowborder" valign="top" width="29.409999999999997%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0098635097__p1039755">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0098635097__p17111334">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="54.120000000000005%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0098635097__p43840789">Tag list</p>
<p id="EN-US_TOPIC_0098635097__p10226451664">Keys in the tag list must be unique.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635097__li1362691">Parameter description of field <strong id="EN-US_TOPIC_0098635097__b84235270695528">tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635097__table61443009" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635097__b1011316511222">tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635097__row39972798"><th align="left" class="cellrowborder" valign="top" width="29.409999999999997%" id="mcps1.3.4.2.2.2.2.4.1.1"><p id="EN-US_TOPIC_0098635097__p534912527262">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.470000000000002%" id="mcps1.3.4.2.2.2.2.4.1.2"><p id="EN-US_TOPIC_0098635097__p183491152122620">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.120000000000005%" id="mcps1.3.4.2.2.2.2.4.1.3"><p id="EN-US_TOPIC_0098635097__p163498528263">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635097__row9701936"><td class="cellrowborder" valign="top" width="29.409999999999997%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635097__p47659360">key</p>
</td>
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635097__p35202932">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.120000000000005%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635097__p32865237">Tag key</p>
<p id="EN-US_TOPIC_0098635097__p7327206587">It consists of up to 36 characters.</p>
<p id="EN-US_TOPIC_0098635097__p145821075819">It cannot be an empty string.</p>
<p id="EN-US_TOPIC_0098635097__p14766132412516">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635097__row27351677"><td class="cellrowborder" valign="top" width="29.409999999999997%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0098635097__p893371">values</p>
</td>
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0098635097__p5254266">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="54.120000000000005%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0098635097__p22942434">List of tag values</p>
<p id="EN-US_TOPIC_0098635097__p8808725135910">It consists of up to 43 characters.</p>
<p id="EN-US_TOPIC_0098635097__p919321595">It can be an empty string.</p>
<p id="EN-US_TOPIC_0098635097__p521018152360">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635097__li52497183">Example response<pre class="screen" id="EN-US_TOPIC_0098635097__screen91601254153313">{
"tags": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
},
{
"key": "key2",
"values": [
"value1",
"value2"
]
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635097__section28028840"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0098635097__ul52283348"><li id="EN-US_TOPIC_0098635097__li788091">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635097__table7092825" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635097__row64957389"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="EN-US_TOPIC_0098635097__p27057175">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="EN-US_TOPIC_0098635097__p44147557">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635097__row19182368"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635097__p10267951">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635097__p26397691">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635097__li36252627">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635097__table57838187" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635097__row49915680"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0098635097__p16638299">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0098635097__p5524991">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635097__row44871090"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635097__p10679711">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635097__p59750252">Invalid parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635097__row881358"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635097__p4281167">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635097__p11230212">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635097__row33963045"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635097__p66652164">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635097__p30116236">You do not have permission to perform this operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635097__row2610670"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635097__p10137733">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635097__p15850073">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635097__row8432933"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635097__p11978974">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635097__p30772872">A system exception occurs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635097__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0098635097__p999593594811">For details, see <a href="en-us_topic_0071888297.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0098466174.html">Tag Management</a></div>
</div>
</div>
View Git Blame Copy Permalink