doc-exports/docs/dli/api-ref/dli_02_0042.html
Su, Xiaomeng 57a0d535be dli_api_0910_version_api
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
2023-10-16 22:01:57 +00:00

204 lines
16 KiB
HTML

<a name="dli_02_0042"></a><a name="dli_02_0042"></a>
<h1 class="topictitle1">Querying a User's Table Permissions</h1>
<div id="body8662426"><div class="section" id="dli_02_0042__sb033e8c568d74ab6ae83ace3345cd717"><h4 class="sectiontitle">Function</h4><p id="dli_02_0042__en-us_topic_0069077919_p13312348">This API is used to query the permission of a specified user on a table.</p>
</div>
<div class="section" id="dli_02_0042__sfddc1ad5fae5464b8858e1fdc26454ed"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0042__en-us_topic_0069077919_ul4558436"><li id="dli_02_0042__en-us_topic_0069077919_li41025926">URI format<p id="dli_02_0042__en-us_topic_0069077919_p33689020"><a name="dli_02_0042__en-us_topic_0069077919_li41025926"></a><a name="en-us_topic_0069077919_li41025926"></a>GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/users/{user_name}</p>
</li><li id="dli_02_0042__li219091532816">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0042__en-us_topic_0069077919_table34765725" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0042__en-us_topic_0069077919_row39130336"><th align="left" class="cellrowborder" valign="top" width="19.15%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0042__ac59ab0cdcb0e4a57b18b52068962db96">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.61%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0042__ae81b7ec518d744da9b44bc7c3571640f">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.06%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0042__p169381515603">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.18%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0042__a5784ef9e565642a9be543098656db615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0042__row1950555119425"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0042__en-us_topic_0069077803_p43412436">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0042__en-us_topic_0069077803_p26746391">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.06%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0042__p49391157018">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.18%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0042__p1310472724012">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="dli_02_0042__en-us_topic_0069077919_row17475349"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0042__en-us_topic_0069077919_p6217170">database_name</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0042__en-us_topic_0069077919_p33828780">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.06%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0042__p9939415201">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.18%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0042__p19743184584713">Name of the database where the table to be queried resides.</p>
</td>
</tr>
<tr id="dli_02_0042__en-us_topic_0069077919_row32227806"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0042__en-us_topic_0069077919_p60315518">table_name</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0042__en-us_topic_0069077919_p53718807">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.06%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0042__p593916151202">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.18%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0042__p7744745194713">Name of a table that is to be queried.</p>
</td>
</tr>
<tr id="dli_02_0042__en-us_topic_0069077919_row36542672"><td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0042__en-us_topic_0069077919_p7166428">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="12.61%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0042__en-us_topic_0069077919_p43609821">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.06%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0042__p1193911513020">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.18%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0042__en-us_topic_0069077919_p42734651">Name of the user whose permission is to be queried.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dli_02_0042__s9b33a824e2374262a4376129acdd439c"><h4 class="sectiontitle">Request</h4><p id="dli_02_0042__p6930071154042">None</p>
</div>
<div class="section" id="dli_02_0042__s37673dbfdc2d46728d3b0f8efd5e3e53"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0042__en-us_topic_0069077919_table60959155" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0042__en-us_topic_0069077919_row15600465"><th align="left" class="cellrowborder" valign="top" width="12.458754124587541%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0042__a95d5ca608a7f4dec829a64a04e273078">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.47895210478952%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0042__p1063174724312">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.2983701629837%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0042__abd3fe00c893d4791aa91baf1faa6e203">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.763923607639235%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0042__aac78212a09db41539d89add041c3850d">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0042__en-us_topic_0069077919_row50364107"><td class="cellrowborder" valign="top" width="12.458754124587541%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0042__en-us_topic_0069077919_p52960852">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="10.47895210478952%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0042__p1263194784319">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0042__en-us_topic_0069077919_p53564132">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.763923607639235%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0042__p1662113446158">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0042__parmvalue2413933416116"><b>true</b></span> indicates that the request is successfully executed. Example value: <strong id="dli_02_0042__b13141319143911">true</strong>.</p>
</td>
</tr>
<tr id="dli_02_0042__en-us_topic_0069077919_row58002450"><td class="cellrowborder" valign="top" width="12.458754124587541%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0042__en-us_topic_0069077919_p578006">message</p>
</td>
<td class="cellrowborder" valign="top" width="10.47895210478952%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0042__p16631247144312">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0042__en-us_topic_0069077919_p34206633">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.763923607639235%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0042__p862114491513">System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank.</p>
</td>
</tr>
<tr id="dli_02_0042__en-us_topic_0069077919_row39247039"><td class="cellrowborder" valign="top" width="12.458754124587541%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0042__en-us_topic_0069077919_p24893609">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.47895210478952%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0042__p1463114717439">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0042__en-us_topic_0069077919_p51105010">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.763923607639235%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0042__en-us_topic_0069077919_p45865121">Name of the user whose permission is to be queried.</p>
</td>
</tr>
<tr id="dli_02_0042__row147389479105"><td class="cellrowborder" valign="top" width="12.458754124587541%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0042__p107381247161012">privileges</p>
</td>
<td class="cellrowborder" valign="top" width="10.47895210478952%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0042__p363234754317">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0042__p1738114718102">Array Of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.763923607639235%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0042__p1773984719105">Permission information. For details, see <a href="#dli_02_0042__table912853564418">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0042__table912853564418"></a><a name="table912853564418"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0042__table912853564418" frame="border" border="1" rules="all"><caption><b>Table 3 </b>privileges parameters</caption><thead align="left"><tr id="dli_02_0042__row1912973512444"><th align="left" class="cellrowborder" valign="top" width="10.35896410358964%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0042__p13129193516443">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.54904509549045%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0042__p1912963544410">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.948405159484052%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0042__p13129163510447">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.14358564143585%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0042__p212983514413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0042__row113183513448"><td class="cellrowborder" valign="top" width="10.35896410358964%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0042__p11131123511446">object</p>
</td>
<td class="cellrowborder" valign="top" width="9.54904509549045%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0042__p5131163512448">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.948405159484052%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0042__p11131193514445">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.14358564143585%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0042__p10131183524420">Objects on which a user has permission.</p>
<ul id="dli_02_0042__ul1413123504418"><li id="dli_02_0042__li51311435134414">If the object is in the format of <strong id="dli_02_0042__b84235270614324">databases.<em id="dli_02_0042__i842352697143217">Database name</em>.tables.<em id="dli_02_0042__i842352697143223">Table name</em></strong>, the user has permission on the database.</li><li id="dli_02_0042__li13131153514419">If the object is in the format of <strong id="dli_02_0042__b842352706143251">databases.<em id="dli_02_0042__i842352697143257">Database name</em>.tables.<em id="dli_02_0042__i84235269714334">Table name</em>columns.<em id="dli_02_0042__i842352697143310">Column name</em></strong>, the user has permission on the table.<p id="dli_02_0042__p1311193710612">Example value: <strong id="dli_02_0042__b1288224414396">databases.dsstest.tables.obs_231</strong>.</p>
</li></ul>
</td>
</tr>
<tr id="dli_02_0042__row1813119357442"><td class="cellrowborder" valign="top" width="10.35896410358964%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0042__p1813143534411">privileges</p>
</td>
<td class="cellrowborder" valign="top" width="9.54904509549045%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0042__p2131183517445">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.948405159484052%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0042__p1613293514440">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="64.14358564143585%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0042__p1813253524411">Permission of the user on a specified object. Example value: [<strong id="dli_02_0042__b17709446103913">DESCRIBE_TABLE</strong>].</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0042__section15772143623410"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0042__p534664283414">None</p>
</div>
<div class="section" id="dli_02_0042__section59635464345"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0042__screen49512083154019">{
"is_success": true,
"message": "",
"privileges": [
{
"object": "databases.dsstest.tables.obs_2312",
"privileges": [
"DESCRIBE_TABLE"
]
},
{
"object": "databases.dsstest.tables.obs_2312.columns.id",
"privileges": [
"SELECT"
]
}
],
"user_name": "scuser1"
}</pre>
</div>
<div class="section" id="dli_02_0042__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0042__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0042__tb12870f1c5f24b27abd55ca24264af36">Table 4</a> describes the status code.</p>
<div class="tablenoborder"><a name="dli_02_0042__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0042__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0042__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0042__ab49d21f312644072a331f43e92baf853">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0042__aea1d3bd107bb4c499da79a88832d256c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0042__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0042__a3153e07b3a9749adba92599fe6628fbf">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0042__p10675142010516">Authorization succeeds.</p>
</td>
</tr>
<tr id="dli_02_0042__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0042__p184941532219">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0042__p2049413539219">Request error.</p>
</td>
</tr>
<tr id="dli_02_0042__row11188531568"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0042__p31891733561">500</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0042__p1789413865719">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0042__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0042__p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see <a href="dli_02_0056.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0036.html">Permission-related APIs</a></div>
</div>
</div>