forked from docs/doc-exports
Zheng, Xiu
99a2d77599
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>
183 lines
12 KiB
HTML
183 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__section066555272214"><h4 class="sectiontitle">Function</h4><p id="css_03_0117__p9665105215229">This API is used to obtain the task list of parameter configurations.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section1866514525220"><h4 class="sectiontitle">Debugging</h4><p id="css_03_0117__p1766675210223">You can debug this API in . Automatic authentication is supported.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section19666105212219"><h4 class="sectiontitle">URI</h4><p id="css_03_0117__p1566785219224">GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0117__table19669165262217" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0117__row1766712529225"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0117__p56701852102216">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0117__p18670195215228">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0117__p267018529228">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0117__p46715522226">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0117__row4668152132212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0117__p13671105232214">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0117__p1671852172211">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0117__p1367215242210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0117__p3672185272210">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row16668105219223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0117__p76727521221">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0117__p467317522227">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0117__p2673135216224">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0117__p16674952112217">ID of the cluster to be queried</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section36751452142219"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0117__p2675175216221">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section2675352202219"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0117__p15676175219223"><strong id="css_03_0117__b12645838842383">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 parameter</caption><thead align="left"><tr id="css_03_0117__row18677105232215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="css_03_0117__p10678652132210">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="css_03_0117__p16780526226">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="css_03_0117__p20679752122217">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0117__row17677175242213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0117__p1167995215228">configList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0117__p667911525224">Array of <a href="#css_03_0117__response_configListRsp">configListRsp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0117__p568065202220">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__row3681252162214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="css_03_0117__p1683155222217">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="css_03_0117__p17683125202211">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="css_03_0117__p1268345217229">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0117__row26810529225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0117__p168365212211">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0117__p668410525229">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0117__p66841352132220">Action ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row10681852142215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0117__p6684252152216">clusterId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0117__p8685115232220">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0117__p16685552102212">Cluster ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row1068125218228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0117__p146861652202215">createAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0117__p16686155213227">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0117__p368615523226">Creation time. Format: Unix timestamp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row868116521221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0117__p368745282211">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0117__p166871852102214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0117__p068895218221">Task execution status.</p>
|
|
<ul id="css_03_0117__ul156881652122218"><li id="css_03_0117__li2688252132215">true: The operation is successful.</li><li id="css_03_0117__li2689105219221">false: The execution failed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row11682115252212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0117__p8689115242218">finishedAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0117__p169045215227">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0117__p12690135262211">End time. If the creation has not been completed, the end time is <strong id="css_03_0117__b361766557105932">null</strong>. Format: Unix timestamp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row1568214525222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0117__p116901852152210">modifyDeleteReset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0117__p136911652122217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0117__p2691155222214">History of parameter configuration modifications</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row11682195272217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0117__p1369185252216">failedMsg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0117__p1469165214228">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0117__p1869295232213">Returned error message. If the status is <strong id="css_03_0117__b181111449715">success</strong>, the value of this parameter is <strong id="css_03_0117__b18675950773">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section469245216223"><h4 class="sectiontitle">Request Example</h4><p id="css_03_0117__p9692185202215">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0117__section156921452162212"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0117__p1169315521229"><strong id="css_03_0117__b17183011502383">Status code: 200</strong></p>
|
|
<p id="css_03_0117__p11693115292210">The request is processed successfully.</p>
|
|
<pre class="screen" id="css_03_0117__screen9694105242214">{
|
|
"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__section1669665214226"><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__row1369755292215"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="css_03_0117__p5698152162214">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="css_03_0117__p2698165222214">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0117__row106971452162220"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0117__p126991152202214">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0117__p96995527227">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row106971252132218"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0117__p176991352112220">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0117__p11700152112218">Invalid request.</p>
|
|
<p id="css_03_0117__p5700135213229">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row9697155210226"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0117__p77011252152212">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0117__p18701205222219">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0117__p1701145292211">This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0117__row5697175292217"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0117__p7702135262217">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0117__p970235242211">The server does not meet one of the requirements that the requester puts on 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>
|
|
|