Viewing Intelligent O&M Check Items

Function

CSS provides intelligent O&M to check potential risks in clusters. This API is used to obtain the check items for intelligent O&M.

It is available for Elasticsearch and OpenSearch.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
css:cluster:showAiOpsDetector	Read	cluster *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/detector

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A
cluster_id	Yes	String	Definition: ID of the cluster to be queried. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
full_detection	Array of AiOpsDetector objects	Definition: Full check items. The IDs, names, and descriptions of full check items will be returned.
unavailability_detection	Array of AiOpsDetector objects	Definition: Cluster unavailability check items. The IDs, names, and descriptions of all cluster unavailability check items will be returned.

**Table 3** AiOpsDetector
Parameter	Type	Description
id	String	Definition: ID of a supported check item. Value range: N/A
name	String	Definition: Check item name. Value range: N/A
desc	String	Definition: Check item description. Value range: N/A

Example Requests

Viewing Intelligent O&M Check Items

GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops/detector

Example Responses

Status code: 200

Intelligent O&M check items

{
  "full_detection" : [ {
    "id" : "nodeDiskCheck",
    "name" : "Data Node Disk Usage Check",
    "desc" : "Identify data nodes (including cold data nodes) with the highest disk usage in the cluster. Excessive disk usage can affect cluster stability. [N]High risk: When a node's disk usage reaches 85%, no new index replicas will be allocated to it. [N]Medium risk: When a node's disk usage exceeds 80%, take immediate action to prevent further increase."
  } ],
  "unavailability_detection" : [ {
    "id" : "dataNodeDiskBalanceCheck",
    "name" : "Data Node Disk Usage Balance Check",
    "desc" : "Check whether disk usage is balanced across all regular data nodes and cold data nodes. Unbalanced disk usage may cause performance issues. [N]Risk levels: [N]High risk: Maximum disk usage difference between nodes ≥ 40% [N]Medium risk: 25% ≤ Maximum disk usage difference between nodes < 40%."
  } ]
}

Status Codes

Status Code	Description
200	Intelligent O&M check items
400	Invalid request. Modify the request directly and do not attempt to retry it.
409	The request cannot be processed due to a conflict. This status code indicates that the resource that the client attempts to create already exists, or the request failed to be processed because of the update of the conflict request.
412	The server does not meet one of the preconditions that the client puts on the request.