forked from docs/doc-exports
Su, Xiaomeng
2374069890
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>
168 lines
15 KiB
HTML
168 lines
15 KiB
HTML
<a name="dli_02_0037"></a><a name="dli_02_0037"></a>
|
|
|
|
<h1 class="topictitle1">Granting Users with the Queue Usage Permission</h1>
|
|
<div id="body8662426"><div class="section" id="dli_02_0037__sceddf7b9a0c84fc49214cbbbc5531e96"><h4 class="sectiontitle">Function</h4><p id="dli_02_0037__en-us_topic_0069077913_p36484342">This API is used to share a specific queue with other users. You can grant users with the permission to use the specified queue or revoke the permission.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0037__s089f761f37bb406c802deb01d276ec5a"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0037__en-us_topic_0069077913_ul2441721"><li id="dli_02_0037__en-us_topic_0069077913_li21975494">URI format<p id="dli_02_0037__en-us_topic_0069077913_p63561721"><a name="dli_02_0037__en-us_topic_0069077913_li21975494"></a><a name="en-us_topic_0069077913_li21975494"></a>PUT /v1.0/{project_id}/queues/user-authorization</p>
|
|
</li><li id="dli_02_0037__li1725612218454">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0037__en-us_topic_0069077803_table60779388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0037__en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="13.58%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0037__a420a62a594f9410eaea229ffc8037a61">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.52%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0037__en-us_topic_0069077803_p873025824211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.99%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0037__p164413358113">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.91%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0037__a692d3cd97b464aed90ba6d841900a4a5">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0037__en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0037__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.52%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0037__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.99%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0037__p14454352120">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.91%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0037__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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0037__s12a2bb8f04cb4cd3aab54cafd3774713"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0037__en-us_topic_0069077913_table37651716" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0037__en-us_topic_0069077913_row4142140"><th align="left" class="cellrowborder" valign="top" width="13.5%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0037__a51d5445bbbc84f52a498a3ed190e346e">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.73%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0037__a1e3bd8c29259430ca52ca80a971968ed">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.18%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0037__a71de604936d14d959d699d4e2a8a6d47">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.59%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0037__a9546312a16f74db3a8c8eef7413da6b3">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0037__en-us_topic_0069077913_row21898123"><td class="cellrowborder" valign="top" width="13.5%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0037__en-us_topic_0069077913_p28917527">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.73%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0037__en-us_topic_0069077913_p60618311">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.18%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0037__en-us_topic_0069077913_p11136131">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.59%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0037__en-us_topic_0069077913_p29611444">Name of a queue.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0037__en-us_topic_0069077913_row65176412"><td class="cellrowborder" valign="top" width="13.5%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0037__en-us_topic_0069077913_p44798039">user_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.73%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0037__en-us_topic_0069077913_p4762555">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.18%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0037__en-us_topic_0069077913_p50222638">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.59%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0037__en-us_topic_0069077913_p41501915">Name of the user who is granted with usage permission on a queue or whose queue usage permission is revoked or updated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0037__en-us_topic_0069077913_row37972918"><td class="cellrowborder" valign="top" width="13.5%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0037__en-us_topic_0069077913_p55907498">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.73%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0037__en-us_topic_0069077913_p32213483">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.18%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0037__en-us_topic_0069077913_p59155296">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.59%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0037__en-us_topic_0069077913_p26849649">Grants or revokes the permission. The parameter value can be <strong id="dli_02_0037__b842352706111654">grant</strong>, <strong id="dli_02_0037__b842352706111657">revoke</strong>, or <strong id="dli_02_0037__b84235270611170">update</strong>. Users can perform the <strong id="dli_02_0037__b842352706111729">update</strong> operation only when they have been granted with the <strong id="dli_02_0037__b842352706111721">grant</strong> and <strong id="dli_02_0037__b842352706111725">revoke</strong> permissions.</p>
|
|
<ul id="dli_02_0037__ul47762655161943"><li id="dli_02_0037__li19832010161943"><strong id="dli_02_0037__b842352706111754">grant</strong>: Indicates to grant users with permissions.</li><li id="dli_02_0037__li20261679161943"><strong id="dli_02_0037__b84235270611189">revoke</strong>: Indicates to revoke permissions.</li><li id="dli_02_0037__li58312788161943"><strong id="dli_02_0037__b842352706111823">update</strong>: Indicates to clear all the original permissions and assign the permissions in the provided permission array.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0037__row142119511444"><td class="cellrowborder" valign="top" width="13.5%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0037__p742117519441">privileges</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.73%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0037__p1942117524415">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.18%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0037__p16421195114410">Array of Strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.59%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0037__p96314379434">List of permissions to be granted, revoked, or updated. The following permissions are supported:</p>
|
|
<ul id="dli_02_0037__ul166010412433"><li id="dli_02_0037__li2442422174419"><strong id="dli_02_0037__b1994415818548">SUBMIT_JOB</strong>: indicates to submit a job.</li><li id="dli_02_0037__li6722113413448"><strong id="dli_02_0037__b1196315235549">CANCEL_JOB</strong>: indicates to cancel a job.</li><li id="dli_02_0037__li9876104413442"><strong id="dli_02_0037__b320284319547">DROP_QUEUE</strong>: indicates to a delete a queue.</li><li id="dli_02_0037__li164601510175017"><strong id="dli_02_0037__b989913431233">GRANT_PRIVILEGE</strong>: indicates to assign a permission.</li><li id="dli_02_0037__li413524620502"><strong id="dli_02_0037__b67710565231">REVOKE_PRIVILEGE</strong>: indicates to revoke a permission.</li><li id="dli_02_0037__li825615365112"><strong id="dli_02_0037__b164611519132412">SHOW_PRIVILEGE</strong>: indicates to view other user's permissions.</li><li id="dli_02_0037__li115942176538"><strong id="dli_02_0037__b20571114517257">RESTART</strong>: indicates to restart the queue.</li><li id="dli_02_0037__li20903124145318"><strong id="dli_02_0037__b8718482619">SCALE_QUEUE</strong>: indicates to change the queue specifications.<div class="note" id="dli_02_0037__note1903424155315"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0037__p1990317247534">If the update list is empty, all permissions of the queue granted to the user are revoked.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0037__sa1f1a27b463a4b4aaad3505d949195ad"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0037__en-us_topic_0069077913_table49681121" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0037__en-us_topic_0069077913_row17907755"><th align="left" class="cellrowborder" valign="top" width="13.139999999999999%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0037__p5481173914437">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.469999999999999%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0037__p64816395439">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.469999999999999%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0037__p16481153917437">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.919999999999995%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0037__p20481139134318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0037__en-us_topic_0069077913_row49887316"><td class="cellrowborder" valign="top" width="13.139999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0037__en-us_topic_0069077913_p14340816">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.469999999999999%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0037__p147387311104">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.469999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0037__en-us_topic_0069077913_p3472406">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.919999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0037__p12191815131512">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0037__parmvalue62492715161030"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0037__en-us_topic_0069077913_row48356531"><td class="cellrowborder" valign="top" width="13.139999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0037__en-us_topic_0069077913_p24564930">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.469999999999999%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0037__p27388331015">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.469999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0037__en-us_topic_0069077913_p42128507">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.919999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0037__p32201159156">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0037__section15772143623410"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="dli_02_0037__screen2368089915305">{
|
|
"queue_name": "queue1",
|
|
"user_name": "tenant2",
|
|
"action": "grant",
|
|
"privileges" : ["DROP_QUEUE", "SUBMIT_JOB"]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0037__section9820224152937"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0037__screen3436117153018">{
|
|
"is_success": true,
|
|
"message": ""
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0037__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0037__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0037__tb12870f1c5f24b27abd55ca24264af36">Table 4</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0037__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0037__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0037__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0037__ab49d21f312644072a331f43e92baf853">Status Codes</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0037__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0037__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0037__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0037__p10675142010516">Authorization succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0037__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0037__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0037__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0037__row11188531568"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0037__p31891733561">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0037__p1789413865719">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0037__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0037__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 Code</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>
|
|
|