Help Center/ Cloud Search Service/ API Reference/ API V1/ Intelligent O&M/ Creating a Cluster Detection Task
Updated on 2025-11-28 GMT+08:00
View PDF

Creating a Cluster Detection Task

Function

This API is used to create a cluster detection task.

Calling Method

For details, see Calling APIs.

URI

POST /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 target cluster. 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

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Language
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

check_type

No

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.)

Default value:

N/A

check_items

No

Array of strings

Definition:

Select a subset of all check items, and enter the check item list.

Value range:

N/A

Default value:

N/A

name

No

String

Definition:

A custom name of the check report.

Value range:

N/A

Default value:

N/A

description

No

String

Definition:

A custom description of the check report.

Value range:

0 to 255 characters

Default value:

N/A

alarm

No

AlarmInfo object

Definition:

Check report sending. Currently, it is not supported.

Value range:

N/A

Default value:

N/A
Table 4 AlarmInfo

Parameter

Mandatory

Type

Description

level

No

String

Report level. This parameter is not supported currently.

smn_topic

No

String

SMN topic. This parameter is not supported currently.

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Create a cluster detection task.

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

{
  "check_type" : "full_detection",
  "check_items" : [ ]
}

Example Responses

None

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