Querying the List and Details of Intelligent O&M Diagnostic Tasks
Function
CSS provides intelligent O&M, where you can run intelligent cluster diagnostics to check potential risks in clusters. After a diagnostic task is completed, you can view the details of the identified risks and handle them promptly based on the recommendations. This API is used to obtain the list and details of intelligent O&M diagnostic tasks.
Applicable to Elasticsearch and OpenSearch engines.
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.
URI
GET /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 cluster to be queried. 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | Integer | Definition Maximum number of records displayed on a page. The default value is 10, indicating that 10 tasks are queried at a time. Constraints N/A Range 1-1000 Default Value 10 |
| offset | No | Integer | Definition: Offset, which specifies the start value of the query. The default value is 0, indicating that the query starts from the 0th task. Constraints: N/A Value range: Greater than or equal to 0. Default value: 0 |
| report | No | String | Definition Obtain the latest report or a historical report. Constraints N/A Range Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total_size | Integer | Definition Total number of intelligent cluster diagnostic tasks. Range N/A |
| aiops_list | Array of AiOps objects | Definition Details of intelligent cluster diagnostic tasks. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition ID of an intelligent cluster diagnostic task. Range N/A |
| check_type | String | Definition Diagnosis type. Range |
| trigger_type | String | Definition Trigger type. Range |
| name | String | Definition Name of an intelligent cluster diagnostic task. Range N/A |
| desc | String | Definition Description of an intelligent cluster diagnostic task. Range N/A |
| status | Integer | Definition Task execution status. Range |
| summary | SummaryInfo object | Definition Cluster risk overview. Range N/A |
| create_time | String | Definition Time when an intelligent cluster diagnostic task was created. The value is a Unix timestamp, for example, 1765457366399. Range N/A |
| task_risks | Array of AIOpsRiskInfo objects | Definition Cluster risk details. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| highRisk | Integer | Definition Number of high-risk items. Range 0-100 |
| mediumRisk | Integer | Definition Number of medium-risk items. Range 0-100 |
| normal | Integer | Definition Number of normal items. Range 0-100 |
| suggestion | Integer | Definition Number of warning items. Range 0-100 |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Check item ID Range N/A |
| name | String | Definition Check item name Range N/A |
| desc | String | Definition Check item description Range N/A |
| level | String | Definition Risk level of the check result Range |
| result | String | Definition Check result Range N/A |
| suggestion | String | Definition Check suggestion Range 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.
{
"aiops_list" : [ {
"id" : "id-id-id",
"name" : "aiops-1765457366399",
"desc" : null,
"status" : 200,
"summary" : {
"highRisk" : 1,
"mediumRisk" : 0,
"normal" : 0,
"suggestion" : 0
},
"trigger_type" : "manual",
"check_type" : "partial_detection",
"create_time" : 1765457366399,
"task_risks" : [ {
"id" : "nodeLeftCheck",
"name" : "name",
"desc" : "Check the connectivity of cluster nodes. Node disconnection will severely compromise cluster performance and therefore needs to be handled immediately.",
"level" : "highRisk",
"result" : "Check the connectivity of cluster nodes. Node disconnection will severely compromise cluster performance and therefore needs to be handled immediately.",
"suggestion" : "Check the cluster's parameter settings.\nCheck and repair custom plug-ins.\nScale up data node specs or quantity"
} ]
} ]
} SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.css.v1.region.CssRegion; import com.huaweicloud.sdk.css.v1.*; import com.huaweicloud.sdk.css.v1.model.*; public class ListAiOpsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CssClient client = CssClient.newBuilder() .withCredential(auth) .withRegion(CssRegion.valueOf("<YOUR REGION>")) .build(); ListAiOpsRequest request = new ListAiOpsRequest(); request.withClusterId("{cluster_id}"); try { ListAiOpsResponse response = client.listAiOps(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcss.v1.region.css_region import CssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcss.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CssClient.new_builder() \ .with_credentials(credentials) \ .with_region(CssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAiOpsRequest() request.cluster_id = "{cluster_id}" response = client.list_ai_ops(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := css.CssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := css.NewCssClient(hcClient) request := &model.ListAiOpsRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListAiOps(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot