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>
149 lines
10 KiB
HTML
149 lines
10 KiB
HTML
<a name="css_03_0096"></a><a name="css_03_0096"></a>
|
|
|
|
<h1 class="topictitle1">Viewing the Job List</h1>
|
|
<div id="body0000001475549822"><div class="section" id="css_03_0096__section6926151723715"><h4 class="sectiontitle">Function</h4><p id="css_03_0096__p19927151713378">This API is used to query the job list in the logs of a cluster.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0096__section13927141703715"><h4 class="sectiontitle">Debugging</h4><p id="css_03_0096__p139287175372">You can debug this API in . Automatic authentication is supported.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0096__section592931763715"><h4 class="sectiontitle">URI</h4><p id="css_03_0096__p1492991715378">GET /v1.0/{project_id}/clusters/{cluster_id}/logs/records</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0096__table16931191743719" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0096__row14930181713372"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0096__p79319170377">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_0096__p99343173379">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_0096__p18934151712373">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_0096__p79353178377">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0096__row119301917123718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0096__p59361176377">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0096__p10937131793710">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0096__p393771716378">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0096__p79381117123713">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_0096__row0930151714371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0096__p1193915176379">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0096__p7939101718376">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0096__p17940417103713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0096__p1394111172378">ID of the cluster to be queried</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0096__section199411317173717"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0096__p129422178379">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0096__section14943121716379"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0096__p994381716376"><strong id="css_03_0096__b301714595113027">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0096__response_ListLogsJobResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameter</caption><thead align="left"><tr id="css_03_0096__row119441917193717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="css_03_0096__p894516176375">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_0096__p894661715379">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_0096__p5946191719379">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0096__row17944111719371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0096__p1294721711379">clusterLogRecord</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0096__p7948181783710">Array of <a href="#css_03_0096__response_clusterLogRecord">clusterLogRecord</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0096__p1894801723714">Entity object of cluster log records</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0096__response_clusterLogRecord"></a><a name="response_clusterLogRecord"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0096__response_clusterLogRecord" frame="border" border="1" rules="all"><caption><b>Table 3 </b>clusterLogRecord</caption><thead align="left"><tr id="css_03_0096__row12949117203714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="css_03_0096__p2095171714371">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_0096__p29525177379">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_0096__p795291783715">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0096__row15949141753712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0096__p895391793715">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0096__p495411711373">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0096__p109549174370">Log task ID, which is generated based on the system UUID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0096__row14949617163714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0096__p29557178379">clusterId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0096__p99556178377">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0096__p199563174373">Cluster ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0096__row19498177373"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0096__p7956111743713">createAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0096__p1195701719371">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0096__p1995715174374">Creation time. Format: Unix timestamp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0096__row594931717373"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0096__p2958617193710">logPath</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0096__p79581317153719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0096__p395916179374">Storage path of backup logs in the OBS bucket</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0096__row5950417133720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0096__p10959171763713">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0096__p11960101713374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0096__p2096018178378">Task status. The value can be:</p>
|
|
<ul id="css_03_0096__ul17961161783715"><li id="css_03_0096__li8961117143710"><strong id="css_03_0096__b14561194385519">RUNNING</strong>: The backup is in progress.</li><li id="css_03_0096__li17961517203719"><strong id="css_03_0096__b7229351155516">SUCCESS</strong>: The backup is successful.</li><li id="css_03_0096__li1496281714371"><strong id="css_03_0096__b1456412266571">FAIL</strong>: The backup fails.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0096__row295010171378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0096__p14963181753718">finishedAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0096__p20964111714371">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0096__p4965121723717">End time. If the creation has not been completed, the end time is <strong id="css_03_0096__b1275411395572">null</strong>. Format: Unix timestamp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0096__row19950017183710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0096__p1396681743714">jobTypes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0096__p69661017133718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0096__p19676173371">Task type. The value can be:</p>
|
|
<ul id="css_03_0096__ul4968141716370"><li id="css_03_0096__li396831716379"><strong id="css_03_0096__b17748195717570">Manual</strong></li><li id="css_03_0096__li9968111717372"><strong id="css_03_0096__b245416005812">Auto</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0096__row795071743713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0096__p49691417133714">failedMsg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0096__p7970101753720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0096__p89701217123712">Error message. If the task is not failed, the value of this parameter is <strong id="css_03_0096__b7918198588">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0096__row109501517153712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0096__p1997116178377">jobId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0096__p9971121711374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0096__p11972917163719">Task ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0093.html">Log Management</a></div>
|
|
</div>
|
|
</div>
|
|
|