Creating a Cluster Detection Task

Function

This API is used to create a cluster detection task.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.

cluster_id

Yes

String

ID of the target cluster

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Language

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

name

Yes

String

Detection task name

description

No

String

Detection task description

alarm

No

alarm object

After the detection task is complete, an SMN alarm message is sent.

Table 4 alarm

Parameter

Mandatory

Type

Description

level

Yes

String

Sensitivity of an SMN alarm message.

  • high

  • medium

  • suggestion

  • norisk

smn_topic

Yes

String

SMN topic name

Response Parameters

None

Request Example

Create a cluster detection task.

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops

{
    "name": " aiops-test ",
"description": " Create a cluster checking task.
 ",
    "alarm":{
        "level":"high",
        "smn_topic":"aiops-test"
    }
}

Response Example

None

Status Codes

Status Code

Description

200

The request is processed successfully.

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 exists, or the request fails to be processed because of the update of the conflict request.

412

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

Error Codes

For details, see Error Code.