vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dli/api-ref/dli_02_0291.html
Su, Xiaomeng 483e5cc6cc dli_api_20240430 
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>
2024-05-15 12:04:03 +00:00

237 lines
18 KiB
HTML
Raw Blame History

<a name="dli_02_0291"></a><a name="dli_02_0291"></a>
<h1 class="topictitle1">Creating a Scheduled CU Change (Discarded)</h1>
<div id="body1594192554763"><div class="section" id="dli_02_0291__section18998185384911"><h4 class="sectiontitle">Function</h4><p id="dli_02_0291__p342141019132">This API is used to create a scheduled CU change, that is, to create a scheduled CU change for a specified queue.</p>
<div class="note" id="dli_02_0291__note794562214412"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0291__dli_02_0298_p69451622184111">This API has been discarded and is not recommended.</p>
</div></div>
</div>
<div class="section" id="dli_02_0291__s9e1b8ec5b57c422a942b19835da7d66e"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0291__en-us_topic_0069077927_ul10082125"><li id="dli_02_0291__en-us_topic_0069077927_li23630265">URI format<p id="dli_02_0291__en-us_topic_0069077927_p11345797"><a name="dli_02_0291__en-us_topic_0069077927_li23630265"></a><a name="en-us_topic_0069077927_li23630265"></a>POST /v1/{project_id}/queues/{queue_name}/plans</p>
</li><li id="dli_02_0291__li1725612218454">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0291__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_0291__en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="13.900000000000002%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0291__a420a62a594f9410eaea229ffc8037a61">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.42%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0291__en-us_topic_0069077803_p873025824211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.52%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0291__p484055985412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.16%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0291__a692d3cd97b464aed90ba6d841900a4a5">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0291__en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0291__en-us_topic_0069077803_p43412436">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.42%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0291__en-us_topic_0069077803_p26746391">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.52%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0291__p484112591540">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0291__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_0291__row1691519137166"><td class="cellrowborder" valign="top" width="13.900000000000002%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0291__p58451326141618">queue_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.42%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0291__p138451726171613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.52%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0291__p684165975410">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.16%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0291__p10845102621613">Name of the queue for which you want to set a scheduled scaling plan. The name can contain only digits, letters, and underscores (_), but cannot contain only digits or start with an underscore (_). The name contains 1 to 128 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dli_02_0291__section20458182103"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0291__table75729474247" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0291__row55738472249"><th align="left" class="cellrowborder" valign="top" width="16.41%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0291__p11573204732411">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.48%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0291__p65731647142420">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.23%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0291__p95731947152415">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.88%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0291__p8573144792417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0291__row8573164711249"><td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0291__p117469267274">plan_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.48%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0291__p19746826192715">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.23%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0291__p1974611263274">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0291__p179981558122915">Name of a CU change. The name can contain only digits, letters, and underscores (_), but cannot contain only digits or start with an underscore (_).</p>
</td>
</tr>
<tr id="dli_02_0291__row9574747192410"><td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0291__p8747142615270">target_cu</p>
</td>
<td class="cellrowborder" valign="top" width="10.48%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0291__p674742662718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.23%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0291__p074712269273">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0291__p1681616603013">Target value of the CU in the scheduled CU change.</p>
</td>
</tr>
<tr id="dli_02_0291__row957484782415"><td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0291__p14747926112716">start_hour</p>
</td>
<td class="cellrowborder" valign="top" width="10.48%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0291__p674782613279">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.23%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0291__p16747126192711">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0291__p9707193053011">Specifies the start hour of the scheduled CU change.</p>
</td>
</tr>
<tr id="dli_02_0291__row1536285612613"><td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0291__p97471726202711">start_minute</p>
</td>
<td class="cellrowborder" valign="top" width="10.48%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0291__p9747142618273">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.23%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0291__p167473262273">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0291__p1637841103017">Specifies the start minute of a scheduled CU change.</p>
</td>
</tr>
<tr id="dli_02_0291__row83634561261"><td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0291__p574742672711">repeat_day</p>
</td>
<td class="cellrowborder" valign="top" width="10.48%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0291__p15747426192714">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.23%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0291__p187471326132719">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0291__p121181756103110">Specifies the repetition period of a scheduled CU change. You can select one or more days from Monday to Sunday, or do not select any day. If this parameter is not specified, the scheduled CU change will be executed at the time specified by <strong id="dli_02_0291__b1380901217120">start_hour: start_minute</strong> after the current time. Example:</p>
<pre class="screen" id="dli_02_0291__screen0538176143217">"repeat_day": ["MONDAY", "TUESDAY", "WEDNESDAY","SUNDAY"]</pre>
</td>
</tr>
<tr id="dli_02_0291__row33641856162617"><td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0291__p1174820262273">valid_date_begin</p>
</td>
<td class="cellrowborder" valign="top" width="10.48%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0291__p1748026102713">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.23%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0291__p13748326142713">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0291__p16862154113016">Start time of the validity period (13-digit timestamp)</p>
</td>
</tr>
<tr id="dli_02_0291__row1242313382714"><td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0291__p18748192613273">valid_date_end</p>
</td>
<td class="cellrowborder" valign="top" width="10.48%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0291__p5748152642714">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.23%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0291__p1774892652720">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0291__p551490123111">End time of the validity period (13-digit timestamp)</p>
</td>
</tr>
<tr id="dli_02_0291__row342393172713"><td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0291__p19748122682720">activate</p>
</td>
<td class="cellrowborder" valign="top" width="10.48%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0291__p12748426112719">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.23%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0291__p7748142615276">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0291__p158321350316">Indicates whether the scheduled CU change is activated. The default value is <span class="parmvalue" id="dli_02_0291__parmvalue14435338131510"><b>true</b></span>, indicating that the change is activated.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0291__sd1ecb66580054b2ea403be8b2272a2c7"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0291__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_0291__en-us_topic_0069077927_row48911609"><th align="left" class="cellrowborder" valign="top" width="11.58%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0291__ae076f6b3f1bf463b9cc087fc566253d5">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.66%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0291__p12583123083811">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.239999999999998%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0291__a59685f4525af4d82a623288ff8ccb0f4">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.52%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0291__en-us_topic_0069077927_p632718127368">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0291__en-us_topic_0069077927_row27919264"><td class="cellrowborder" valign="top" width="11.58%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0291__en-us_topic_0069077927_p46867877">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0291__p9584230133817">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.239999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0291__en-us_topic_0069077927_p7327597">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="64.52%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0291__en-us_topic_0069077927_p56664447">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0291__parmvalue1387114872015"><b>true</b></span> indicates that the request is successfully executed.</p>
</td>
</tr>
<tr id="dli_02_0291__en-us_topic_0069077927_row40217981"><td class="cellrowborder" valign="top" width="11.58%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0291__en-us_topic_0069077927_p36431005">message</p>
</td>
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0291__p95842301382">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.239999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0291__en-us_topic_0069077927_p49163111">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.52%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0291__a4fa277540d3e42e48cec2027a36ca6bc">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_0291__section15772143623410"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0291__p1399531558">Create a scaling plan named <strong id="dli_02_0291__b1667615815316">plan_A</strong> for the queue. According to the plan, the queue is scaled out at 20:30 on Monday, Tuesday, Wednesday, and Sunday, to 64 CUs.</p>
<pre class="screen" id="dli_02_0291__screen764214332619">{
"plan_name": "plan_A",
"target_cu": 64,
"start_hour": 20,
"start_minute": 30,
"repeat_day": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"SUNDAY"
],
"valid_date_begin": 1590949800000,
"valid_date_end": 1591727400000,
"activate": true
}</pre>
</div>
<div class="section" id="dli_02_0291__section59635464345"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0291__screen4559121772114">{
"is_success": true,
"message": ""
}</pre>
</div>
<div class="section" id="dli_02_0291__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0291__acef1445366354016b2ed90921927a555"><a href="#dli_02_0291__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 4</a> describes status codes.</p>
<div class="tablenoborder"><a name="dli_02_0291__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0291__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0291__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="17.580000000000002%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0291__afa33b7f5b0ac4d008ebcf6493f629b24">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="82.42%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0291__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0291__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="17.580000000000002%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0291__a8c63a97e3bad402ebaead0bd99cad632">200</p>
</td>
<td class="cellrowborder" valign="top" width="82.42%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0291__p161153323162">Scheduled CU change created successfully.</p>
</td>
</tr>
<tr id="dli_02_0291__row1012873412149"><td class="cellrowborder" valign="top" width="17.580000000000002%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0291__p1912813348145">400</p>
</td>
<td class="cellrowborder" valign="top" width="82.42%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0291__p154287617445">Request failure.</p>
</td>
</tr>
<tr id="dli_02_0291__row963316895812"><td class="cellrowborder" valign="top" width="17.580000000000002%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0291__p76331683586">500</p>
</td>
<td class="cellrowborder" valign="top" width="82.42%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0291__p863315895817">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0291__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0291__dli_02_0225_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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0291__dli_02_0225_table847819307387" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Error codes</caption><thead align="left"><tr id="dli_02_0291__dli_02_0225_row2479163016383"><th align="left" class="cellrowborder" valign="top" width="14.299999999999999%" id="mcps1.3.8.3.2.3.1.1"><p id="dli_02_0291__dli_02_0225_p114796309389">Error Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85.7%" id="mcps1.3.8.3.2.3.1.2"><p id="dli_02_0291__dli_02_0225_p1647973053817">Error Message</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0291__dli_02_0225_row1047920308387"><td class="cellrowborder" valign="top" width="14.299999999999999%" headers="mcps1.3.8.3.2.3.1.1 "><p id="dli_02_0291__p11273151383718">DLI.0999</p>
</td>
<td class="cellrowborder" valign="top" width="85.7%" headers="mcps1.3.8.3.2.3.1.2 "><p id="dli_02_0291__p1098813914378">Queue plans create failed. The plan plan_A can not generate a scale plan, please check all time settings for the plan.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0361.html">Queue-related APIs (Discarded)</a></div>
</div>
</div>
View Git Blame Copy Permalink