forked from docs/doc-exports
Wuwan, Qi
8675132585
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
174 lines
12 KiB
HTML
174 lines
12 KiB
HTML
<a name="css_03_0133"></a><a name="css_03_0133"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Cluster Detection Task</h1>
|
|
<div id="body0000001667757620"><div class="section" id="css_03_0133__section1054218321140"><h4 class="sectiontitle">Function</h4><p id="css_03_0133__p16542183216145">This API is used to create a cluster detection task.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0133__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="css_03_0133__p3544133221418">POST /v1.0/{project_id}/clusters/{cluster_id}/ai-ops</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0133__table35451732191416" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0133__row654573291415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0133__p1854643281416">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_0133__p1854683218145">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_0133__p185475328145">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_0133__p554711323142">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0133__row45451321142"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0133__p454873210140">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0133__p185481032191413">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0133__p1554819329145">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0133__p1354920325144">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_0133__row1954515325149"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0133__p1854923291413">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0133__p95501732131411">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0133__p9550143217148">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0133__p75511032131414">ID of the target cluster</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0133__section19551432121420"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0133__request_CreateAiOpsRequestBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="css_03_0133__row145521832101419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="css_03_0133__p1559123210146">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="css_03_0133__p6559832161416">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="css_03_0133__p9560103213143">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="css_03_0133__p1956018327145">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0133__row1755373215145"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0133__p135619322145">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0133__p0561163219144">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0133__p15621532111412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0133__p165621932151419">Detection task name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0133__row10553232121413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0133__p13563173214143">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0133__p1856316329142">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0133__p1756493212141">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0133__p18564432131413">Detection task description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0133__row1855314328148"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0133__p1856583291419">alarm</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0133__p75651329148">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0133__p4566153219143"><a href="#css_03_0133__request_alarm">alarm</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0133__p15566203231417">After the detection task is complete, an SMN alarm message is sent.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0133__request_alarm"></a><a name="request_alarm"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0133__request_alarm" frame="border" border="1" rules="all"><caption><b>Table 3 </b>alarm</caption><thead align="left"><tr id="css_03_0133__row056713325144"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0133__p1456812326143">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_0133__p656963241418">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_0133__p756903212149">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_0133__p35701132171416">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0133__row1756733215146"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0133__p13570133261414">level</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0133__p115715324143">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0133__p257123215142">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0133__p1357253241413">Sensitivity of an SMN alarm message.</p>
|
|
<ul id="css_03_0133__ul757253218146"><li id="css_03_0133__li1757219326145"><strong id="css_03_0133__b3573432161411">high</strong></li><li id="css_03_0133__li12573163213143"><strong id="css_03_0133__b19573133251417">medium</strong></li><li id="css_03_0133__li3573732201416"><strong id="css_03_0133__b1557473271417">suggestion</strong></li><li id="css_03_0133__li1457493241410"><strong id="css_03_0133__b65748323141">norisk</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0133__row8567932111413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0133__p17574183214146">smn_topic</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0133__p9575432131418">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0133__p9575173219146">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0133__p757683215143">SMN topic name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0133__section2057615324140"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0133__p1057763221415">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0133__section10577153241412"><h4 class="sectiontitle">Example Requests</h4><p id="css_03_0133__p757819328143">Create a cluster detection task.</p>
|
|
<pre class="screen" id="css_03_0133__screen19579103211414">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops
|
|
|
|
{
|
|
"name": " aiops-test ",
|
|
"description": "Create a cluster detection task.
|
|
",
|
|
"alarm":{
|
|
"level":"high",
|
|
"smn_topic":"aiops-test"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0133__section558243213141"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0133__p145821132161413">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0133__section958383241419"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0133__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0133__row958313211412"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0133__p10585193210147">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_0133__p45852323146">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0133__row165841232131412"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0133__p1958510320147">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0133__p258618324141">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0133__row858423219144"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0133__p175871732131417">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0133__p13587163251417">Invalid request.</p>
|
|
<p id="css_03_0133__p858893231411">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0133__row1558443218146"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0133__p7589732171418">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0133__p45894328146">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0133__p0589732171410">This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0133__row10584103221419"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0133__p959093216144">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0133__p4590103216147">The server does not meet one of the requirements that the requester puts on the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0133__section259119322141"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0133__p1759283291417">See <a href="css_03_0076.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0132.html">Intelligent O&M</a></div>
|
|
</div>
|
|
</div>
|
|
|