Help Center/ Cloud Search Service/ API Reference/ API V1/ Intelligent O&M/ Viewing Scheduled Check Settings for Intelligent O&M

Updated on 2026-01-09 GMT+08:00

Online Debugging

CLI Examples

View PDF

Viewing Scheduled Check Settings for Intelligent O&M

Function

CSS provides intelligent O&M to check potential risks in clusters on a daily basis. This API is used to obtain the scheduled check settings 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:showAiOpsSetting	Read	cluster *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

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

**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
check_type	String	Definition: Check type. Value range: full_detection: all check items. unavailability_detection: cluster unavailability check items. partial_detection: partial check items, select by setting check_items.
check_items	Array of strings	Definition: Select a subset of all check items, and enter the check item list. This parameter is available only when check_type is set to partial_detection. Value range: N/A
period	String	Definition: Intelligent O&M automatic check time, in the form of time followed by time zone, for example, 00:00 GMT+08:00. Value range: N/A

Example Requests

Viewing Scheduled Check Settings for Intelligent O&M

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

Example Responses

Status code: 200

Request succeeded.

{
  "check_type" : "partial_detection",
  "check_items" : [ "nodeDiskCheck", "dataNodeDiskBalanceCheck" ],
  "period" : "23:00 GMT+08:00"
}

Status Codes

Status Code	Description
200	Request succeeded.
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.