doc-exports/docs/vpn/api-ref/en_topic_0093011489.html
gtema 6b71b4a1fa Initial import of the VPN API document
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-12-07 13:22:09 +00:00

97 lines
9.4 KiB
HTML

<a name="en_topic_0093011489"></a><a name="en_topic_0093011489"></a>
<h1 class="topictitle1">Querying VPN Tags in a Specified Project</h1>
<div id="body1538044062050"><div class="section" id="en_topic_0093011489__en-us_topic_0103470571_section159501022015"><h4 class="sectiontitle"><strong id="en_topic_0093011489__en-us_topic_0053740021_b842352706112523">Function</strong></h4><p id="en_topic_0093011489__en-us_topic_0103470571_p11593172017">This interface is used to query all tags of a VPN in a specified region.</p>
</div>
<div class="section" id="en_topic_0093011489__en-us_topic_0103470571_section13950150202019"><h4 class="sectiontitle">URI</h4><p id="en_topic_0093011489__p232016260277">GET /v2.0/{project_id}/ipsec-site-connections/tags</p>
<div class="note" id="en_topic_0093011489__note864225924818"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en_topic_0093011489__p16642125904812">In the URI, <strong id="en_topic_0093011489__b842352706195037">project_id</strong> indicates the project ID.</p>
</div></div>
</div>
<div class="section" id="en_topic_0093011489__en-us_topic_0103470571_section159561804206"><h4 class="sectiontitle">Request Message</h4><p id="en_topic_0093011489__en-us_topic_0103470571_p1861181102012">None</p>
</div>
<div class="section" id="en_topic_0093011489__en-us_topic_0103470571_section4956302200"><h4 class="sectiontitle">Response Message</h4><p id="en_topic_0093011489__p16215417508"><a href="#en_topic_0093011489__en-us_topic_0103470571_table18958160152014">Table 1</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="en_topic_0093011489__en-us_topic_0103470571_table18958160152014"></a><a name="en-us_topic_0103470571_table18958160152014"></a><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011489__en-us_topic_0103470571_table18958160152014" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameter</caption><thead align="left"><tr id="en_topic_0093011489__en-us_topic_0103470571_row106121102012"><th align="left" class="cellrowborder" valign="top" width="25.369999999999997%" id="mcps1.3.4.3.2.4.1.1"><p id="en_topic_0093011489__en-us_topic_0103470571_p14611716203"><strong id="en_topic_0093011489__b842352706172115">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.66%" id="mcps1.3.4.3.2.4.1.2"><p id="en_topic_0093011489__en-us_topic_0103470571_p8613112202"><strong id="en_topic_0093011489__b84235270610412">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.97%" id="mcps1.3.4.3.2.4.1.3"><p id="en_topic_0093011489__en-us_topic_0103470571_p062121192014"><strong id="en_topic_0093011489__b842352706151625">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en_topic_0093011489__en-us_topic_0103470571_row96219162018"><td class="cellrowborder" valign="top" width="25.369999999999997%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en_topic_0093011489__en-us_topic_0103470571_p16624112203">tags</p>
</td>
<td class="cellrowborder" valign="top" width="24.66%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en_topic_0093011489__en-us_topic_0103470571_p146212172016">List&lt;tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="49.97%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en_topic_0093011489__en-us_topic_0103470571_p46214112203">Specifies the tag list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<ul id="en_topic_0093011489__ul186441941419"><li id="en_topic_0093011489__li664719181416">Description of field <strong id="en_topic_0093011489__b84235270695528">tag</strong></li></ul>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en_topic_0093011489__en-us_topic_0103470571_table1696410062019" frame="border" border="1" rules="all"><thead align="left"><tr id="en_topic_0093011489__en-us_topic_0103470571_row16625112015"><th align="left" class="cellrowborder" valign="top" width="25.332533253325334%" id="mcps1.3.4.5.1.4.1.1"><p id="en_topic_0093011489__en-us_topic_0103470571_p156216117208"><strong id="en_topic_0093011489__b84235270617246">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.332533253325334%" id="mcps1.3.4.5.1.4.1.2"><p id="en_topic_0093011489__en-us_topic_0103470571_p8622172014"><strong>Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.33493349334934%" id="mcps1.3.4.5.1.4.1.3"><p id="en_topic_0093011489__en-us_topic_0103470571_p1262101182018"><strong id="en_topic_0093011489__b842352706151625_1">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en_topic_0093011489__en-us_topic_0103470571_row166216192017"><td class="cellrowborder" valign="top" width="25.332533253325334%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en_topic_0093011489__en-us_topic_0103470571_p562013203">key</p>
</td>
<td class="cellrowborder" valign="top" width="25.332533253325334%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en_topic_0093011489__en-us_topic_0103470571_p4621132014">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.33493349334934%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en_topic_0093011489__p3622162019">Specifies the tag key.</p>
<p id="en_topic_0093011489__p10244191781016">The parameter constraints are as follows:</p>
<ul id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_ul2321196023222"><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li400332623222">Cannot be left blank.</li><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li583414621171">Can contain a maximum of 36 characters.</li><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li852157223233">Can contain only the following character types:<ul id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_ul11049850105418"><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li17531722105252">Uppercase letters</li><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li11960040105258">Lowercase letters</li><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li674166910530">Digits</li><li id="en_topic_0093011489__li77869551443">Special characters, including hyphens (-) and underscores (_)</li></ul>
</li></ul>
</td>
</tr>
<tr id="en_topic_0093011489__en-us_topic_0103470571_row862171152012"><td class="cellrowborder" valign="top" width="25.332533253325334%" headers="mcps1.3.4.5.1.4.1.1 "><p id="en_topic_0093011489__en-us_topic_0103470571_p2062312201">values</p>
</td>
<td class="cellrowborder" valign="top" width="25.332533253325334%" headers="mcps1.3.4.5.1.4.1.2 "><p id="en_topic_0093011489__en-us_topic_0103470571_p10628182012">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="49.33493349334934%" headers="mcps1.3.4.5.1.4.1.3 "><p id="en_topic_0093011489__p166210162014">Specifies the tag value list.</p>
<p id="en_topic_0093011489__p12611163291010">The parameter constraints are as follows:</p>
<ul id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_ul6706750105539"><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li3646980211638">Can contain a maximum of 43 characters.</li><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li544437591169">Can contain only the following character types:<ul id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_ul4359364711615"><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li31940902105539">Uppercase letters</li><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li230085105546">Lowercase letters</li><li id="en_topic_0093011489__en-us_topic_0013935842_en-us_topic_0067805752_en-us_topic_0013859511_li41841846105549">Digits</li><li id="en_topic_0093011489__li9376025175919">Special characters, including hyphens (-) and underscores (_)</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en_topic_0093011489__en-us_topic_0103470571_section1897413016206"><h4 class="sectiontitle">Example</h4><ul id="en_topic_0093011489__ul1992012452509"><li id="en_topic_0093011489__li129202450500">Example Request<pre class="screen" id="en_topic_0093011489__screen19627162013">GET /v2.0/{project_id}/ipsec-site-connections/tags</pre>
</li></ul>
</div>
<ul id="en_topic_0093011489__ul51954549501"><li id="en_topic_0093011489__li181958542508">Example Response<pre class="screen" id="en_topic_0093011489__screen1766714214518">{
"tags": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
},
{
"key": "key2",
"values": [
"value1",
"value2"
]
}
]
}</pre>
</li></ul>
<div class="section" id="en_topic_0093011489__section14121248103610"><h4 class="sectiontitle">Returned Values</h4><p id="en_topic_0093011489__p2590175117365">For details, see section <a href="en_topic_0093011522.html">Common Returned Values</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en_topic_0093011483.html">Tag Management</a></div>
</div>
</div>