Help Center/ Cloud Search Service/ API Reference/ API V1/ Intelligent O&M/ Obtaining the Intelligent O&M Task List and Details
Updated on 2025-11-28 GMT+08:00
View PDF

Obtaining the Intelligent O&M Task List and Details

Function

CSS provides intelligent O&M to check potential risks in clusters. After a scan task is completed, check the risks identified by the task, confirm and handle these risks in a timely manner based on risk handling suggestions. This API is used to obtain the intelligent O&M task list and details.

Calling Method

For details, see Calling APIs.

URI

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

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
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition:

Pagination parameter, indicating the maximum number of records on a page. The default value is 10, indicating that 10 tasks are queried at a time.

Constraints:

N/A

Value range:

1-1000

Default value:

10

offset

No

Integer

Definition:

Offset. All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

Constraints:

N/A

Value range:

0-1000

Default value:

0

report

No

String

Definition:

Obtain the latest report or a historical report.

Constraints:

N/A

Value range:

  • current: Obtain only the latest check report.

  • history: Obtain only historical reports.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

aiops_list

Array of aiops_list objects

Definition:

Cluster risk detection task details.

Value range:

N/A

check_type

String

Definition:

Check scope

Value range:

  • full_detection: full check

  • unavailability_detection: cluster unavailability check

  • partial_detection: partial check

trigger_type

String

Definition:

Trigger type

Value range:

  • manual

  • auto
Table 4 aiops_list

Parameter

Type

Description

id

String

Definition:

ID of a cluster risk detection task.

Value range:

N/A

name

String

Definition:

Name of a cluster risk detection task.

Value range:

N/A

status

Integer

Definition:

Task execution status.

Value range:

  • 150: The function is disabled.

  • 200: The function is enabled.

  • 300: A message has been sent.

summary

summary object

Definition:

Cluster risk overview.

Value range:

N/A

create_time

String

Definition:

Time when a cluster risk detection task was created.

Value range:

Format: Unix timestamp.

task_risks

Array of AiOpsRiskObject objects

Definition:

Cluster risk details.

Value range:

N/A
Table 5 summary

Parameter

Type

Description

highRisk

Integer

Definition:

Number of high-risk items.

Value range:

0-100

mediumRisk

Integer

Definition:

Number of medium-risk items.

Value range:

0-100

normal

String

Definition:

Number of medium-risk items.

Value range:

0-100

suggestion

Integer

Definition:

Number of items that are normal.

Value range:

0-100
Table 6 AiOpsRiskObject

Parameter

Type

Description

id

String

Definition:

Check item ID

Value range:

N/A

Default value:

N/A

name

String

Definition:

Check item name

Value range:

N/A

Default value:

N/A

desc

String

Definition:

Check item description

Value range:

N/A

Default value:

N/A

level

String

Definition:

Risk level of the check result

Value range:

N/A

Default value:

N/A

result

String

Definition:

Check result

Value range:

N/A

Default value:

N/A

suggestion

String

Definition:

Handling suggestion

Value range:

N/A

Default value:

N/A

Example Requests

This API is used to obtain the intelligent O&M task list and details.

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

Example Responses

Status code: 200

Request succeeded.

[ {
  "id" : "0f896cea-c56a-4235-8cf2-69018229c903",
  "name" : "aiops-1763365380724",
  "status" : 200,
  "summary" : {
    "highRisk" : 0,
    "mediumRisk" : 0,
    "normal" : 1,
    "suggestion" : 0
  },
  "trigger_type" : "manual",
  "check_type" : "full_detection",
  "create_time" : 1763365380723,
  "task_risks" : [ {
    "id" : "nodeDiskCheck",
    "name" : "name",
    "desc" : "desc",
    "level" : "normal",
    "result" : "result",
    "suggestion" : "suggestion"
  } ]
} ]

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request instead of retrying.

409

The request cannot be processed due to a conflict.

This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

412

The server does not meet one of the requirements that the requester puts on the request.

Error Codes

See Error Codes.

Parent topic: Intelligent O&M