forked from docs/doc-exports
Wei, Hongmin
8ce662c4dc
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
204 lines
14 KiB
HTML
204 lines
14 KiB
HTML
<a name="EN-US_TOPIC_0098635091"></a><a name="EN-US_TOPIC_0098635091"></a>
|
|
|
|
<h1 class="topictitle1">Querying Backup Tags of a Project</h1>
|
|
<div id="body1519724141393"><div class="section" id="EN-US_TOPIC_0098635091__section43678285"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="EN-US_TOPIC_0098635091__p25533156">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_0098635091__p28471820">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_0098635091__section57560251"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0098635091__ul24516103"><li id="EN-US_TOPIC_0098635091__li19318340">URI format<p id="EN-US_TOPIC_0098635091__p39647339"><a name="EN-US_TOPIC_0098635091__li19318340"></a><a name="li19318340"></a>GET https://{endpoint}/v1/{project_id}/csbs_backup/tags</p>
|
|
</li><li id="EN-US_TOPIC_0098635091__li21281731">Request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635091__table57317854" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header</caption><thead align="left"><tr id="EN-US_TOPIC_0098635091__row16062491"><th align="left" class="cellrowborder" valign="top" width="24.752475247524753%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0098635091__p209623317216">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0098635091__p15962193221">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0098635091__p99783315213">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.54455445544555%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0098635091__p6978835213">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0098635091__row18787345"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635091__p45380005">Content-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635091__p639019461246">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635091__p51901789">MIME type of the body in the request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635091__p17266011">application/json</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0098635091__row21176375"><td class="cellrowborder" valign="top" width="24.752475247524753%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635091__p37564794">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635091__p14388146944">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635091__p22849445">User token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.54455445544555%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635091__p61118933">-</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0098635091__ul62525952"><li id="EN-US_TOPIC_0098635091__li25862664">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635091__table31437385" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635091__row54135154"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="EN-US_TOPIC_0098635091__p131182811236">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="EN-US_TOPIC_0098635091__p412281238">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="EN-US_TOPIC_0098635091__p191192822317">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="EN-US_TOPIC_0098635091__p1217928162315">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0098635091__row29261955"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635091__p21408163">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635091__p56339623">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635091__p106744">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635091__p65779720">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0098635091__section48280214"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0098635091__ul56636150"><li id="EN-US_TOPIC_0098635091__li39963306">Parameter description<p class="msonormal" id="EN-US_TOPIC_0098635091__p4827133341219"><a name="EN-US_TOPIC_0098635091__li39963306"></a><a name="li39963306"></a>None</p>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0098635091__ul15802367"><li id="EN-US_TOPIC_0098635091__li8003577">Example request<pre class="screen" id="EN-US_TOPIC_0098635091__screen36115143016">GET https://{endpoint}/v1/{project_id}/csbs_backup/tags</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0098635091__section31868743"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0098635091__ul63245934"><li id="EN-US_TOPIC_0098635091__li32342495">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635091__table22647000" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635091__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_0098635091__p111763222313">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_0098635091__p517153214237">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_0098635091__p51773292320">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0098635091__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_0098635091__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_0098635091__p17111334">List<tag></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_0098635091__p43840789">Tag list</p>
|
|
<p id="EN-US_TOPIC_0098635091__p35151347750">Keys in the tag list must be unique.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0098635091__li59022784">Parameter description of field <strong id="EN-US_TOPIC_0098635091__b84235270695528">tag</strong>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635091__table61443009" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field <strong id="EN-US_TOPIC_0098635091__b21781520192015">tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0098635091__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_0098635091__p434518458234">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_0098635091__p3345144562316">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_0098635091__p33451245132318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0098635091__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_0098635091__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_0098635091__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_0098635091__p32865237">Tag key</p>
|
|
<p id="EN-US_TOPIC_0098635091__p7327206587">It consists of up to 36 characters.</p>
|
|
<p id="EN-US_TOPIC_0098635091__p145821075819">It cannot be an empty string.</p>
|
|
<p id="EN-US_TOPIC_0098635091__p14766132412516">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0098635091__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_0098635091__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_0098635091__p5254266">List<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_0098635091__p22942434">List of tag values</p>
|
|
<p id="EN-US_TOPIC_0098635091__p8808725135910">It consists of up to 43 characters.</p>
|
|
<p id="EN-US_TOPIC_0098635091__p919321595">It can be an empty string.</p>
|
|
<p id="EN-US_TOPIC_0098635091__p163811127183219">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0098635091__li46397850">Example response<pre class="screen" id="EN-US_TOPIC_0098635091__screen237431113118">{
|
|
"tags": [
|
|
{
|
|
"key": "key1",
|
|
"values": [
|
|
"value1",
|
|
"value2"
|
|
]
|
|
},
|
|
{
|
|
"key": "key2",
|
|
"values": [
|
|
"value1",
|
|
"value2"
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0098635091__section18383231"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0098635091__ul48891802"><li id="EN-US_TOPIC_0098635091__li37373042">Normal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635091__table813059" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635091__row27516461"><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_0098635091__p14240860">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_0098635091__p12659036">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0098635091__row18749013"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635091__p42275054">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_0098635091__p1727311">OK</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0098635091__li15545802">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635091__table5694497" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635091__row38964203"><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_0098635091__p1983898">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_0098635091__p26478045">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0098635091__row64346909"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635091__p44717121">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_0098635091__p65317042">Invalid parameters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0098635091__row50982466"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635091__p35939088">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_0098635091__p25385055">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0098635091__row27138911"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635091__p50768145">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_0098635091__p18579096">You do not have permission to perform this operation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0098635091__row32994143"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635091__p55279936">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_0098635091__p48489833">The requested resource was not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0098635091__row33755321"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635091__p49826466">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_0098635091__p9411944">A system exception occurs.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0098635091__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0098635091__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>
|
|
|