forked from docs/doc-exports
Zheng, Xiu
bf0cbd66f9
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
181 lines
12 KiB
HTML
181 lines
12 KiB
HTML
<a name="css_03_0117"></a><a name="css_03_0117"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining the Task List of Parameter Configurations</h1>
|
|
<div id="body0000001526890505"><div class="section" id="css_03_0117__section1461381452814"><h4 class="sectiontitle">Function</h4><p id="css_03_0117__p2614161432819">This API is used to obtain the parameter configuration task list of a cluster.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section161531417288"><h4 class="sectiontitle">URI</h4><p id="css_03_0117__p1561561462817">GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0117__table561711143289" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0117__row2616914182810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0117__p16617114122814">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0117__p7618014192820">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0117__p3618101410283">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0117__p13622014102818">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0117__row1616131411281"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0117__p86226146289">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0117__p10623101416281">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0117__p11623414172819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0117__p46236148282">Project ID. For details about how to obtain the project ID and name, see <a href="css_03_0071.html">Obtaining the Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row561614143280"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0117__p5624111452819">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0117__p196249141289">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0117__p20624141442813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0117__p1762581402817">ID of the cluster you want to query.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section9625101412817"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0117__p1362510147281">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section1462661422819"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0117__p1062641442814"><strong id="css_03_0117__b962610146281">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0117__response_ListYmlsJobResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="css_03_0117__row18626614182819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0117__p7628141482818">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0117__p1662861410288">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0117__p17628141413288">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0117__row3627614162810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0117__p16281114132812">configList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0117__p1462981413285">Array of <a href="#css_03_0117__response_configListRsp">configListRsp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0117__p116291514192819">List of historical configuration changes</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0117__response_configListRsp"></a><a name="response_configListRsp"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0117__response_configListRsp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>configListRsp</caption><thead align="left"><tr id="css_03_0117__row20630141418287"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0117__p18633101420284">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0117__p1363341412815">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0117__p1634111452810">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0117__row116305142281"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0117__p6634101414282">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0117__p10635151418285">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0117__p6635121412820">Operation ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row363112146284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0117__p56361414142819">clusterId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0117__p10636181482816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0117__p96361144280">Cluster ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row96314143284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0117__p1163611442811">createAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0117__p16637131412815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0117__p176376142280">Creation time. Format: Unix timestamp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row96311314102810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0117__p86371114182819">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0117__p16637414172810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0117__p463891452813">Task execution status.</p>
|
|
<ul id="css_03_0117__ul9638161410285"><li id="css_03_0117__li17638101416281"><strong id="css_03_0117__b13638141472814">true</strong>: The operation is successful.</li><li id="css_03_0117__li163841412285"><strong id="css_03_0117__b46383143282">false</strong>: The execution failed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row36318146287"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0117__p363991432814">finishedAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0117__p1263911452816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0117__p763921416287">End time. If the creation has not been completed, the end time is <strong id="css_03_0117__b1663961410289">null</strong>. Format: Unix timestamp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row36311414192811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0117__p1664014146281">modifyDeleteReset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0117__p8640121417281">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0117__p176401614182813">History of parameter setting modifications.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row66312014122812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0117__p464010141288">failedMsg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0117__p18641614122814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0117__p18641214122815">Returned error message. If the status is <strong id="css_03_0117__b864121419289">success</strong>, the value of this parameter is <strong id="css_03_0117__b664110141288">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section66411714192812"><h4 class="sectiontitle">Example Requests</h4><p id="css_03_0117__p3642101410286">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section196421514182813"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0117__p8642171412813"><strong id="css_03_0117__b76424146287">Status code: 200</strong></p>
|
|
<p id="css_03_0117__p66424141281">Request succeeded.</p>
|
|
<pre class="screen" id="css_03_0117__screen3643191415281">{
|
|
"configList" : [ {
|
|
"id" : "7ed7258a-60a8-46fe-8814-52819d491b80",
|
|
"clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c",
|
|
"createAt" : 1633658735000,
|
|
"status" : "success",
|
|
"finishedAt" : null,
|
|
"modifyDeleteReset" : "{\"modify\":{\"elasticsearch.yml\":{\"thread_pool.force_merge.size\":\"1\"}}}",
|
|
"failedMsg" : ""
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section26451143286"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0117__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0117__row5646181402812"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0117__p86471414192820">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="css_03_0117__p2647201416284">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0117__row17646111422820"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0117__p166481214172818">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0117__p1464821411283">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row264641492810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0117__p6648141419287">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0117__p76491814162816">Invalid request.</p>
|
|
<p id="css_03_0117__p26491014152818">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row14646141422818"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0117__p26491014182815">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0117__p4650131462814">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="css_03_0117__p18650614132817">The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row17646614132818"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0117__p665013149287">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0117__p86511714182811">The server did not meet one of the preconditions contained in the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0115.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|