doc-exports/docs/dli/api-ref/dli_02_0016.html
Su, Xiaomeng 2374069890 DLI API 20230215 version
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-03-22 08:50:34 +00:00

248 lines
19 KiB
HTML

<a name="dli_02_0016"></a><a name="dli_02_0016"></a>
<h1 class="topictitle1">Viewing Details of a Queue</h1>
<div id="body1582012911461"><div class="section" id="dli_02_0016__section18998185384911"><h4 class="sectiontitle">Function</h4><p id="dli_02_0016__p342141019132">This API is used to list details of a specific queue in a project.</p>
</div>
<div class="section" id="dli_02_0016__s9e1b8ec5b57c422a942b19835da7d66e"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0016__en-us_topic_0069077927_ul10082125"><li id="dli_02_0016__en-us_topic_0069077927_li23630265">URI format<p id="dli_02_0016__en-us_topic_0069077927_p11345797"><a name="dli_02_0016__en-us_topic_0069077927_li23630265"></a><a name="en-us_topic_0069077927_li23630265"></a>GET /v1.0/{project_id}/queues/{queue_name}</p>
</li><li id="dli_02_0016__li1725612218454">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0016__en-us_topic_0069077803_table60779388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0016__en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="16.48%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0016__a420a62a594f9410eaea229ffc8037a61">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.94%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0016__en-us_topic_0069077803_p873025824211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.180000000000001%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0016__p1566313491425">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.400000000000006%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0016__a692d3cd97b464aed90ba6d841900a4a5">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0016__en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="16.48%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0016__en-us_topic_0069077803_p43412436">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.94%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0016__en-us_topic_0069077803_p26746391">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.180000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0016__p2066310498215">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.400000000000006%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0016__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_0016__row1691519137166"><td class="cellrowborder" valign="top" width="16.48%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0016__p58451326141618">queue_name</p>
</td>
<td class="cellrowborder" valign="top" width="13.94%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0016__p138451726171613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.180000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0016__p7663549924">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.400000000000006%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0016__p10845102621613">Specifies the name of a queue to be queried.</p>
<div class="note" id="dli_02_0016__note14431426201920"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0016__p6288122915199">The queue name is case-insensitive. The uppercase letters will be automatically converted to lowercase letters.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dli_02_0016__section20458182103"><h4 class="sectiontitle">Request</h4><p id="dli_02_0016__p1335216446318">None</p>
</div>
<div class="section" id="dli_02_0016__sd1ecb66580054b2ea403be8b2272a2c7"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0016__en-us_topic_0069077927_table56638444" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0016__en-us_topic_0069077927_row48911609"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0016__ae076f6b3f1bf463b9cc087fc566253d5">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.36%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0016__p12583123083811">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.489999999999998%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0016__a59685f4525af4d82a623288ff8ccb0f4">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65.14%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0016__en-us_topic_0069077927_p632718127368">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0016__en-us_topic_0069077927_row27919264"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__en-us_topic_0069077927_p46867877">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p9584230133817">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__en-us_topic_0069077927_p7327597">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__en-us_topic_0069077927_p56664447">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0016__parmvalue15544115155755"><b>true</b></span> indicates that the request is successfully executed.</p>
</td>
</tr>
<tr id="dli_02_0016__en-us_topic_0069077927_row40217981"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__en-us_topic_0069077927_p36431005">message</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p95842301382">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__en-us_topic_0069077927_p49163111">String</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__a4fa277540d3e42e48cec2027a36ca6bc">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
</td>
</tr>
<tr id="dli_02_0016__row1356812420129"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p10569114220124">queueName</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p15691942131215">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p13569134217129">String</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p16569742181211">Name of a queue.</p>
<div class="note" id="dli_02_0016__note0838845192213"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0016__p178381345102210">The queue name is case-insensitive. The uppercase letters will be automatically converted to lowercase letters.</p>
</div></div>
</td>
</tr>
<tr id="dli_02_0016__row43401748181215"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p123338931418">description</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p9333295141">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p133313912144">String</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p133331593147">Queue description.</p>
</td>
</tr>
<tr id="dli_02_0016__row114981240141011"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p99111683155">owner</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p391118841511">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p16911585157">String</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p59112088159">User who creates a queue.</p>
</td>
</tr>
<tr id="dli_02_0016__row174998404108"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p1126173912157">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p191261339151515">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p51261739141515">Long</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p1512633991520">Time when the queue is created. The timestamp is expressed in milliseconds.</p>
</td>
</tr>
<tr id="dli_02_0016__row3386182015718"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p0387142020573">queueType</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p33871720155711">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p23871920205719">String</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p143871020135713">Indicates the queue type.</p>
<ul id="dli_02_0016__ul105911528185918"><li id="dli_02_0016__li5591328145919">sql</li><li id="dli_02_0016__li57631034105911">general</li><li id="dli_02_0016__li158844231364">all</li></ul>
<p id="dli_02_0016__p592017412091">If this parameter is not specified, the default value <span class="parmvalue" id="dli_02_0016__parmvalue0231152115217"><b>sql</b></span> is used.</p>
</td>
</tr>
<tr id="dli_02_0016__row1850012406101"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p1742621810161">cuCount</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p184269182167">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p442615188165">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p104261918101617">Number of compute units (CUs) bound to a queue, that is, the number of CUs in the current queue.</p>
</td>
</tr>
<tr id="dli_02_0016__row6149326191115"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p127543294193">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p3754829161916">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p13754829171919">String</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p7754929111918">Resource ID of a queue.</p>
</td>
</tr>
<tr id="dli_02_0016__row21491526201117"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p12773715203">resource_mode</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p1977314113200">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p17773101152016">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p4773161142016">Resource mode</p>
<ul id="dli_02_0016__ul458452622013"><li id="dli_02_0016__li10584142642013"><strong id="dli_02_0016__b73296542002">0</strong>: Shared queue</li><li id="dli_02_0016__li16584152682012"><strong id="dli_02_0016__b11110105817015">1</strong>: Dedicated queue</li></ul>
</td>
</tr>
<tr id="dli_02_0016__row715022661111"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p0789741152015">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p1678954113205">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p978964110205">String</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p19208155822017">Enterprise project ID.</p>
<p id="dli_02_0016__p15789124119201"><strong id="dli_02_0016__b10294131110">0</strong> indicates the default enterprise project.</p>
<div class="note" id="dli_02_0016__note57351159214"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0016__p16736115132113">Users who have enabled Enterprise Management can set this parameter to bind a specified project.</p>
</div></div>
</td>
</tr>
<tr id="dli_02_0016__row1111045017219"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p202454106424">cu_spec</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p10245121074212">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p1424511012424">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p92451410194210">Specifications of a queue. For a queue whose billing mode is yearly/monthly, this parameter indicates the CU value of the yearly/monthly part. For a pay-per-use queue, this parameter indicates the initial value when a user purchases a queue.</p>
</td>
</tr>
<tr id="dli_02_0016__row1210920507216"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p182532155425">cu_scale_out_limit</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p162531157421">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p10253181574217">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p4253815184218">Upper limit of the CU value for elastic scaling of the current queue.</p>
</td>
</tr>
<tr id="dli_02_0016__row7108050132115"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0016__p12629182012428">cu_scale_in_limit</p>
</td>
<td class="cellrowborder" valign="top" width="9.36%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0016__p17629132084217">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.489999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0016__p12629152015426">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="65.14%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0016__p762912017421">Lower limit of the CU value for elastic scaling of the current queue.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0016__section15772143623410"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0016__p534664283414">None</p>
</div>
<div class="section" id="dli_02_0016__section59635464345"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0016__screen4559121772114">{
"is_success": true,
"message": "",
"owner": "testuser",
"description": "",
"queueName": "test",
"create_time": 1587613028851,
"queueType": "general",
"cuCount": 16,
"resource_id": "03d51b88-db63-4611-b779-9a72ba0cf58b",
"resource_mode": 0
,
"resource_type": "vm",
"cu_spec": 16
}</pre>
</div>
<div class="section" id="dli_02_0016__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0016__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0016__tb12870f1c5f24b27abd55ca24264af36">Table 3</a> describes the status code.</p>
<div class="tablenoborder"><a name="dli_02_0016__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0016__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status codes</caption><thead align="left"><tr id="dli_02_0016__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0016__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_0016__aea1d3bd107bb4c499da79a88832d256c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0016__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0016__a3153e07b3a9749adba92599fe6628fbf">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0016__p104431642124811">The query is successful.</p>
</td>
</tr>
<tr id="dli_02_0016__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0016__p184941532219">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0016__p2049413539219">Request error.</p>
</td>
</tr>
<tr id="dli_02_0016__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0016__p5537171216249">500</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0016__p953813124249">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0016__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0016__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_0193.html">Queue-related APIs (Recommended)</a></div>
</div>
</div>