Creating a Cluster Diagnostic Task
Function
This API is used to create a cluster diagnostic task.
It is available for Elasticsearch and OpenSearch.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/ai-ops
| 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 Range Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits. 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 Range The value is a UUID containing 36 characters. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| check_type | No | String | Definition Detection scope for cluster diagnosis. Different diagnosis types apply to different fault troubleshooting scenarios. Constraints When check_type is partial_detection, this parameter must be used together with check_items. You are advised to supplement this dependency description. Range
Default Value full_detection |
| check_items | No | Array of strings | Definition Select some detection items from the full detection items for detection. Enter a list of detection items. Each element in the array is the ID string of a detection item. Constraints This parameter is valid only when check_type is partial_detection. |
| name | No | String | Definition A custom detection report name. Constraints N/A Range 4 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The name must start with a letter. Default Value N/A |
| description | No | String | Definition A custom detection report description. Constraints N/A Range 0 to 255 characters. Default Value N/A |
| alarm | No | alarm object | Definition: Check report sending. This function has been deprecated. Constraints: N/A Value range: N/A Default value: N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| level | No | String | Definition: Risk category of the report to be sent. This function has been deprecated. Constraints: N/A Value range: N/A Default value: N/A |
| smn_topic | No | String | Definition Subject of the report to be sent. This function has been deprecated. Constraints N/A Range N/A Default Value N/A |
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" : "partial_detection", "check_items" : [ "nodeDiskCheck" ] } -
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.