doc-exports/docs/dds/api-ref/dds_api_0035.html
Wang , Deng Ke 60010eb9d0 dds api 2.0.38sp24 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2023-01-13 08:55:41 +00:00

121 lines
8.0 KiB
HTML

<a name="dds_api_0035"></a><a name="dds_api_0035"></a>
<h1 class="topictitle1">Querying Tags in a Specified Project</h1>
<div id="body1547809338881"><div class="section" id="dds_api_0035__section43425134567"><h4 class="sectiontitle">Function</h4><p id="dds_api_0035__p77402137564">This API is used to query all tags of instances in a specified project.</p>
</div>
<div class="section" id="dds_api_0035__section1334491355618"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0035__ul13741151315561"><li id="dds_api_0035__li107415132562">URI format<p id="dds_api_0035__p374161312564"><a name="dds_api_0035__li107415132562"></a><a name="li107415132562"></a>GET https://{Endpoint}/v3/{project_id}/tags</p>
</li><li id="dds_api_0035__li15742151345614">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0035__table13382111355615" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0035__row67421513205611"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0035__p1274221375612">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0035__p1874281310564">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_api_0035__p2775334615440">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0035__row8742101311563"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0035__p97421713155616">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0035__p174261313560">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0035__p674431395614">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0035__section113954130566"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0035__ul2646131443214"><li id="dds_api_0035__li5646121463212">Example request<p id="dds_api_0035__p16143417173213"><a name="dds_api_0035__li5646121463212"></a><a name="li5646121463212"></a>GET https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/tags</p>
</li></ul>
</div>
<div class="section" id="dds_api_0035__section10398161314563"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0035__ul1074419137566"><li id="dds_api_0035__li107441313125618">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0035__table341419136561" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0035__row07446133567"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0035__p1074451310564">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.39%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0035__p5744101319564">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.1%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0035__p6744191314569">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38.12%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0035__p198881228661">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0035__row1074421355618"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0035__p1374491395611">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20.39%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0035__p274461313566">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.1%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0035__p2054763013019">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="38.12%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0035__p1474410132564">Indicates the tag list. For more information, see <a href="#dds_api_0035__table1429181375610">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0035__table1429181375610"></a><a name="table1429181375610"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0035__table1429181375610" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tags field data structure description</caption><thead align="left"><tr id="dds_api_0035__row8744121317563"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="dds_api_0035__p674411136569">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.757924207579244%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="dds_api_0035__p11744201325611">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.367863213678632%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="dds_api_0035__p274411355617">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38.486151384861515%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="dds_api_0035__p1146810321165">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0035__row574516136564"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0035__p2745111375616">key</p>
</td>
<td class="cellrowborder" valign="top" width="20.757924207579244%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0035__p57451513165614">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.367863213678632%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0035__p117451213125613">String</p>
</td>
<td class="cellrowborder" valign="top" width="38.486151384861515%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0035__p6745913125616">Indicates the tag key. The value contains 36 Unicode characters and cannot be blank.</p>
<p id="dds_api_0035__p28901137142810">Character set: 0-9, A-Z, a-z, "_", "-", and "@".</p>
</td>
</tr>
<tr id="dds_api_0035__row10745613125612"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0035__p77451113135613">values</p>
</td>
<td class="cellrowborder" valign="top" width="20.757924207579244%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dds_api_0035__p11745151311565">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.367863213678632%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0035__p1671914211010">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="38.486151384861515%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0035__p8745913135610">Lists the tag values. The value contains a maximum of 43 Unicode characters and can also be an empty string.</p>
<p id="dds_api_0035__p4459434718">Character set: 0-9, A-Z, a-z, "_", "-", and "@".</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dds_api_0035__ul97451513205618"><li id="dds_api_0035__li1174510139563">Response example<pre class="codeblock" id="dds_api_0035__codeblock16405115722911">{
"tags": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
},
{
"key": "key2",
"values": [
"value1",
"value2"
]
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="dds_api_0035__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0035__dds_api_0018_p16131712193312">Status Code:200.</p>
<p id="dds_api_0035__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
</div>
<div class="section" id="dds_api_0035__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0035__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_tag_mgmt.html">Tag Management</a></div>
</div>
</div>