vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/deh/api-ref/deh_05_0904.html
Zaoxu, Li bcdc2ecfaa DEH API update1026 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-01-12 14:27:11 +00:00

348 lines
31 KiB
HTML
Raw Blame History

<a name="deh_05_0904"></a><a name="deh_05_0904"></a>
<h1 class="topictitle1">Querying DeHs by Tag</h1>
<div id="body1539073522350"><div class="section" id="deh_05_0904__section54478915181842"><h4 class="sectiontitle">Function</h4><ul id="deh_05_0904__ul246771516486"><li id="deh_05_0904__li946771511489">This API is used to filter DeHs by tag and return the list of all tags of a DeH.</li></ul>
<ul id="deh_05_0904__ul319691018485"><li id="deh_05_0904__li1519613108481">Tag Management Service (TMS) uses this API to filter the DeHs.</li></ul>
</div>
<div class="section" id="deh_05_0904__en-us_topic_0057972838_section58912114"><h4 class="sectiontitle">URI</h4><p id="deh_05_0904__p192281042152817">POST /v1.0/{project_id}/dedicated-host-tags/resource_instances/action</p>
<p id="deh_05_0904__p85561546144316"><a href="#deh_05_0904__table291625114015">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="deh_05_0904__table291625114015"></a><a name="table291625114015"></a><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0904__table291625114015" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters description</caption><thead align="left"><tr id="deh_05_0904__row291610574011"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="deh_05_0904__p1467218184410"><strong id="deh_05_0904__b842352706114331">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.2"><p id="deh_05_0904__p0675111204414"><strong id="deh_05_0904__b16105191614456">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.3"><p id="deh_05_0904__p69548610432"><strong id="deh_05_0904__b234225413538">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.4"><p id="deh_05_0904__p19679111448"><strong id="deh_05_0904__b8423527069506">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="deh_05_0904__row69161956409"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="deh_05_0904__p126868117449">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="deh_05_0904__p1688101174411">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="deh_05_0904__p59527664313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="deh_05_0904__p1969317113442">Specifies the project ID.</p>
<p id="deh_05_0904__p7376194915119">For details about how to obtain the project ID, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328009.html" target="_blank" rel="noopener noreferrer">Obtaining Required Information</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="deh_05_0904__en-us_topic_0057972838_section60446980"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0904__table843612104917" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="deh_05_0904__row244181210491"><th align="left" class="cellrowborder" valign="top" width="15.809999999999999%" id="mcps1.3.3.2.2.5.1.1"><p id="deh_05_0904__p5586121045011"><strong id="deh_05_0904__b1135875625411">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.98%" id="mcps1.3.3.2.2.5.1.2"><p id="deh_05_0904__p1158619105502"><strong id="deh_05_0904__b1426605211">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.86%" id="mcps1.3.3.2.2.5.1.3"><p id="deh_05_0904__p458621013502"><strong id="deh_05_0904__b1728839315">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.35%" id="mcps1.3.3.2.2.5.1.4"><p id="deh_05_0904__p3586181013506"><strong id="deh_05_0904__b101721455554">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="deh_05_0904__row344141264915"><td class="cellrowborder" valign="top" width="15.809999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="deh_05_0904__p75864109503">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.3.2.2.5.1.2 "><p id="deh_05_0904__p19586910135015">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.3.2.2.5.1.3 "><p id="deh_05_0904__p15586161025015">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.35%" headers="mcps1.3.3.2.2.5.1.4 "><p id="deh_05_0904__p1232923518116">Displays all DeHs with specified tags. For more information, see <a href="#deh_05_0904__table1646113155613">Table 3</a>.</p>
<ul id="deh_05_0904__ul458681075011"><li id="deh_05_0904__li155868107505">A maximum of 10 keys can be included. Each key can have a maximum of 10 values.</li><li id="deh_05_0904__li145872103509">The structure body must be included.</li><li id="deh_05_0904__li16587110155010">The tag key cannot be left blank or set to an empty string.</li><li id="deh_05_0904__li11587110135015">A key must be unique.</li><li id="deh_05_0904__li145871104505">Values of the same key must be unique.</li></ul>
</td>
</tr>
<tr id="deh_05_0904__row1544161219498"><td class="cellrowborder" valign="top" width="15.809999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="deh_05_0904__p1658711016504">not_tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.3.2.2.5.1.2 "><p id="deh_05_0904__p2587111012502">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.3.2.2.5.1.3 "><p id="deh_05_0904__p20587161085015">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.35%" headers="mcps1.3.3.2.2.5.1.4 "><p id="deh_05_0904__p858701075017">Displays the DeHs with none of specified tags. For more information, see <a href="#deh_05_0904__table1646113155613">Table 3</a>.</p>
<ul id="deh_05_0904__ul05878108507"><li id="deh_05_0904__li1458711015505">A maximum of 10 keys can be included. Each key can have a maximum of 10 values.</li><li id="deh_05_0904__li11587181095013">The structure body must be included.</li><li id="deh_05_0904__li758716105506">The tag key cannot be left blank or set to an empty string.</li><li id="deh_05_0904__li105874106509">Keys must be unique.</li><li id="deh_05_0904__li658791075012">Values of the same key must be unique.</li></ul>
</td>
</tr>
<tr id="deh_05_0904__row9451312104916"><td class="cellrowborder" valign="top" width="15.809999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="deh_05_0904__p8587101085013">limit</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.3.2.2.5.1.2 "><p id="deh_05_0904__p1677612537565">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.3.2.2.5.1.3 "><p id="deh_05_0904__p7588121015509">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.35%" headers="mcps1.3.3.2.2.5.1.4 "><p id="deh_05_0904__p7588181015506">Limits the maximum number of queried DeHs. The value cannot be a negative number. The maximum value is 1000.</p>
<ul id="deh_05_0904__ul35881510195011"><li id="deh_05_0904__li458815103501">If the <strong id="deh_05_0904__b54610817215">action</strong> value is <strong id="deh_05_0904__b74611882217">count</strong>, this parameter is invalid.</li><li id="deh_05_0904__li85886105501">If the <strong id="deh_05_0904__b5610131117213">action</strong> value is <strong id="deh_05_0904__b1361118118211">filter</strong>, the default value is <strong id="deh_05_0904__b16612011229">1000</strong>.</li></ul>
</td>
</tr>
<tr id="deh_05_0904__row1845111294918"><td class="cellrowborder" valign="top" width="15.809999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="deh_05_0904__p1158812108501">offset</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.3.2.2.5.1.2 "><p id="deh_05_0904__p279195325619">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.3.2.2.5.1.3 "><p id="deh_05_0904__p958881016505">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.35%" headers="mcps1.3.3.2.2.5.1.4 "><p id="deh_05_0904__p19588161005016">Specifies the index position. The query starts from the next piece of data indexed by this parameter. The value must be a non-negative number.</p>
<p id="deh_05_0904__p11588510185019">You do not need to specify this parameter when querying resources on the first page. When you query resources on subsequent pages, set the value of <strong id="deh_05_0904__b842352706101324">offset</strong> to the location returned in the response body for the previous query.</p>
<ul id="deh_05_0904__ul15884105506"><li id="deh_05_0904__li175881010175017">If the <strong id="deh_05_0904__b98590351727">action</strong> value is <strong id="deh_05_0904__b1485933512212">count</strong>, this parameter is invalid.</li><li id="deh_05_0904__li16588191014500">If the <strong id="deh_05_0904__b6862103716213">action</strong> value is <strong id="deh_05_0904__b78631637422">filter</strong>, the default value is <strong id="deh_05_0904__b1686417371829">0</strong>.</li></ul>
</td>
</tr>
<tr id="deh_05_0904__row104561213497"><td class="cellrowborder" valign="top" width="15.809999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="deh_05_0904__p15588121020505">action</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.3.2.2.5.1.2 "><p id="deh_05_0904__p858861013505">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.3.2.2.5.1.3 "><p id="deh_05_0904__p105881610105015">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.35%" headers="mcps1.3.3.2.2.5.1.4 "><p id="deh_05_0904__p058813101506">Specifies the operation, which can be <strong id="deh_05_0904__b126481841128">filter</strong> or <strong id="deh_05_0904__b1064918411217">count</strong>.</p>
<ul id="deh_05_0904__ul15882010195017"><li id="deh_05_0904__li7588121011509"><strong id="deh_05_0904__b1088116569219">filter</strong>: Filters DeHs by tag and lists DeHs that meet the search criteria. Listed DeHs are queried by page.</li><li id="deh_05_0904__li1258871020509"><strong id="deh_05_0904__b24628511466">count</strong>: Searches for DeHs by tag and returns the number of DeHs that meet the search criteria.</li></ul>
</td>
</tr>
<tr id="deh_05_0904__row5458122498"><td class="cellrowborder" valign="top" width="15.809999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="deh_05_0904__p19588141065014">tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.3.2.2.5.1.2 "><p id="deh_05_0904__p145880107503">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.3.2.2.5.1.3 "><p id="deh_05_0904__p205881510135014">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.35%" headers="mcps1.3.3.2.2.5.1.4 "><p id="deh_05_0904__p8588610195011">Includes any of the specified tags. For more information, see <a href="#deh_05_0904__table1646113155613">Table 3</a>.</p>
<ul id="deh_05_0904__ul55883107506"><li id="deh_05_0904__li2588191035010">This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing.</li><li id="deh_05_0904__li145891710135015">Each key must be unique, and cannot contain duplicate values.</li><li id="deh_05_0904__li2589101015017">The response returns resources containing the tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship.</li><li id="deh_05_0904__li1358941018508">If no tag filtering condition is specified, full data is returned.</li></ul>
</td>
</tr>
<tr id="deh_05_0904__row12451812164915"><td class="cellrowborder" valign="top" width="15.809999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="deh_05_0904__p15589161019506">not_tags_any</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.3.2.2.5.1.2 "><p id="deh_05_0904__p1158911055016">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.3.2.2.5.1.3 "><p id="deh_05_0904__p105891410125019">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.35%" headers="mcps1.3.3.2.2.5.1.4 "><p id="deh_05_0904__p10589121075012">Excludes any of the specified tags. For more information, see <a href="#deh_05_0904__table1646113155613">Table 3</a>.</p>
<ul id="deh_05_0904__ul058971095010"><li id="deh_05_0904__li758901020509">This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing.</li><li id="deh_05_0904__li10589101018503">Each key must be unique, and cannot contain duplicate values.</li><li id="deh_05_0904__li35891910135013">The response returns resources containing no tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship.</li><li id="deh_05_0904__li15589121017509">If no tag filtering condition is specified, full data is returned.</li></ul>
</td>
</tr>
<tr id="deh_05_0904__row945171274911"><td class="cellrowborder" valign="top" width="15.809999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="deh_05_0904__p8589610165011">matches</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.3.2.2.5.1.2 "><p id="deh_05_0904__p1258961035010">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="11.86%" headers="mcps1.3.3.2.2.5.1.3 "><p id="deh_05_0904__p7589910155010">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.35%" headers="mcps1.3.3.2.2.5.1.4 "><p id="deh_05_0904__p17589131012505">Specifies the search field, which is used to search for DeHs by condition.</p>
<p id="deh_05_0904__p17589191015010">Currently, only <strong id="deh_05_0904__b842352706154915">resource_name</strong> can be used for search. For more information, see <a href="#deh_05_0904__table159211739175717">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="deh_05_0904__table1646113155613"></a><a name="table1646113155613"></a><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0904__table1646113155613" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="deh_05_0904__b84235270695528">tag</strong> field description</caption><thead align="left"><tr id="deh_05_0904__row3646181317563"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.5.1.1"><p id="deh_05_0904__p193667812308"><strong id="deh_05_0904__b83821019171316">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.5.1.2"><p id="deh_05_0904__p193660817301"><strong id="deh_05_0904__b529852415132">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="deh_05_0904__p1510994524610"><strong id="deh_05_0904__b106061225121312">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42%" id="mcps1.3.3.3.2.5.1.4"><p id="deh_05_0904__p936614813309"><strong id="deh_05_0904__b1574752721310">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="deh_05_0904__row764691365618"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.5.1.1 "><p id="deh_05_0904__p193669863019">key</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.5.1.2 "><p id="deh_05_0904__p13686816306">String</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="deh_05_0904__p20109164504610">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.3.2.5.1.4 "><p id="deh_05_0904__p33688823011">Specifies the tag key.</p>
<ul id="deh_05_0904__ul1336819883017"><li id="deh_05_0904__li336816819307">It contains a maximum of 127 Unicode characters.</li><li id="deh_05_0904__li1368482304">This field cannot be left blank.</li></ul>
</td>
</tr>
<tr id="deh_05_0904__row5646191345618"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.5.1.1 "><p id="deh_05_0904__p336828123019">values</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.5.1.2 "><p id="deh_05_0904__p2368187304">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="deh_05_0904__p16841445164614">No</p>
</td>
<td class="cellrowborder" valign="top" width="42%" headers="mcps1.3.3.3.2.5.1.4 "><p id="deh_05_0904__p113681981304">Specifies the tag values.</p>
<ul id="deh_05_0904__ul1436815817303"><li id="deh_05_0904__li9368889306">Each tag contains a maximum of 10 values.</li><li id="deh_05_0904__li133681284302">Values of the same tag must be unique.</li><li id="deh_05_0904__li143689817307">Each value can contain a maximum of 255 Unicode characters.</li><li id="deh_05_0904__li736838103016">If this parameter is not specified, any value can be used.</li><li id="deh_05_0904__li19368387309">The resources containing one or more values listed in <strong id="deh_05_0904__b166801975155">values</strong> will be found and displayed.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="deh_05_0904__table159211739175717"></a><a name="table159211739175717"></a><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0904__table159211739175717" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="deh_05_0904__b1437033914514">match</strong> field description</caption><thead align="left"><tr id="deh_05_0904__row11922039105715"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.3.4.2.5.1.1"><p id="deh_05_0904__p10699148114717"><strong id="deh_05_0904__b17356119181512">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.3.4.2.5.1.2"><p id="deh_05_0904__p197027814717"><strong id="deh_05_0904__b195891420111517">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.3.4.2.5.1.3"><p id="deh_05_0904__p870510824713"><strong id="deh_05_0904__b6605821181515">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.41414141414141%" id="mcps1.3.3.4.2.5.1.4"><p id="deh_05_0904__p157094824715"><strong id="deh_05_0904__b8606202213154">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="deh_05_0904__row14922123918578"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="deh_05_0904__p3434656203016">key</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.4.2.5.1.2 "><p id="deh_05_0904__p1434155619301">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.3 "><p id="deh_05_0904__p754201411474">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="41.41414141414141%" headers="mcps1.3.3.4.2.5.1.4 "><p id="deh_05_0904__p1643415618307">Specifies the key parameter to be matched.</p>
<ul id="deh_05_0904__ul1043435643020"><li id="deh_05_0904__li843455653010">The key must be unique, and the value is used for matching.</li><li id="deh_05_0904__li114346569308">The <strong id="deh_05_0904__b10991315962239">key</strong> field is a fixed dictionary value.</li><li id="deh_05_0904__li15434145615305">This field cannot be left blank.</li></ul>
<div class="note" id="deh_05_0904__note436011568305"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="deh_05_0904__p543675653013">The parameter value can only be <strong id="deh_05_0904__b842352706172034">resource_name</strong>, which is the DeH name.</p>
</div></div>
</td>
</tr>
<tr id="deh_05_0904__row99221939105717"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.4.2.5.1.1 "><p id="deh_05_0904__p1143645613018">value</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.4.2.5.1.2 "><p id="deh_05_0904__p10436956153014">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.3 "><p id="deh_05_0904__p1853161464718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="41.41414141414141%" headers="mcps1.3.3.4.2.5.1.4 "><p id="deh_05_0904__p1443615562303">Specifies the tag value.</p>
<ul id="deh_05_0904__ul1643610561302"><li id="deh_05_0904__li543615567305">Each value can contain a maximum of 255 Unicode characters. </li><li id="deh_05_0904__li164368560303">This field cannot be left blank.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="deh_05_0904__section40529449"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0904__table12283143735114" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameters</caption><thead align="left"><tr id="deh_05_0904__row2284133710517"><th align="left" class="cellrowborder" valign="top" width="23.002300230023003%" id="mcps1.3.4.2.2.4.1.1"><p id="deh_05_0904__p11336443125114"><strong id="deh_05_0904__b8171155141617">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.852785278527854%" id="mcps1.3.4.2.2.4.1.2"><p id="deh_05_0904__p1433613436519"><strong id="deh_05_0904__b6599356191615">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.14491449144914%" id="mcps1.3.4.2.2.4.1.3"><p id="deh_05_0904__p1633616439512"><strong id="deh_05_0904__b197855572166">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="deh_05_0904__row17284143705111"><td class="cellrowborder" valign="top" width="23.002300230023003%" headers="mcps1.3.4.2.2.4.1.1 "><p id="deh_05_0904__p8336104335117">resources</p>
</td>
<td class="cellrowborder" valign="top" width="27.852785278527854%" headers="mcps1.3.4.2.2.4.1.2 "><p id="deh_05_0904__p033684385116">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="49.14491449144914%" headers="mcps1.3.4.2.2.4.1.3 "><p id="deh_05_0904__p6336114314513">Specifies the returned DeH list. For details, see <a href="#deh_05_0904__table924792920312">Table 6</a>.</p>
</td>
</tr>
<tr id="deh_05_0904__row528463785116"><td class="cellrowborder" valign="top" width="23.002300230023003%" headers="mcps1.3.4.2.2.4.1.1 "><p id="deh_05_0904__p1336134365118">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="27.852785278527854%" headers="mcps1.3.4.2.2.4.1.2 "><p id="deh_05_0904__p9336143195111">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.14491449144914%" headers="mcps1.3.4.2.2.4.1.3 "><p id="deh_05_0904__p143361343175116">Specifies the total number of resources.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="deh_05_0904__table924792920312"></a><a name="table924792920312"></a><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0904__table924792920312" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Description of the <strong id="deh_05_0904__b65621041694442">resource</strong> field</caption><thead align="left"><tr id="deh_05_0904__row724982918315"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="deh_05_0904__p724715654719"><strong id="deh_05_0904__b1281814112174">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.4.3.2.4.1.2"><p id="deh_05_0904__p1724985617478"><strong id="deh_05_0904__b1746134361713">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.4.3.2.4.1.3"><p id="deh_05_0904__p12251105611474"><strong id="deh_05_0904__b849724413179">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="deh_05_0904__row1249182913319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0904__p14679356153211">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0904__p667935693210">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0904__p16679175693210">Specifies the DeH ID.</p>
</td>
</tr>
<tr id="deh_05_0904__row192492291539"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0904__p11679165693220">resouce_detail</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0904__p167935663210">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0904__p9217447140">Specifies the DeH details.</p>
<p id="deh_05_0904__p156791256163212">This field is used for future extension and is left empty by default.</p>
</td>
</tr>
<tr id="deh_05_0904__row202492291131"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0904__p16792567326">tags</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0904__p3679556183215">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0904__p967975614321">Specifies the tag list.</p>
<p id="deh_05_0904__p354217075515">For details, see <a href="#deh_05_0904__table145631502043">Table 7</a>.</p>
</td>
</tr>
<tr id="deh_05_0904__row724992916316"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="deh_05_0904__p206792563325">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.3.2.4.1.2 "><p id="deh_05_0904__p1167917566327">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.3.2.4.1.3 "><p id="deh_05_0904__p767911567325">Specifies the resource name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="deh_05_0904__table145631502043"></a><a name="table145631502043"></a><table cellpadding="4" cellspacing="0" summary="" id="deh_05_0904__table145631502043" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="deh_05_0904__b149313413919">tag</strong> field description</caption><thead align="left"><tr id="deh_05_0904__row1556511020418"><th align="left" class="cellrowborder" valign="top" width="25.252525252525253%" id="mcps1.3.4.4.2.4.1.1"><p id="deh_05_0904__p1463712019481"><strong id="deh_05_0904__b19674154816195">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.282828282828287%" id="mcps1.3.4.4.2.4.1.2"><p id="deh_05_0904__p264150164815"><strong id="deh_05_0904__b6715125131917">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.46464646464647%" id="mcps1.3.4.4.2.4.1.3"><p id="deh_05_0904__p964314013482"><strong id="deh_05_0904__b5321553151912">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="deh_05_0904__row956519014410"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.4.2.4.1.1 "><p id="deh_05_0904__p1842104620338">key</p>
</td>
<td class="cellrowborder" valign="top" width="28.282828282828287%" headers="mcps1.3.4.4.2.4.1.2 "><p id="deh_05_0904__p1842546193319">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.4.2.4.1.3 "><p id="deh_05_0904__p12421546203313">Specifies the tag key.</p>
<ul id="deh_05_0904__ul34244618336"><li id="deh_05_0904__li194217469331">It contains a maximum of 36 Unicode characters.</li><li id="deh_05_0904__li442144618336">This field cannot be left blank.</li><li id="deh_05_0904__li12427468332">It cannot contain the following ASCII characters: =*&lt;&gt;\|/,</li></ul>
</td>
</tr>
<tr id="deh_05_0904__row125651505416"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.4.2.4.1.1 "><p id="deh_05_0904__p184214613310">value</p>
</td>
<td class="cellrowborder" valign="top" width="28.282828282828287%" headers="mcps1.3.4.4.2.4.1.2 "><p id="deh_05_0904__p15421446183319">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.4.4.2.4.1.3 "><p id="deh_05_0904__p18421146123310">Specifies the tag value.</p>
<ul id="deh_05_0904__ul18425463332"><li id="deh_05_0904__li154294616339">Each value contains a maximum of 43 Unicode characters.</li><li id="deh_05_0904__li1842746193314">This field can be left blank.</li><li id="deh_05_0904__li114218464336">It cannot contain the following ASCII characters: =*&lt;&gt;\|/,</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="deh_05_0904__section4539132133315"><h4 class="sectiontitle">Example Request</h4><div class="p" id="deh_05_0904__p19765421541">Filter DeHs by tag. From the first data record, query the DeH using the search field (field: <strong id="deh_05_0904__b15310101521715">resource_name</strong>; value: <strong id="deh_05_0904__b323071011177">resource1</strong>) and the tag (key: <strong id="deh_05_0904__b1366017891814">key1</strong>; value: <strong id="deh_05_0904__b15106119184">value1</strong>).<pre class="screen" id="deh_05_0904__screen162262105426">POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/resource_instances/action </pre>
<pre class="screen" id="deh_05_0904__screen1122918106426">{
"offset": "0",
"limit": "100",
"action": "filter",
"matches": [
{
"key": "resource_name",
"value": "resource1"
}
],
"tags": [
{
"key": "key1",
"values": ["value1"]
}
]
}</pre>
</div>
</div>
<div class="section" id="deh_05_0904__section16360154516337"><h4 class="sectiontitle">Example Response</h4><p id="deh_05_0904__p239694814511">Response body when <strong id="deh_05_0904__b8423527069924">action</strong> is set to <strong id="deh_05_0904__b8423527069921">filter</strong></p>
<pre class="screen" id="deh_05_0904__screen10775181312315">{
"resources": [
{
"resource_detail": null,
"resource_id": "cdfs_cefs_wesas_12_dsad",
"resource_name": "resource1",
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}
],
"total_count": 1
}</pre>
<p id="deh_05_0904__p072131119612">Response body when <strong id="deh_05_0904__b838828101">action</strong> is set to <strong id="deh_05_0904__b1993724070">count</strong></p>
<pre class="screen" id="deh_05_0904__screen1469416141543">{
"total_count": 100
}</pre>
</div>
<div class="section" id="deh_05_0904__section9992350"><h4 class="sectiontitle">Status Code</h4><p id="deh_05_0904__p5641212">See <a href="deh_02_0016.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="deh_05_0900.html">DeH Tag Management</a></div>
</div>
</div>
View Git Blame Copy Permalink