forked from docs/doc-exports
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>
139 lines
9.2 KiB
HTML
139 lines
9.2 KiB
HTML
<a name="css_03_0136"></a><a name="css_03_0136"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining SMN Topics Available for Intelligent O&M Alarms</h1>
|
|
<div id="body0000001667597900"><div class="section" id="css_03_0136__section571513321142"><h4 class="sectiontitle">Function</h4><p id="css_03_0136__p2071520320140">This API is used to obtain SMN topics available for intelligent O&M alarms.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0136__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="css_03_0136__p871810321142">GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topics</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0136__table1172043212146" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0136__row7719133219145"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0136__p1872023216149">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_0136__p5721113291412">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_0136__p6722133211148">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_0136__p7722113212144">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0136__row15719113241414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0136__p372316326143">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0136__p1872413211145">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0136__p272423211414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0136__p107252323141">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_0136__row117192320143"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0136__p372693271411">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0136__p6726332101419">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0136__p772717324141">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0136__p127271732121415">ID of the cluster you want to query.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0136__section19729332181420"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0136__p9729123281419">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0136__section373013210143"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0136__p1473183219149"><strong id="css_03_0136__b197311532141419">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0136__response_ListSmnTopicsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="css_03_0136__row1873263220145"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0136__p87331332121419">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_0136__p8734532161419">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_0136__p1473418325143">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0136__row7732832141412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0136__p19735932181410">topicsName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0136__p873511325148">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0136__p17736143218149">SMN topic name list</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0136__section187368322144"><h4 class="sectiontitle">Example Requests</h4><p id="css_03_0136__p0737193215149">Obtain the intelligent O&M task list and details.</p>
|
|
<pre class="screen" id="css_03_0136__screen1737193220145">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0136__section773833210140"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0136__p973833241419"><strong id="css_03_0136__b1773823213146">Status code: 200</strong></p>
|
|
<p id="css_03_0136__p1173883201418">Request succeeded.</p>
|
|
<pre class="screen" id="css_03_0136__screen12740193212140">{
|
|
"aiops_list" : [ {
|
|
"id" : "7381a80b-68cb-4b9e-8226-37d686b18b1d",
|
|
"name" : "aiops-test",
|
|
"desc" : "",
|
|
"status" : 200,
|
|
"summary" : {
|
|
"high" : 1,
|
|
"medium" : 0,
|
|
"suggestion" : 1
|
|
},
|
|
"create_time" : 1687944156750,
|
|
"smn_status" : "not_open",
|
|
"smn_fail_reason" : null,
|
|
"task_risks" : [ {
|
|
"riskType" : "Check for snapshot creation failures and snapshot records in the cluster in the last seven days.",
|
|
"level" : "suggestion",
|
|
"desc" : "There are no snapshot records in the cluster in the last seven days.",
|
|
"suggestion" : "You are advised to enable cluster snapshot and ensure that snapshots are successfully created within seven days. If snapshot creation fails, click the cluster name, and check the failure details on the Cluster Snapshots and Logs pages."
|
|
}, {
|
|
"riskType" : "Check the number of nodes in the cluster and the number of AZs to evaluate the high availability status of the distributed Elasticsearch cluster.",
|
|
"level" : "high",
|
|
"desc" : "The current cluster has one or two nodes. If a node is faulty, the entire cluster may become unavailable. The service availability risk is high.",
|
|
"suggestion" : "You are advised to change the cluster to a multi-AZ cluster. Procedure: On the CSS cluster console, choose **Clusters** > **Elasticsearch**. In the **Operation** column of a cluster, choose **More** > **Modify Configuration**. Click the **Change AZ** tab and add AZs. Click the **Scale Cluster** tab and change the number of nodes."
|
|
} ]
|
|
} ],
|
|
"total_size" : 1
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0136__section187491732191417"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0136__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0136__row13750173215141"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0136__p1075023241415">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_0136__p18751183211142">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0136__row175013321144"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0136__p6751103271416">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0136__p57521932151414">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0136__row1875063241416"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0136__p15752153261418">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0136__p12753193291412">Invalid request.</p>
|
|
<p id="css_03_0136__p1775393218149">Modify the request instead of retrying.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0136__row1975017325146"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0136__p575473241411">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0136__p1775493221416">The request cannot be processed due to a conflict.</p>
|
|
<p id="css_03_0136__p87543326142">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_0136__row167501832141415"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0136__p197551232151419">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0136__p14755133271418">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_0136__section1175611327141"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0136__p07564329140">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>
|
|
|