forked from docs/doc-exports
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>
111 lines
9.2 KiB
HTML
111 lines
9.2 KiB
HTML
<a name="rds_01_0007"></a><a name="rds_01_0007"></a>
|
||
|
||
<h1 class="topictitle1">Querying a Tag</h1>
|
||
<div id="body8662426"><div class="section" id="rds_01_0007__sea993a330c974061b405ca4661f93d6d"><h4 class="sectiontitle">Function</h4><p id="rds_01_0007__en-us_topic_0091754392_p33831530">This API is used to query the tag associated with a DB instance.</p>
|
||
</div>
|
||
<div class="section" id="rds_01_0007__s9e54b8684a4040539a9725802741a783"><h4 class="sectiontitle">URI</h4><ul id="rds_01_0007__en-us_topic_0091754392_ul55999443"><li id="rds_01_0007__en-us_topic_0091754392_li34232944">URI format<p id="rds_01_0007__en-us_topic_0091754391_p39661040"><a name="rds_01_0007__en-us_topic_0091754392_li34232944"></a><a name="en-us_topic_0091754392_li34232944"></a>PATH: /v1/{project_id}/rds/{instanceId}/tags</p>
|
||
<p id="rds_01_0007__a4dbd7676c864452b86f99f5699304558">Method: GET</p>
|
||
</li><li id="rds_01_0007__en-us_topic_0091754392_li21405046">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0007__en-us_topic_0091754392_table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_01_0007__en-us_topic_0091754392_row1482002"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="rds_01_0007__en-us_topic_0091754392_p52933326"><strong id="rds_01_0007__en-us_topic_0091754392_b84235270691445">Name</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="rds_01_0007__en-us_topic_0091754392_p59740974"><strong id="rds_01_0007__en-us_topic_0091754392_b842352706102346">Mandatory</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="rds_01_0007__en-us_topic_0091754392_p7180698"><strong id="rds_01_0007__en-us_topic_0091754392_b842352706163417">Description</strong></p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="rds_01_0007__en-us_topic_0091754392_row44765691"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_01_0007__en-us_topic_0091754392_p2142393">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_01_0007__en-us_topic_0091754392_p39316155">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_01_0007__en-us_topic_0091754392_p30492010">Specifies the project ID of a tenant in a region.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_01_0007__en-us_topic_0091754392_row5992637"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_01_0007__en-us_topic_0091754392_p15641626">instanceId</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_01_0007__en-us_topic_0091754392_p59012183">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_01_0007__p7417132564016">Specifies the primary node ID of the DB instance.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
<ul id="rds_01_0007__en-us_topic_0091754392_ul27898002"><li id="rds_01_0007__l2b2390b115a1417fbd35a1da8b09776c">Restrictions<p id="rds_01_0007__a73bdf9a740ee4e83973423d8034560d0"><a name="rds_01_0007__l2b2390b115a1417fbd35a1da8b09776c"></a><a name="l2b2390b115a1417fbd35a1da8b09776c"></a>Standby DB instances do not support tag queries.</p>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="rds_01_0007__s299517745d844e4c9b94a601e0b8c6d4"><h4 class="sectiontitle">Request</h4><p id="rds_01_0007__a78cd4c8b809944b39162a4dc954dce53">None</p>
|
||
</div>
|
||
<div class="section" id="rds_01_0007__s368fe6de564946c2b526b9ef768efc16"><h4 class="sectiontitle">Normal Response</h4><ul id="rds_01_0007__en-us_topic_0091754392_ul66273227"><li id="rds_01_0007__en-us_topic_0091754392_li59588135">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0007__tdf9bc68cc7aa4f6c91fa3f68db98f402" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_01_0007__rff0956339a58457fb90f872efb864b95"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_01_0007__ae882aa35f1de435b9a580a075747ee71"><strong id="rds_01_0007__b868697366">Name</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_01_0007__a5771f9cf14ab47ebb4c8d3df3c5f217f"><strong id="rds_01_0007__en-us_topic_0091754392_b842352706164541">Type</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_01_0007__aad9efbdf9d0d43518c9594a21edee6c7"><strong id="rds_01_0007__b498706646">Description</strong></p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="rds_01_0007__rdaedaaefc6ed46c3b614884798b54f88"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_01_0007__ad45f5d9336664a4aad87f123b63f53ff">tags</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_01_0007__a4be451d811c44684b59ce41ae7330957">List data structure. For details, see <a href="#rds_01_0007__t8538b53f8f2141978a5bf8ef5606bf24">Table 3</a>.</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_01_0007__a5ebc1c8bc38a441d81ab753dc2ad7db3">Specifies the tag information.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="rds_01_0007__t8538b53f8f2141978a5bf8ef5606bf24"></a><a name="t8538b53f8f2141978a5bf8ef5606bf24"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_01_0007__t8538b53f8f2141978a5bf8ef5606bf24" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tags field data structure description</caption><thead align="left"><tr id="rds_01_0007__rb6cfe419b44646bd8577bc3ed47eb5b3"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_01_0007__a26202a3b1c294a109b26ad197fee22a9"><strong id="rds_01_0007__b14472580">Name</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_01_0007__a2802be9864364665bbb2ab2e74a6d0b9"><strong id="rds_01_0007__b1203370500">Type</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_01_0007__afc20aa691ea441059d7a6fa3d7c2b242"><strong id="rds_01_0007__b1617532541">Description</strong></p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="rds_01_0007__r7aaef0b8085c44e184efd6a0cc1fc6fc"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0007__a0eac6dd9eec4493e81e7df32833ca631">key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0007__a7463599bd8ce4e089b24dc6c0e87d20b">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0007__ab3ccadae35c840d4a43d7796f3a572cb">Specifies the tag key.</p>
|
||
<p id="rds_01_0007__en-us_topic_0091754392_p223453410469">Its value cannot be empty and must be 1 to 36 Unicode characters in length. It cannot contain nonprintable ASCII characters (0–31) and the following special characters: *<>\=</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_01_0007__r621a8e5a0a674e0b8e1e564d324888cf"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_01_0007__en-us_topic_0091754392_p637211162517">value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_01_0007__ad653997cd2c8467ebf471c9e430f2ab1">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_01_0007__a4be7f42db44c4067833d133e404835f5">Specifies the tag value.</p>
|
||
<p id="rds_01_0007__ad36f13f908504e398a5c843de3beb064">Its value can be empty or 1 to 43 Unicode characters in length. It cannot contain nonprintable ASCII characters (0–31) and the following special characters: *<>\=</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
<ul id="rds_01_0007__en-us_topic_0091754392_ul26818564"><li id="rds_01_0007__en-us_topic_0091754392_li40040492">Response example<pre class="codeblock" id="rds_01_0007__c48f35c3ee4cf4d0bb9486c17036065c7">{
|
||
"tags": [
|
||
{
|
||
"key": "key1",
|
||
"value": "value1"
|
||
},
|
||
{
|
||
"key": "key2",
|
||
"value": "value3"
|
||
}
|
||
]
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="rds_01_0007__sefb698423812481abfe93407238a2012"><h4 class="sectiontitle">Abnormal Response</h4><p id="rds_01_0007__en-us_topic_0091754392_p46896054">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<div class="familylinks">
|
||
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_01_0005.html">Tag Management</a></div>
|
||
</div>
|
||
</div>
|
||
|