vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dli/api-ref/dli_02_0196.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

392 lines
30 KiB
HTML
Raw Blame History

<a name="dli_02_0196"></a><a name="dli_02_0196"></a>
<h1 class="topictitle1">Querying All Queues</h1>
<div id="body1566551543152"><div class="section" id="dli_02_0196__s1f0e4fd3d502405199f36f78e68721aa"><h4 class="sectiontitle">Function</h4><p id="dli_02_0196__en-us_topic_0069077927_p104605496304">This API is used to list all queues under the project.</p>
</div>
<div class="section" id="dli_02_0196__s9e1b8ec5b57c422a942b19835da7d66e"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0196__en-us_topic_0069077927_ul10082125"><li id="dli_02_0196__en-us_topic_0069077927_li23630265">URI format<p id="dli_02_0196__en-us_topic_0069077927_p11345797"><a name="dli_02_0196__en-us_topic_0069077927_li23630265"></a><a name="en-us_topic_0069077927_li23630265"></a>GET/v1.0/{project_id}/queues</p>
</li><li id="dli_02_0196__li1725612218454">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0196__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_0196__en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="12.479999999999999%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0196__a420a62a594f9410eaea229ffc8037a61">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.49%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0196__en-us_topic_0069077803_p873025824211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.700000000000001%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0196__p19160432690">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.33%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0196__a692d3cd97b464aed90ba6d841900a4a5">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0196__en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="12.479999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0196__en-us_topic_0069077803_p43412436">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.49%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0196__en-us_topic_0069077803_p26746391">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.700000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0196__p1716119328910">String</p>
</td>
<td class="cellrowborder" valign="top" width="61.33%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0196__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>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0196__en-us_topic_0069078607_en-us_topic_0069077926_table52036772" frame="border" border="1" rules="all"><caption><b>Table 2 </b>query parameter description</caption><thead align="left"><tr id="dli_02_0196__en-us_topic_0069078607_en-us_topic_0069077926_row6711263"><th align="left" class="cellrowborder" valign="top" width="21.45%" id="mcps1.3.2.2.2.2.2.5.1.1"><p id="dli_02_0196__en-us_topic_0069078607_en-us_topic_0069077926_p1641446825">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.15%" id="mcps1.3.2.2.2.2.2.5.1.2"><p id="dli_02_0196__en-us_topic_0069078607_en-us_topic_0069077926_p20413469220">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.809999999999999%" id="mcps1.3.2.2.2.2.2.5.1.3"><p id="dli_02_0196__en-us_topic_0069078607_en-us_topic_0069077926_p124174619213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.59%" id="mcps1.3.2.2.2.2.2.5.1.4"><p id="dli_02_0196__en-us_topic_0069078607_en-us_topic_0069077926_p0413461523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0196__row2860739104812"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0196__p37621320164910">queue_type</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0196__p1076222024913">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0196__p9762152013494">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0196__p05114365019">Type of the queue. The options are as follows:</p>
<ul id="dli_02_0196__ul198113496355"><li id="dli_02_0196__li6819490356"><strong id="dli_02_0196__b152551032116">sql</strong>: queues for SQL jobs</li><li id="dli_02_0196__li68154920350"><strong id="dli_02_0196__b1922254582112">general</strong>: queues for Flink and Spark Jar jobs</li><li id="dli_02_0196__li0811493352"><strong id="dli_02_0196__b262892182319">all</strong>: queues of all types</li></ul>
<p id="dli_02_0196__p113018115019">If this parameter is not specified, the default value <strong id="dli_02_0196__b9468357181417">sql</strong> is used.</p>
</td>
</tr>
<tr id="dli_02_0196__row128798448257"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0196__p2880154411255">with-priv</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0196__p128801344102512">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0196__p148801944192512">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0196__p5334029171114">Whether to return permission information.</p>
</td>
</tr>
<tr id="dli_02_0196__row17123105312819"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0196__p173531822134415">page-size</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0196__p1135352213442">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0196__p235312234419">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0196__p15353152217446">Maximum number of lines displayed on each page. The default value is <strong id="dli_02_0196__b461110346117">Integer.MAX_VALUE</strong>, indicating that all results are displayed on one page.</p>
</td>
</tr>
<tr id="dli_02_0196__row18165751152812"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0196__p1135422254418">current-page</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0196__p835462244419">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0196__p153541522114417">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0196__p14354102213441">Current page number. The default value is <strong id="dli_02_0196__b15308143816214">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0196__row9821104818289"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0196__p1822648182816">order</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0196__p197421111290">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0196__p1374161132919">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0196__p17912152562914">Filed based on which queues are ordered</p>
<p id="dli_02_0196__p128221483284">The default value is <strong id="dli_02_0196__b449611321757">queue_name_asc</strong> (alphabetically ascending order on queue names). Other options are <strong id="dli_02_0196__b1995991218918">queue_name_desc</strong> (alphabetically descending order on queue names), <strong id="dli_02_0196__b207777341895">cu_asc</strong> (ascending order on CUs), and <strong id="dli_02_0196__b11719115117917">cu_desc</strong> (descending order on CUs).</p>
</td>
</tr>
<tr id="dli_02_0196__row1241118203285"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0196__p1041282012282">tags</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0196__p20412182010288">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0196__p184121200282">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.59%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0196__p34123202287">Query results are filtered by tag.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dli_02_0196__section20458182103"><h4 class="sectiontitle">Request</h4><p id="dli_02_0196__p2562135915108">None</p>
</div>
<div class="section" id="dli_02_0196__sd1ecb66580054b2ea403be8b2272a2c7"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0196__en-us_topic_0069077927_table56638444" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0196__en-us_topic_0069077927_row48911609"><th align="left" class="cellrowborder" valign="top" width="12.34%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0196__ae076f6b3f1bf463b9cc087fc566253d5">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.270000000000001%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0196__p12583123083811">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.279999999999998%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0196__a59685f4525af4d82a623288ff8ccb0f4">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.11000000000001%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0196__en-us_topic_0069077927_p632718127368">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0196__en-us_topic_0069077927_row27919264"><td class="cellrowborder" valign="top" width="12.34%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0196__en-us_topic_0069077927_p46867877">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0196__p9584230133817">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.279999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0196__en-us_topic_0069077927_p7327597">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="56.11000000000001%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0196__en-us_topic_0069077927_p56664447">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0196__parmvalue4993877595041"><b>true</b></span> indicates that the request is successfully executed.</p>
</td>
</tr>
<tr id="dli_02_0196__en-us_topic_0069077927_row40217981"><td class="cellrowborder" valign="top" width="12.34%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0196__en-us_topic_0069077927_p36431005">message</p>
</td>
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0196__p95842301382">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.279999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0196__en-us_topic_0069077927_p49163111">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.11000000000001%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0196__a4fa277540d3e42e48cec2027a36ca6bc">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
</td>
</tr>
<tr id="dli_02_0196__en-us_topic_0069077927_row16630181"><td class="cellrowborder" valign="top" width="12.34%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0196__en-us_topic_0069077927_p4867395">queues</p>
</td>
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0196__p13584143019385">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.279999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0196__en-us_topic_0069077927_p58268720">Array of Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.11000000000001%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0196__en-us_topic_0069077927_p22145871">Queue information For details, see <a href="#dli_02_0196__table15962201134413">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0196__table15962201134413"></a><a name="table15962201134413"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0196__table15962201134413" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="dli_02_0196__b92132426465">queues</strong> parameters description</caption><thead align="left"><tr id="dli_02_0196__row1096220117443"><th align="left" class="cellrowborder" valign="top" width="19.79%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0196__p1896291124419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.43%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0196__p139626184413">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.9%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0196__p16962201124418">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.88%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0196__p49622120447">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0196__row0963101184411"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p496310117448">queue_name</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p5963141114411">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p1696310134417">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p139631118446">Name of a queue.</p>
</td>
</tr>
<tr id="dli_02_0196__row1896331134410"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p1996310120443">description</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p15964181114413">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p9964171114411">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p496417117442">Queue description.</p>
</td>
</tr>
<tr id="dli_02_0196__row696413117442"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p19964315445">owner</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p29641113448">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p129648154414">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p19641417441">User who creates a queue.</p>
</td>
</tr>
<tr id="dli_02_0196__row29641164419"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p16964217441">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p179645119446">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p7964819440">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p129641719449">Time when the queue is created. The timestamp is expressed in milliseconds.</p>
</td>
</tr>
<tr id="dli_02_0196__row596451184412"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p159641410445">queue_type</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p196431124412">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p996415194415">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p89651910447">Queue type.</p>
<ul id="dli_02_0196__ul179651112447"><li id="dli_02_0196__li1196531194412">sql</li><li id="dli_02_0196__li189652114412">general</li><li id="dli_02_0196__li49652115449">all</li></ul>
<p id="dli_02_0196__p15969102471011">If this parameter is not specified, the default value <span class="parmvalue" id="dli_02_0196__parmvalue1281181619203"><b>sql</b></span> is used.</p>
</td>
</tr>
<tr id="dli_02_0196__row1996591144416"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p9965313448">cu_count</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p169651313449">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p09650104418">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p096614154412">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_0196__row139664111444"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p1596618119444">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p10967151204415">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p59671617442">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p1296711115447">Resource ID of a queue.</p>
</td>
</tr>
<tr id="dli_02_0196__row196717144420"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p1396791144419">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p119678164419">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p69672194415">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p796721154412">Enterprise project ID. <strong id="dli_02_0196__b165565121181">0</strong> indicates the default enterprise project. </p>
<div class="note" id="dli_02_0196__note3967517445"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0196__p39671113442">Users who have enabled Enterprise Management can set this parameter to bind a specified project.</p>
</div></div>
</td>
</tr>
<tr id="dli_02_0196__row199679144416"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p49671812443">cidr_in_vpc</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p159688111444">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p1396861134410">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p169681110446">The VPC CIDR block of the queue. </p>
</td>
</tr>
<tr id="dli_02_0196__row1296813115446"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p18968151144413">cidr_in_mgntsubnet</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p10968111174413">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p1896810174418">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p596812154414">CIDR block of the management subnet</p>
</td>
</tr>
<tr id="dli_02_0196__row1597151104414"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p49711718447">cidr_in_subnet</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p29711712440">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p169714124411">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p29721416445">Subnet CIDR block</p>
</td>
</tr>
<tr id="dli_02_0196__row497211164410"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p99729184420">resource_mode</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p19721711449">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p5972211446">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p8972201184410">Resource mode</p>
<ul id="dli_02_0196__ul29728174412"><li id="dli_02_0196__li139729174413">0: Shared queue</li><li id="dli_02_0196__li9972111124414">1: Dedicated queue</li></ul>
</td>
</tr>
<tr id="dli_02_0196__row09727124412"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p1197217119445">platform</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p59721419448">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p197311116445">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p521213347166">CPU architecture of queue compute resources.</p>
<ul id="dli_02_0196__ul1757084019163"><li id="dli_02_0196__li1698454313168">x86_64</li></ul>
</td>
</tr>
<tr id="dli_02_0196__row1192055214543"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p179202052185412">is_restarting</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p1792115215546">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p169211452185419">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p1092125215544">Whether to restart the queue. The default value is <strong id="dli_02_0196__b16443032145117">false</strong>.</p>
</td>
</tr>
<tr id="dli_02_0196__row157819515910"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p8443183513115">labels</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p94436359317">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p1844313353315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p444343518314">Tag information of the queue to be created, including the JSON string indicating whether the queue is Dual-AZ. Currently, only the value <span class="parmvalue" id="dli_02_0196__parmvalue1794914428470"><b>2</b></span> is supported, indicating that two queues are created.</p>
</td>
</tr>
<tr id="dli_02_0196__row152451810134211"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p202454106424">cu_spec</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p10245121074212">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p1424511012424">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p92451410194210">Specifications of a queue. </p>
</td>
</tr>
<tr id="dli_02_0196__row92531415114219"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p182532155425">cu_scale_out_limit</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p162531157421">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p10253181574217">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__p4253815184218">Upper limit of the CU value for elastic scaling of the current queue.</p>
</td>
</tr>
<tr id="dli_02_0196__row26294202423"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0196__p12629182012428">cu_scale_in_limit</p>
</td>
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0196__p17629132084217">No</p>
</td>
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0196__p12629152015426">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0196__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_0196__section15772143623410"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0196__p534664283414">None</p>
</div>
<div class="section" id="dli_02_0196__section59635464345"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0196__screen26687364164113">{
"is_success": "true",
"message": "",
"queues": [
{
"queue_name": "test",
"owner": "testuser",
"description": "",
"create_time": 1562221422671,
"queue_type": "spark",
"cu_count": 16,
"resource_id": "26afb850-d3c9-42c1-81c0-583d1163e80f",
"cidr_in_vpc": "10.0.0.0/8",
"cidr_in_subnet": "10.0.0.0/24",
"cidr_in_mgntsubnet": "10.23.128.0/24",
"resource_mode": 1,
"platform": "x86_64",
"is_restarting": "false",
"labels": "multi_az=2",
"resource_type": "vm",
"cu_spec": 16
}
]
}</pre>
</div>
<div class="section" id="dli_02_0196__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0196__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0196__tb12870f1c5f24b27abd55ca24264af36">Table 5</a> describes the status code.</p>
<div class="tablenoborder"><a name="dli_02_0196__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0196__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dli_02_0196__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0196__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_0196__aea1d3bd107bb4c499da79a88832d256c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0196__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0196__a3153e07b3a9749adba92599fe6628fbf">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0196__p104431642124811">The query is successful.</p>
</td>
</tr>
<tr id="dli_02_0196__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0196__p184941532219">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0196__p2049413539219">Request error.</p>
</td>
</tr>
<tr id="dli_02_0196__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0196__p5537171216249">500</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0196__p953813124249">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0196__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0196__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_0193.html">Queue-related APIs (Recommended)</a></div>
</div>
</div>
View Git Blame Copy Permalink