forked from docs/doc-exports
Li, Qiao
914011d51b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
545 lines
40 KiB
HTML
545 lines
40 KiB
HTML
<a name="waf_02_0092"></a><a name="waf_02_0092"></a>
|
|
|
|
<h1 class="topictitle1">Querying Instances by Tag</h1>
|
|
<div id="body1558942309611"><div class="section" id="waf_02_0092__section658181413318"><h4 class="sectiontitle">Function Description</h4><p id="waf_02_0092__p125281316193313">This API is used to query protected domain name instances by tag.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0092__section171007366331"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0092__ul14598646163314"><li id="waf_02_0092__li17598154615330">URI format<p id="waf_02_0092__p35983465332"><a name="waf_02_0092__li17598154615330"></a><a name="li17598154615330"></a>POST /v1/{project_id}/waf/resource_instances/action</p>
|
|
</li></ul>
|
|
<ul id="waf_02_0092__ul1959804663310"><li id="waf_02_0092__li459814468337">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0092__table3668256" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0092__row13281129"><th align="left" class="cellrowborder" valign="top" width="30.930000000000003%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="waf_02_0092__p2029696"><strong id="waf_02_0092__b1548462585419">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="waf_02_0092__p30187650"><strong id="waf_02_0092__b18423112705419">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.430000000000001%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="waf_02_0092__p29280601"><strong id="waf_02_0092__b1850662825410">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="34.02%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="waf_02_0092__p22918509"><strong id="waf_02_0092__b72671111181210">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0092__row44459941"><td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="waf_02_0092__p44485482">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="waf_02_0092__p46554275">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.430000000000001%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="waf_02_0092__p12799929">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="waf_02_0092__p30161299">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0092__section201681027153514"><h4 class="sectiontitle">Request</h4><div class="p" id="waf_02_0092__p237619525818">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0092__table3139475" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0092__row936368"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.1.2.5.1.1"><p id="waf_02_0092__p8736968"><strong id="waf_02_0092__b718474715540">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.3.2.1.2.5.1.2"><p id="waf_02_0092__p36605784"><strong id="waf_02_0092__b1257912486543">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.36826317368263%" id="mcps1.3.3.2.1.2.5.1.3"><p id="waf_02_0092__p12278537"><strong id="waf_02_0092__b156244494546">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.77602239776022%" id="mcps1.3.3.2.1.2.5.1.4"><p id="waf_02_0092__p55037442"><strong id="waf_02_0092__b9431185012546">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0092__row1579717311146"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0092__p1079993131413">without_any_tag</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0092__p479993131412">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0092__p18799193116147">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.77602239776022%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0092__p0799123181416">If this parameter is set to <strong id="waf_02_0092__b191031948115419">true</strong>, all resources without tags are queried. In this case, the tags, tags_any, not_tags, and not_tags_any fields are ignored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row28847852"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0092__p54974703">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0092__p23765938">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0092__p13681402377"><a href="#waf_02_0092__table38371299527">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.77602239776022%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0092__p314951794316">Includes specified tags.</p>
|
|
<p id="waf_02_0092__p34429081">This field contains a maximum of 20 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. Keys must be unique and values of a key must be unique. The response returns resources containing all tags in this list. Keys in this list are in an AND relationship while values in each key-value structure is in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row1960412209"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0092__p12972416204">tags_any</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0092__p10983412010">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0092__p149804172017"><a href="#waf_02_0092__table38371299527">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.77602239776022%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0092__p263281515438">Includes any of the specified tags.</p>
|
|
<p id="waf_02_0092__p169804172016">This field contains a maximum of 20 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. Keys must be unique and values of a key must be unique. 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. If no tag filtering condition is specified, full data is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row18978195229"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0092__p1597999172211">not_tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0092__p169793912219">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0092__p89795917226"><a href="#waf_02_0092__table38371299527">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.77602239776022%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0092__p449164084313">Excludes specified tags.</p>
|
|
<p id="waf_02_0092__p89794914228">This field contains a maximum of 20 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. Keys must be unique and values of a key must be unique. The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering condition is specified, full data is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row791295612318"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0092__p591245632315">not_tags_any</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0092__p291235616232">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0092__p19912155632317"><a href="#waf_02_0092__table38371299527">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.77602239776022%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0092__p2042674814438">Excludes any of the specified tags.</p>
|
|
<p id="waf_02_0092__p2912175611239">This field contains a maximum of 20 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. Keys must be unique and values of a key must be unique. 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. If no tag filtering condition is specified, full data is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row41426277"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0092__p85244">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0092__p6904824">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0092__p22419905">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.77602239776022%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0092__p10224131716404">Specifies the number of records to be queried. This parameter is unavailable if <strong id="waf_02_0092__b206174719588">action</strong> is <strong id="waf_02_0092__b1175445125817">count</strong>. If <strong id="waf_02_0092__b152099578588">action</strong> is <strong id="waf_02_0092__b10583271591">filter</strong>, the maximum value of <strong id="waf_02_0092__b183622617594">limit</strong> is <strong id="waf_02_0092__b128971531135920">1000</strong> by default.</p>
|
|
<p id="waf_02_0092__p4073022">This parameter value cannot be a negative number. The minimum value is <strong id="waf_02_0092__b13431144714597">1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row94817449360"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0092__p748744173612">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0092__p448044193613">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0092__p1148194419364">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.77602239776022%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0092__p20307844449">Specifies the query index. This parameter is unavailable if <strong id="waf_02_0092__b842352706195922">action</strong> is <strong id="waf_02_0092__b842352706195927">count</strong>.</p>
|
|
<p id="waf_02_0092__p1138384934116">If <strong id="waf_02_0092__b159764443546">offset</strong> is set to <em id="waf_02_0092__i459214485542">N</em>, the resource query starts from the <em id="waf_02_0092__i31031453105416">N+1</em> piece of data. If <strong id="waf_02_0092__b7820201117527">action</strong> is set to <strong id="waf_02_0092__b4148122075210">filter</strong>, <strong id="waf_02_0092__b1377218495527">offset</strong> is <strong id="waf_02_0092__b9461455135215">0</strong> by default, indicating that the query starts from the first piece of data.</p>
|
|
<p id="waf_02_0092__p94834433619">This parameter value cannot be a negative number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row36657204"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0092__p16443547">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0092__p56858922">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0092__p42169994">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.77602239776022%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0092__p4122155144317">Specifies the operation. The value can be <strong id="waf_02_0092__b842352706112823">filter</strong> or <strong id="waf_02_0092__b842352706112836">count</strong>.</p>
|
|
<ul id="waf_02_0092__ul1220231064318"><li id="waf_02_0092__li12398151316431"><strong id="waf_02_0092__b28552039245">filter</strong>: Query by filter criteria.</li><li id="waf_02_0092__li320212105439"><strong id="waf_02_0092__b349343212715">count</strong>: Only the total number of records needs to be returned.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row16368104384520"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.2.5.1.1 "><p id="waf_02_0092__p193681143184511">matches</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.3.2.1.2.5.1.2 "><p id="waf_02_0092__p136894313456">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36826317368263%" headers="mcps1.3.3.2.1.2.5.1.3 "><p id="waf_02_0092__p636918438459"><a href="#waf_02_0092__table10200716215">Table 4</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.77602239776022%" headers="mcps1.3.3.2.1.2.5.1.4 "><p id="waf_02_0092__p168118187461">Specified the search field.</p>
|
|
<ul id="waf_02_0092__ul1188262012483"><li id="waf_02_0092__li788215206481"><strong id="waf_02_0092__b6701654085">key</strong> indicates the field to be matched. For example, <strong id="waf_02_0092__b0962212395">resource_name</strong>. If <strong id="waf_02_0092__b6568153951018">key</strong> is <strong id="waf_02_0092__b1882113436104">resource_name</strong>, fuzzy search is used by default. The key is a fixed dictionary value and cannot contain duplicate keys or unsupported keys.</li><li id="waf_02_0092__li11406416135012"><strong id="waf_02_0092__b12590172084315">value</strong> indicates the matched domain name.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0092__table38371299527"></a><a name="table38371299527"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0092__table38371299527" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tags</caption><thead align="left"><tr id="waf_02_0092__row16839129155218"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.2.5.1.1"><p id="waf_02_0092__p7839929125214"><strong id="waf_02_0092__b14512296132">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.3.3.2.5.1.2"><p id="waf_02_0092__p128391229195213"><strong id="waf_02_0092__b15675173011310">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.49%" id="mcps1.3.3.3.2.5.1.3"><p id="waf_02_0092__p1783915290529"><strong id="waf_02_0092__b9251143217136">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.900000000000006%" id="mcps1.3.3.3.2.5.1.4"><p id="waf_02_0092__p19839102985215"><strong id="waf_02_0092__b242193314132">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0092__row1183910292528"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.1 "><p id="waf_02_0092__p78391294528">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.3.2.5.1.2 "><p id="waf_02_0092__p108391629175212">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.3.2.5.1.3 "><p id="waf_02_0092__p48395292529">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.900000000000006%" headers="mcps1.3.3.3.2.5.1.4 "><p id="waf_02_0092__p15574818184416">Specifies the key.</p>
|
|
<p id="waf_02_0092__p1983917297529">A key contains up to 127 Unicode characters.</p>
|
|
<p id="waf_02_0092__p435612555562"><strong id="waf_02_0092__b10415119152">key</strong> cannot be empty, an empty string, or spaces. Before using key, delete spaces of single-byte character (SBC) before and after the value.</p>
|
|
<p id="waf_02_0092__p11187118145513">The system does not verify the character set of <strong id="waf_02_0092__b86711251448">key</strong> in searching.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row1883919296523"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.2.5.1.1 "><p id="waf_02_0092__p183922935216">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.3.2.5.1.2 "><p id="waf_02_0092__p11839729125214">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.3.2.5.1.3 "><p id="waf_02_0092__p483922918523">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.900000000000006%" headers="mcps1.3.3.3.2.5.1.4 "><p id="waf_02_0092__p15394334184417">Specifies the list of values.</p>
|
|
<p id="waf_02_0092__p111291217589">Each value contains a maximum of 255 Unicode characters. Before using <strong id="waf_02_0092__b108301933172711">values</strong>, delete SBC spaces before and after the value.</p>
|
|
<p id="waf_02_0092__p141215124581">The value can be an empty array but cannot be left blank.</p>
|
|
<p id="waf_02_0092__p13121912155810">The asterisk (*) is reserved for the system. If the value starts with *, fuzzy match is performed based on the value following *. The value cannot contain only asterisks (*).</p>
|
|
<p id="waf_02_0092__p4121212195819">The system does not verify the character set of <strong id="waf_02_0092__b141153113204">values</strong> in searching, but verifies the length of <strong id="waf_02_0092__b18359102912233">values</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0092__table10200716215"></a><a name="table10200716215"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0092__table10200716215" frame="border" border="1" rules="all"><caption><b>Table 4 </b>matches</caption><thead align="left"><tr id="waf_02_0092__row620019166113"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.5.1.1"><p id="waf_02_0092__p142001916111"><strong id="waf_02_0092__b2038622472112">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.3.4.2.5.1.2"><p id="waf_02_0092__p142007165119"><strong id="waf_02_0092__b1838392610219">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.49%" id="mcps1.3.3.4.2.5.1.3"><p id="waf_02_0092__p142011216114"><strong id="waf_02_0092__b18598162716212">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.900000000000006%" id="mcps1.3.3.4.2.5.1.4"><p id="waf_02_0092__p02011716216"><strong id="waf_02_0092__b13074285211">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0092__row1420119161719"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="waf_02_0092__p32018162114">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.4.2.5.1.2 "><p id="waf_02_0092__p3201171616119">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.4.2.5.1.3 "><p id="waf_02_0092__p92011161213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.900000000000006%" headers="mcps1.3.3.4.2.5.1.4 "><p id="waf_02_0092__p16323203684518">Specifies the key.</p>
|
|
<p id="waf_02_0092__p182011516518">The value is fixed to <strong id="waf_02_0092__b146261335162111">resource_name</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row1720141620119"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="waf_02_0092__p13201131614110">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.3.4.2.5.1.2 "><p id="waf_02_0092__p162012162113">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.49%" headers="mcps1.3.3.4.2.5.1.3 "><p id="waf_02_0092__p112011616413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.900000000000006%" headers="mcps1.3.3.4.2.5.1.4 "><p id="waf_02_0092__p313919381455">Specifies the list of values.</p>
|
|
<p id="waf_02_0092__p6201161616113">Each value contains a maximum of 255 Unicode characters and the character set is not verified.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0092__section75899561003"><h4 class="sectiontitle">Response</h4><p id="waf_02_0092__p46141738141812">Response parameters</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0092__table103645682816" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0092__row173785613282"><th align="left" class="cellrowborder" valign="top" width="27.102710271027103%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0092__p10695141142917"><strong id="waf_02_0092__b21038221227">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.222922292229224%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0092__p469512112912"><strong id="waf_02_0092__b19387182362214">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.67436743674367%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0092__p1269520113299"><strong id="waf_02_0092__b18641142462210">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0092__row19371456152814"><td class="cellrowborder" valign="top" width="27.102710271027103%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0092__p1237175622810">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.222922292229224%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0092__p1237956152817"><a href="#waf_02_0092__table786112594181">Table 6</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.67436743674367%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0092__p5379566289">Specifies details about resources that meet the filter criteria.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row13371856132810"><td class="cellrowborder" valign="top" width="27.102710271027103%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0092__p7371256122813">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.222922292229224%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0092__p53775611284">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.67436743674367%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0092__p73735611286">Specifies the total number of records that meet the filter criteria.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0092__table786112594181"></a><a name="table786112594181"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0092__table786112594181" frame="border" border="1" rules="all"><caption><b>Table 6 </b>resource</caption><thead align="left"><tr id="waf_02_0092__row798911593187"><th align="left" class="cellrowborder" valign="top" width="27.22%" id="mcps1.3.4.4.2.4.1.1"><p id="waf_02_0092__p139891959201816"><strong id="waf_02_0092__b123341217258">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.68%" id="mcps1.3.4.4.2.4.1.2"><p id="waf_02_0092__p2990859181813"><strong id="waf_02_0092__b9392191416258">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.1%" id="mcps1.3.4.4.2.4.1.3"><p id="waf_02_0092__p129901659121814"><strong id="waf_02_0092__b642271542513">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0092__row1999085921814"><td class="cellrowborder" valign="top" width="27.22%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0092__p499055914186">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.68%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0092__p157190101914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.1%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0092__p471103194">Specifies the resource ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row1571804196"><td class="cellrowborder" valign="top" width="27.22%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0092__p7728018197">resource_detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.68%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0092__p5725061919"><a href="#waf_02_0092__table22387562">Table 8</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.1%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0092__p51792854618">Specifies details about a WAF instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row2720051917"><td class="cellrowborder" valign="top" width="27.22%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0092__p47290101916">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.68%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0092__p27215011917"><a href="#waf_02_0092__table10823111182015">Table 7</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.1%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0092__p105051645462">Specifies the tag list.</p>
|
|
<p id="waf_02_0092__p5721207190">If there is no tag, an empty array is used by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row137212031919"><td class="cellrowborder" valign="top" width="27.22%" headers="mcps1.3.4.4.2.4.1.1 "><p id="waf_02_0092__p1572404199">resource_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.68%" headers="mcps1.3.4.4.2.4.1.2 "><p id="waf_02_0092__p147218016198">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.1%" headers="mcps1.3.4.4.2.4.1.3 "><p id="waf_02_0092__p18442105517455">Specifies the resource name.</p>
|
|
<p id="waf_02_0092__p1872005198">This parameter is left blank by default if there is no resource name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0092__table10823111182015"></a><a name="table10823111182015"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0092__table10823111182015" frame="border" border="1" rules="all"><caption><b>Table 7 </b>tags</caption><thead align="left"><tr id="waf_02_0092__row1792511122018"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.5.2.4.1.1"><p id="waf_02_0092__p129251014209"><strong id="waf_02_0092__b9256151072814">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.37%" id="mcps1.3.4.5.2.4.1.2"><p id="waf_02_0092__p692510182017"><strong id="waf_02_0092__b477671282820">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.1%" id="mcps1.3.4.5.2.4.1.3"><p id="waf_02_0092__p2092521102011"><strong id="waf_02_0092__b169131135288">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0092__row99252119206"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="waf_02_0092__p5925111182017">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.37%" headers="mcps1.3.4.5.2.4.1.2 "><p id="waf_02_0092__p59257118206">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.1%" headers="mcps1.3.4.5.2.4.1.3 "><p id="waf_02_0092__p89252017207">Specifies the key. It contains a maximum of 36 Unicode characters.</p>
|
|
<p id="waf_02_0092__p179255117201">The value of <strong id="waf_02_0092__b121534815282">key</strong> must comply with <a href="waf_02_0086.html">Character Set Specifications</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row69259192018"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.5.2.4.1.1 "><p id="waf_02_0092__p49251119203">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.37%" headers="mcps1.3.4.5.2.4.1.2 "><p id="waf_02_0092__p99261512203">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.1%" headers="mcps1.3.4.5.2.4.1.3 "><p id="waf_02_0092__p16926191172020">Specifies the value. Each value contains a maximum of 43 Unicode characters.</p>
|
|
<p id="waf_02_0092__p15926191152015">The value must comply with <a href="waf_02_0086.html">Character Set Specifications</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0092__table22387562"></a><a name="table22387562"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0092__table22387562" frame="border" border="1" rules="all"><caption><b>Table 8 </b>resource_detail</caption><thead align="left"><tr id="waf_02_0092__row5105955"><th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.6.2.4.1.1"><p id="waf_02_0092__p10929212"><strong id="waf_02_0092__b9328114963015">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.349999999999998%" id="mcps1.3.4.6.2.4.1.2"><p id="waf_02_0092__p12851014"><strong id="waf_02_0092__b664823950">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.160000000000004%" id="mcps1.3.4.6.2.4.1.3"><p id="waf_02_0092__p34299241"><strong id="waf_02_0092__b172981519308">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0092__row40257715"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.6.2.4.1.1 "><p id="waf_02_0092__p39649453">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.6.2.4.1.2 "><p id="waf_02_0092__p57489107">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.6.2.4.1.3 "><p id="waf_02_0092__p26106127">Specifies the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row33628551"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.6.2.4.1.1 "><p id="waf_02_0092__p39558140">hostname</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.6.2.4.1.2 "><p id="waf_02_0092__p50092794">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.6.2.4.1.3 "><p id="waf_02_0092__p30984488">Specifies the domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row61883492"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.6.2.4.1.1 "><p id="waf_02_0092__p46506973">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.6.2.4.1.2 "><p id="waf_02_0092__p8968438">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.6.2.4.1.3 "><p id="waf_02_0092__p55354839">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row28431506"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.6.2.4.1.1 "><p id="waf_02_0092__p21250675">protect_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.6.2.4.1.2 "><p id="waf_02_0092__p43583153">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.6.2.4.1.3 "><p id="waf_02_0092__p357818332332">Specifies the WAF mode.</p>
|
|
<ul id="waf_02_0092__ul1373411430338"><li id="waf_02_0092__li17734243183317"><strong id="waf_02_0092__b157181631132019">0</strong>: disabled.</li><li id="waf_02_0092__li3734184314336"><strong id="waf_02_0092__b8191614133514">1</strong>: enabled.</li><li id="waf_02_0092__li2996349311"><span class="parmvalue" id="waf_02_0092__parmvalue1023875662014"><b>-1</b></span>: bypassed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row29626322"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.6.2.4.1.1 "><p id="waf_02_0092__p50921845">access_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.6.2.4.1.2 "><p id="waf_02_0092__p31028818">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.6.2.4.1.3 "><p id="waf_02_0092__p78861505348">Specifies whether a domain name is connected to WAF.</p>
|
|
<ul id="waf_02_0092__ul74320843410"><li id="waf_02_0092__li543268143419"><strong id="waf_02_0092__b197744176015">0</strong>: The domain name is not connected to WAF.</li><li id="waf_02_0092__li184322873420"><strong id="waf_02_0092__b73364211508">1</strong>: The domain name is connected to WAF.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row8963191491415"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.6.2.4.1.1 "><p id="waf_02_0092__p4965114161415">access_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.6.2.4.1.2 "><p id="waf_02_0092__p1196519144145">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.6.2.4.1.3 "><p id="waf_02_0092__p5965614161415">Specifies the access code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row12726078"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.6.2.4.1.1 "><p id="waf_02_0092__p24179377">proxy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.6.2.4.1.2 "><p id="waf_02_0092__p12372492">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.6.2.4.1.3 "><p id="waf_02_0092__p32316963618">Specifies whether a proxy is configured.</p>
|
|
<ul id="waf_02_0092__ul1189171615367"><li id="waf_02_0092__li191893163361"><strong id="waf_02_0092__b19830161304918">true</strong>: A proxy is configured.</li><li id="waf_02_0092__li21891416163615"><strong id="waf_02_0092__b105678449496">false</strong>: No proxy is configured.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0092__row26959292"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.6.2.4.1.1 "><p id="waf_02_0092__p36219011">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.6.2.4.1.2 "><p id="waf_02_0092__p48058799">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.160000000000004%" headers="mcps1.3.4.6.2.4.1.3 "><p id="waf_02_0092__p448680">Specifies the time when a domain name is created.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0092__section156091346587"><h4 class="sectiontitle">Examples</h4><p id="waf_02_0092__p111705181396"></p>
|
|
<ul id="waf_02_0092__ul61701218896"><li id="waf_02_0092__li37361334101619">Request example<div class="p" id="waf_02_0092__p259564111618"><a name="waf_02_0092__li37361334101619"></a><a name="li37361334101619"></a>Sample request when <strong id="waf_02_0092__b108231355203114">action</strong> is set to <strong id="waf_02_0092__b118375557315">filter</strong><pre class="screen" id="waf_02_0092__screen983418244106">{
|
|
"offset": "100",
|
|
"limit": "100",
|
|
"action": "filter",
|
|
"without_any_tag": "true",
|
|
"matches":[
|
|
{
|
|
"key": "resource_name",
|
|
"value": "resource1"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"key": "key1",
|
|
"values": [
|
|
"*value1",
|
|
"value2"
|
|
]
|
|
}
|
|
],
|
|
"tags_any": [
|
|
{
|
|
"key": "key2",
|
|
"values": [
|
|
"*value1",
|
|
"value2"
|
|
]
|
|
}
|
|
],
|
|
"not_tags": [
|
|
{
|
|
"key": "key3",
|
|
"values": [
|
|
"*value1",
|
|
"value2"
|
|
]
|
|
}
|
|
],
|
|
"not_tags_any": [
|
|
{
|
|
"key": "key4",
|
|
"values": [
|
|
"*value1",
|
|
"value2"
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="waf_02_0092__p1073055119163">Sample request when <strong id="waf_02_0092__b84235270620353">action</strong> is set to <strong id="waf_02_0092__b84235270620359">count</strong><pre class="screen" id="waf_02_0092__screen36614517144">{
|
|
|
|
|
|
"action": "count",
|
|
"matches":[
|
|
{
|
|
"key": "resource_name",
|
|
"value": "resource1"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"key": "key1",
|
|
"values": [
|
|
"*value1",
|
|
"value2"
|
|
]
|
|
}
|
|
],
|
|
"tags_any": [
|
|
{
|
|
"key": "key2",
|
|
"values": [
|
|
"*value1",
|
|
"value2"
|
|
]
|
|
}
|
|
],
|
|
"not_tags": [
|
|
{
|
|
"key": "key3",
|
|
"values": [
|
|
"*value1",
|
|
"value2"
|
|
]
|
|
}
|
|
],
|
|
"not_tags_any": [
|
|
{
|
|
"key": "key4",
|
|
"values": [
|
|
"*value1",
|
|
"value2"
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</li><li id="waf_02_0092__li1189757111719">Response example<div class="p" id="waf_02_0092__p7925107131712"><a name="waf_02_0092__li1189757111719"></a><a name="li1189757111719"></a>Response body when <strong id="waf_02_0092__b8423527069924">action</strong> is set to <strong id="waf_02_0092__b8423527069921">filter</strong><pre class="screen" id="waf_02_0092__screen192514717178">{
|
|
"resources": [
|
|
{
|
|
|
|
"resource_detail": {
|
|
"id": "1c9ca68c7f704fd398c62c070d96f5be",
|
|
"proxy": false,
|
|
"hostname": "www.waf.com",
|
|
"access_code": "13999b0e29694c09bde09d44b13daaa6",
|
|
"policy_id": "a2d8418c211e4c88b07c7f57b445a5f6",
|
|
"timestamp": 1557368735574,
|
|
"protect_status": 1,
|
|
"access_status": 0
|
|
},
|
|
"resource_id": "cdfs_cefs_wesas_12_dsad",
|
|
"resource_name": "resouece1",
|
|
"tags": [
|
|
{
|
|
"key": "key1",
|
|
"value": "value1"
|
|
},
|
|
{
|
|
"key": "key2",
|
|
"value": "value1"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"total_count": 1000
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="waf_02_0092__p12954101618174">Response body when <strong id="waf_02_0092__b842352706203143">action</strong> is set to <strong id="waf_02_0092__b842352706203145">count</strong><pre class="screen" id="waf_02_0092__screen19171151818919">{
|
|
"total_count": 1000
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0092__section76604159333"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0092__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0092__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 9</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0092__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0092__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Status code</caption><thead align="left"><tr id="waf_02_0092__waf_02_0012_r3d6e2f205c444705bdbb9daaac74e575"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.6.2.2.2.4.1.1"><p id="waf_02_0092__waf_02_0012_af3c4073076f24eca88d94e3fa1effdc6">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.41%" id="mcps1.3.6.2.2.2.4.1.2"><p id="waf_02_0092__waf_02_0012_en-us_topic_0144911667_p4531342288">Description</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.589999999999996%" id="mcps1.3.6.2.2.2.4.1.3"><p id="waf_02_0092__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0092__waf_02_0012_rc7b2adc390904a1ba79e303017797786"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="waf_02_0092__waf_02_0012_a93f3895d44bb4226934cc626ac50e37b">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.41%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="waf_02_0092__waf_02_0012_en-us_topic_0144911667_p7538425819">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.589999999999996%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="waf_02_0092__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0092__waf_02_0012_en-us_topic_0144911667_p482819399522">For details about error status codes, see <a href="waf_02_0085.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="waf_02_0091.html">Interconnection with TMS</a></div>
|
|
</div>
|
|
</div>
|
|
|