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>
196 lines
15 KiB
HTML
196 lines
15 KiB
HTML
<a name="waf_02_0054"></a><a name="waf_02_0054"></a>
|
|
|
|
<h1 class="topictitle1">Querying Data Masking Rules</h1>
|
|
<div id="body32981630"><div class="section" id="waf_02_0054__section39390906"><h4 class="sectiontitle">Function Description</h4><p class="msonormal" id="waf_02_0054__p54266397">This API is used to query all data masking rules in a policy.</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0054__section18973837"><h4 class="sectiontitle">URI</h4><ul id="waf_02_0054__ul33502032"><li id="waf_02_0054__li33082837">URI format<p id="waf_02_0054__p29310080"><a name="waf_02_0054__li33082837"></a><a name="li33082837"></a>GET /v1/{project_id}/waf/policy/{policy_id}/privacy?offset={offset}&limit={limit}</p>
|
|
</li><li id="waf_02_0054__li62464130">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0054__table25306260" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="waf_02_0054__row35532954"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="waf_02_0054__p59597058"><strong id="waf_02_0054__b1875961614214">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="waf_02_0054__p62632378"><strong id="waf_02_0054__b16157151911217">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="waf_02_0054__p40057834"><strong id="waf_02_0054__b654821162119">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="waf_02_0054__p23459131"><strong id="waf_02_0054__b1353922382111">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0054__row21141460"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0054__p34736734">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0054__p62212097">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0054__p6015076">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0054__p17459119">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0054__row22914347"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0054__p44122855">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0054__p17181470">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0054__p49521850">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0054__p51846947">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0054__row63969344"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0054__p14134342">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0054__p4031053">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0054__p58079868">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0054__p21617533">Specifies the number of returned pages. Its value ranges from <strong id="waf_02_0054__b116231631103417">0</strong> to <strong id="waf_02_0054__b76231931143411">65535</strong>. The default value is <strong id="waf_02_0054__b6623123113417">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0054__row61640034"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="waf_02_0054__p26786846">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="waf_02_0054__p22250878">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="waf_02_0054__p57490666">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="waf_02_0054__p25357967">Specifies the maximum number of records displayed on each page. Its value ranges from <strong id="waf_02_0054__b3623143315349">0</strong> to <strong id="waf_02_0054__b17623833193420">50</strong>. The default value is <strong id="waf_02_0054__b1662343310341">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="waf_02_0054__section36546812"><h4 class="sectiontitle">Request</h4><p id="waf_02_0054__p997493035714">Request parameters</p>
|
|
<p class="msonormal" id="waf_02_0054__p44449289">None</p>
|
|
</div>
|
|
<div class="section" id="waf_02_0054__section60485854"><h4 class="sectiontitle">Response</h4><div class="p" id="waf_02_0054__p621017419571">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0054__table43775162" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="waf_02_0054__row24416609"><th align="left" class="cellrowborder" valign="top" width="33.186681331866815%" id="mcps1.3.4.2.1.2.4.1.1"><p id="waf_02_0054__p31588306"><strong id="waf_02_0054__b12787162372211">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.017298270172986%" id="mcps1.3.4.2.1.2.4.1.2"><p id="waf_02_0054__p8515959"><strong id="waf_02_0054__b1012718272225">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.796020397960206%" id="mcps1.3.4.2.1.2.4.1.3"><p id="waf_02_0054__p18704056"><strong id="waf_02_0054__b1781622832220">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0054__row34118783"><td class="cellrowborder" valign="top" width="33.186681331866815%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0054__p12158071">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.017298270172986%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0054__p45279679">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0054__p43775359">Specifies the total number of rules.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0054__row58433916"><td class="cellrowborder" valign="top" width="33.186681331866815%" headers="mcps1.3.4.2.1.2.4.1.1 "><p id="waf_02_0054__p35526756">items</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.017298270172986%" headers="mcps1.3.4.2.1.2.4.1.2 "><p id="waf_02_0054__p59095001"><a href="#waf_02_0054__table16394183011019">Table 3</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.796020397960206%" headers="mcps1.3.4.2.1.2.4.1.3 "><p id="waf_02_0054__p1603648">Specifies the data masking rule objects.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="waf_02_0054__table16394183011019"></a><a name="table16394183011019"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0054__table16394183011019" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="waf_02_0054__b1969411411338">items</strong></caption><thead align="left"><tr id="waf_02_0054__row939613301015"><th align="left" class="cellrowborder" valign="top" width="33.086691330866906%" id="mcps1.3.4.3.2.4.1.1"><p id="waf_02_0054__p039873016013"><strong id="waf_02_0054__b1142929165215">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.117288271172878%" id="mcps1.3.4.3.2.4.1.2"><p id="waf_02_0054__p183997301406"><strong id="waf_02_0054__b1595296559">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.7960203979602%" id="mcps1.3.4.3.2.4.1.3"><p id="waf_02_0054__p839973013010"><strong id="waf_02_0054__b1280733115213">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0054__row74801364143"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0054__p63770514142">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0054__p11378155131414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0054__p837920531414">Specifies the ID of a data masking rule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0054__row19480661145"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0054__p173802510146">policy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0054__p638316519142">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0054__p63841753146">Specifies the policy ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0054__row14795618141"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0054__p0385135191417">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0054__p12385105161417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0054__p123871254144">Specifies the URL to which the data masking rule applies (exact match by default).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0054__row1747913615148"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0054__p938919511416">category</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0054__p63905541418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0054__p439010571416">Specifies the masked field. The options are <strong id="waf_02_0054__b633918430135">params</strong> and <strong id="waf_02_0054__b63391343111310">header</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0054__row10479146161415"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0054__p3392957141">index</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0054__p12393454141">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0054__p123945531414">Specifies the masked subfield.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="waf_02_0054__row1247806121411"><td class="cellrowborder" valign="top" width="33.086691330866906%" headers="mcps1.3.4.3.2.4.1.1 "><p id="waf_02_0054__p1839525101413">timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.117288271172878%" headers="mcps1.3.4.3.2.4.1.2 "><p id="waf_02_0054__p93978511148">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.7960203979602%" headers="mcps1.3.4.3.2.4.1.3 "><p id="waf_02_0054__p63984521418">Specifies the time when a data masking rule is added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0054__section2080711469572"><h4 class="sectiontitle">Example</h4><p id="waf_02_0054__p1337835120527"><strong id="waf_02_0054__b5687202715113">total</strong> with a value of <strong id="waf_02_0054__b116878277510">2</strong> is used as an example.</p>
|
|
<div class="p" id="waf_02_0054__p2664125416578">Response example<pre class="screen" id="waf_02_0054__screen1681911464572">{
|
|
"total": 2,
|
|
"items": [{
|
|
"id": "e1c0e55865544d1f8c95cf71df108c6b",
|
|
"policy_id": "yuc0e55865544d1f8c95cf71df108c6b",
|
|
"path": "/login",
|
|
"category": "params",
|
|
"index": "password",
|
|
"timestamp": 123243414132
|
|
}, {
|
|
"id": "d947d31c3e794b70a25e5e2057997f8e",
|
|
"policy_id": "yuc0e55865544d1f8c95cf71df108c89",
|
|
"path": "/register",
|
|
"category": "header",
|
|
"index": "x-auth-token",
|
|
"timestamp": 1343243243123
|
|
}
|
|
]
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="waf_02_0054__section7501782"><h4 class="sectiontitle">Status Code</h4><div class="p" id="waf_02_0054__waf_02_0012_a652d4922b7df48fca0a65bc1a38ea5f2"><a href="#waf_02_0054__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0">Table 4</a> describes the normal status code returned by the API.
|
|
<div class="tablenoborder"><a name="waf_02_0054__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><a name="waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0"></a><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0054__waf_02_0012_t82c3440f3efb42a38b9d4dc4011a33d0" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="waf_02_0054__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_0054__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_0054__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_0054__waf_02_0012_ada185614bba24140995b8123b3e9faa8">Meaning</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0054__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_0054__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_0054__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_0054__waf_02_0012_en-us_topic_0144911667_p369874114414">The request has succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="waf_02_0054__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_0053.html">Data Masking Rules</a></div>
|
|
</div>
|
|
</div>
|
|
|