forked from docs/doc-exports
Su, Xiaomeng
57a0d535be
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>
228 lines
16 KiB
HTML
228 lines
16 KiB
HTML
<a name="dli_02_0038"></a><a name="dli_02_0038"></a>
|
|
|
|
<h1 class="topictitle1">Querying Queue Users</h1>
|
|
<div id="body8662426"><div class="section" id="dli_02_0038__s8a8b8f2130df4e818b31795a6596f598"><h4 class="sectiontitle">Function</h4><p id="dli_02_0038__en-us_topic_0069077915_p18467492">This API is used to query names of all users who can use a specified queue.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0038__s1b12fa23850b46588b88f2c87956bfbd"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0038__en-us_topic_0069077915_ul19471899"><li id="dli_02_0038__en-us_topic_0069077915_li41029370">URI format<p id="dli_02_0038__en-us_topic_0069077915_p33720015"><a name="dli_02_0038__en-us_topic_0069077915_li41029370"></a><a name="en-us_topic_0069077915_li41029370"></a>GET /v1.0/{project_id}/queues/{queue_name}/users</p>
|
|
</li><li id="dli_02_0038__li12985123619269">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0038__en-us_topic_0069077915_table35044683" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0038__en-us_topic_0069077915_row26593179"><th align="left" class="cellrowborder" valign="top" width="16.24%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0038__en-us_topic_0069077915_p96056186264">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.41%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0038__en-us_topic_0069077915_p960561819262">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.97%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0038__p13165142804014">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.379999999999995%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0038__en-us_topic_0069077915_p860551822612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0038__row105860199427"><td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0038__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.41%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0038__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.97%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0038__p716518288407">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.379999999999995%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0038__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_0038__en-us_topic_0069077915_row24582998"><td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0038__en-us_topic_0069077915_p45065821">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.41%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0038__en-us_topic_0069077915_p26452876">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.97%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0038__p1516512810400">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.379999999999995%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0038__en-us_topic_0069077915_p62308236">Name of a queue.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0038__table3719432124112" frame="border" border="1" rules="all"><caption><b>Table 2 </b>query parameter description</caption><thead align="left"><tr id="dli_02_0038__row1871915327415"><th align="left" class="cellrowborder" valign="top" width="16.24%" id="mcps1.3.2.2.2.2.2.5.1.1"><p id="dli_02_0038__p071923214419">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.41%" id="mcps1.3.2.2.2.2.2.5.1.2"><p id="dli_02_0038__p1272093210411">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.97%" id="mcps1.3.2.2.2.2.2.5.1.3"><p id="dli_02_0038__p9720113204119">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.379999999999995%" id="mcps1.3.2.2.2.2.2.5.1.4"><p id="dli_02_0038__p107202322412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0038__row47201032114110"><td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0038__p8720183211412">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.41%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0038__p97201321417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.97%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0038__p972016322417">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.379999999999995%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0038__p872063214419">Number of records to be displayed of the page-based query.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0038__row67201132194117"><td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0038__p177201732114112">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.41%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0038__p772023214419">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.97%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0038__p1972033215418">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.379999999999995%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0038__p872093294114">Specifies the offset of the page-based query.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0038__sb8978e815de44d57bb1b861ef680a2e3"><h4 class="sectiontitle">Request</h4><p id="dli_02_0038__p19597416153257">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0038__sbde118b1107f41f6bffb4a929fb16d0c"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0038__en-us_topic_0069077915_table53432251" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0038__en-us_topic_0069077915_row848378"><th align="left" class="cellrowborder" valign="top" width="12.709999999999999%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0038__a51d5445bbbc84f52a498a3ed190e346e">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.71%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0038__a1e3bd8c29259430ca52ca80a971968ed">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.16%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0038__a71de604936d14d959d699d4e2a8a6d47">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.42%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0038__a9546312a16f74db3a8c8eef7413da6b3">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0038__en-us_topic_0069077915_row16421007"><td class="cellrowborder" valign="top" width="12.709999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0038__en-us_topic_0069077915_p55033223">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.71%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0038__p119754020133">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.16%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0038__en-us_topic_0069077915_p27289743">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.42%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0038__p552612216156">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0038__parmvalue15600977161036"><b>true</b></span> indicates that the request is successfully executed. Example value: <strong id="dli_02_0038__b1027668191711">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0038__en-us_topic_0069077915_row29999348"><td class="cellrowborder" valign="top" width="12.709999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0038__en-us_topic_0069077915_p14028137">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.71%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0038__p997515021310">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.16%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0038__en-us_topic_0069077915_p32356376">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.42%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0038__p3526152217152">System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0038__en-us_topic_0069077915_row33862288"><td class="cellrowborder" valign="top" width="12.709999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0038__en-us_topic_0069077915_p58490813">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.71%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0038__p997516011132">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.16%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0038__en-us_topic_0069077915_p29744469">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.42%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0038__en-us_topic_0069077915_p60491792">Name of a queue. Example value: <strong id="dli_02_0038__b16451112151720">queue1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0038__en-us_topic_0069077915_row7555217"><td class="cellrowborder" valign="top" width="12.709999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0038__en-us_topic_0069077915_p7992858">privileges</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.71%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0038__p169755041310">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.16%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0038__en-us_topic_0069077915_p29119284">Array of Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.42%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0038__en-us_topic_0069077915_p9851798">Users who are granted with the permission to use this queue and the permission array to which users belong.</p>
|
|
<p id="dli_02_0038__p1826239296">For details, see <a href="#dli_02_0038__table34433526275">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0038__table34433526275"></a><a name="table34433526275"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0038__table34433526275" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="dli_02_0038__b1554181910284">privileges</strong> parameters</caption><thead align="left"><tr id="dli_02_0038__row144431527271"><th align="left" class="cellrowborder" valign="top" width="15.57%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0038__p9444952202719">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.24%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0038__p15444125218277">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.780000000000001%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0038__p1444105232710">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.41%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0038__p124440522274">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0038__row1844415524277"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0038__p59413180326">is_admin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0038__p29421418113219">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.780000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0038__p1994219183326">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.41%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0038__p89421818163211">Whether the database user is an administrator. Example value: <strong id="dli_02_0038__b10677014201718">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0038__row944555216276"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0038__p4942018163211">user_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0038__p594211853212">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.780000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0038__p6942141812326">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.41%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0038__p159426187327">Name of the user who has permission on the current queue. Example value: <strong id="dli_02_0038__b15365191631710">user2</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0038__row11445752142715"><td class="cellrowborder" valign="top" width="15.57%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0038__p1494331883214">privileges</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.24%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0038__p1794341873218">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.780000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0038__p18943141817327">Array of Strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.41%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0038__p1394381843217">Permission of the user on the queue. Example value: [<strong id="dli_02_0038__b977963091712">SUBMIT_JOB</strong>].</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0038__section15772143623410"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0038__p534664283414">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0038__section13756397153153"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0038__screen4327608153230">{
|
|
"is_success": true,
|
|
"message": "",
|
|
"privileges": [
|
|
{
|
|
"is_admin": true,
|
|
"privileges": [
|
|
"ALL"
|
|
],
|
|
"user_name": "tenant1"
|
|
},
|
|
{
|
|
"is_admin": false,
|
|
"privileges": [
|
|
"SUBMIT_JOB"
|
|
],
|
|
"user_name": "user2"
|
|
}
|
|
],
|
|
"queue_name": "queue1"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0038__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0038__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0038__tb12870f1c5f24b27abd55ca24264af36">Table 5</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0038__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0038__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dli_02_0038__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0038__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_0038__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0038__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0038__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0038__p10675142010516">Authorization succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0038__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0038__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0038__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0038__row11188531568"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0038__p31891733561">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0038__p1789413865719">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0038__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0038__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>
|
|
|