forked from docs/doc-exports
luhuayi
fd5ee5dcd8
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: luhuayi <luhuayi@huawei.com> Co-committed-by: luhuayi <luhuayi@huawei.com>
176 lines
14 KiB
HTML
176 lines
14 KiB
HTML
<a name="EN-US_TOPIC_0000002361491110"></a><a name="EN-US_TOPIC_0000002361491110"></a>
|
|
|
|
<h1 class="topictitle1">Querying Cluster Tags</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002361491110__section766382362914"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002361491110__p1166315235298">This API is used to query the tags of a cluster.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002361491110__section1766492342917"><h4 class="sectiontitle">URI</h4><pre class="screen" id="EN-US_TOPIC_0000002361491110__screen194291644163019">GET /v1.0/{project_id}/clusters/{cluster_id}/tags</pre>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002361491110__table4664923192913" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002361491110__row18664142332918"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000002361491110__p176641723132914">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000002361491110__p106648230295">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000002361491110__p17665823162915">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000002361491110__p19665142332917">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002361491110__row1266482320290"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002361491110__p10665923122919">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002361491110__p1766514234299">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002361491110__p8665123112912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002361491110__p19665132312291"><strong id="EN-US_TOPIC_0000002361491110__b7816644192816">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p3665023112918">Project ID. To obtain the value, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p2066582319296"><strong id="EN-US_TOPIC_0000002361491110__b18333924742515">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p1366542310298">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p106652230297"><strong id="EN-US_TOPIC_0000002361491110__b161730334142520">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p14665142316297">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p10665223112919"><strong id="EN-US_TOPIC_0000002361491110__b193110504042524">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p96659230297">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002361491110__row17664152332920"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002361491110__p2665142314299">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002361491110__p1666514235296">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002361491110__p1066511234298">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002361491110__p166651723172920"><strong id="EN-US_TOPIC_0000002361491110__b15561148202813">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p76651823172911">Cluster ID. To obtain the value, see <a href="dws_02_00068.html">Obtaining the Cluster ID</a>.</p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p17665102382913"><strong id="EN-US_TOPIC_0000002361491110__b168173861742515">Constraints</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p18665023132916">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p18666162392912"><strong id="EN-US_TOPIC_0000002361491110__b83859512242520">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p1566652319291">N/A</p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p3666152342910"><strong id="EN-US_TOPIC_0000002361491110__b211429420442524">Default Value</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p13666223152919">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002361491110__section16666172311291"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002361491110__p96666237297">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002361491110__section1566692392911"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002361491110__p36665239296"><strong id="EN-US_TOPIC_0000002361491110__b61916710742530">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002361491110__en-us_topic_0000002340987906_en-us_topic_0000002340726832_response_ResourceTags" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002361491110__row1666682316294"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000002361491110__p1466672314296">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000002361491110__p766614233293">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000002361491110__p16661323102913">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002361491110__row18666623152911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002361491110__p8666152320299">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002361491110__p116661323192912">Array of <a href="#EN-US_TOPIC_0000002361491110__en-us_topic_0000002340987906_en-us_topic_0000002340726832_response_ResourceTag">ResourceTag</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002361491110__p106671223172918"><strong id="EN-US_TOPIC_0000002361491110__b1255716484288">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p14667123132917">Tag list.</p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p7667172316294"><strong id="EN-US_TOPIC_0000002361491110__b108305509842520">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p7667112311297">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002361491110__en-us_topic_0000002340987906_en-us_topic_0000002340726832_response_ResourceTag"></a><a name="en-us_topic_0000002340987906_en-us_topic_0000002340726832_response_ResourceTag"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002361491110__en-us_topic_0000002340987906_en-us_topic_0000002340726832_response_ResourceTag" frame="border" border="1" rules="all"><caption><b>Table 3 </b>ResourceTag</caption><thead align="left"><tr id="EN-US_TOPIC_0000002361491110__row146671623142913"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000002361491110__p766722352915">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000002361491110__p106679236293">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000002361491110__p26671123122916">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002361491110__row13667023142918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002361491110__p1166718236298">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002361491110__p56676236294">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002361491110__p1166715232292"><strong id="EN-US_TOPIC_0000002361491110__b1955794818281">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p16667132315299">Tag key.</p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p06671323102910"><strong id="EN-US_TOPIC_0000002361491110__b175430459142520">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p1667123182913">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002361491110__row466752362913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002361491110__p266816239291">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002361491110__p10668162372917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002361491110__p666892316290"><strong id="EN-US_TOPIC_0000002361491110__b45581487288">Definition</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p1366882312910">Tag value.</p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p96682234295"><strong id="EN-US_TOPIC_0000002361491110__b87982384442520">Range</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p06681223162914">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002361491110__section9668423102913"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0000002361491110__screen466872318293">GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002361491110__section116681823192911"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002361491110__p16668152313296"><strong id="EN-US_TOPIC_0000002361491110__b7101790242530">Status code: 200</strong></p>
|
|
<p id="EN-US_TOPIC_0000002361491110__p4668323152910">The cluster tags are queried successfully.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000002361491110__screen3668162310299">{
|
|
"tags" : [ {
|
|
"key" : "key",
|
|
"value" : "value"
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002361491110__section18800923162915"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002361491110__en-us_topic_0000002340987906_en-us_topic_0000002340726832_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002361491110__row1067402332914"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000002361491110__p3800123112910">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="EN-US_TOPIC_0000002361491110__p28001236299">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002361491110__row11674923142918"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002361491110__p15800323182912">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002361491110__p1800152320292">The cluster tags are queried successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002361491110__row1767410231292"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002361491110__p19800023142914">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002361491110__p48001823192916">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002361491110__row1067472317297"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002361491110__p17800123202919">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002361491110__p17800202342915">Authorization failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002361491110__row1667462311298"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002361491110__p48001923172912">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002361491110__p178001237297">No operation permission.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002361491110__row8674172352913"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002361491110__p080015234296">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002361491110__p12800152311296">No resources found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002361491110__row176741723112918"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002361491110__p8800623132918">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002361491110__p780062392918">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002361491110__row7674142314295"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002361491110__p680062317295">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002361491110__p108001323172915">Service unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0045.html">Tag Management</a></div>
|
|
</div>
|
|
</div>
|
|
|