# 查看智能运维诊断项 - ShowAiOpsDetector #### 功能介绍 CSS服务提供智能运维功能，支持检测集群潜在风险。此接口用于获取智能运维的诊断项。 适用于Elasticsearch和OpenSearch引擎。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-css/css_03_0077.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-css/css_03_0096.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | css:cluster:showAiOpsDetector | Read | cluster \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI GET /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/detector 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-css/css_03_0071.html)。 **约束限制**： 不涉及 **取值范围**： 账户的项目ID，长度为32个字符，由小写字母和数字组成。 **默认取值**： 不涉及 | | cluster_id | 是 | String | **参数解释**： 指定查询的集群ID。获取方法请参见[获取集群ID](https://support.huaweicloud.com/api-css/css_03_0101.html)。 **约束限制**： 不涉及 **取值范围**： UUID格式，36个字符。 **默认取值**： 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | full_detection | Array of [AiOpsDetector] objects | **参数解释**： 全量检测项，返回所有可用检测项ID、名称，以及检测描述。 | | unavailability_detection | Array of [AiOpsDetector] objects | **参数解释**： 集群不可用检测项，返回所有集群不可用分类的检测项ID、名称，以及检测描述。 | 表3AiOpsDetector | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 当前支持的检测项ID。 **取值范围**： 不涉及 | | name | String | **参数解释**： 检测项名称。 **取值范围**： 不涉及 | | desc | String | **参数解释**： 检测项说明。 **取值范围**： 不涉及 | #### 请求示例 查看智能运维检测项 ``` GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops/detector ``` #### 响应示例 **状态码：200** 智能运维检测项 ``` { "full_detection" : [ { "id" : "nodeDiskCheck", "name" : "Data Node Disk Usage Check", "desc" : "Identify data nodes (including cold data nodes) with the highest disk usage in the cluster. Excessive disk usage can affect cluster stability. [N]High risk: When a node's disk usage reaches 85%, no new index replicas will be allocated to it. [N]Medium risk: When a node's disk usage exceeds 80%, take immediate action to prevent further increase." } ], "unavailability_detection" : [ { "id" : "dataNodeDiskBalanceCheck", "name" : "Data Node Disk Usage Balance Check", "desc" : "Check whether disk usage is balanced across all regular data nodes and cold data nodes. Unbalanced disk usage may cause performance issues. [N]Risk levels: [N]High risk: Maximum disk usage difference between nodes ≥ 40% [N]Medium risk: 25% ≤ Maximum disk usage difference between nodes < 40%." } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowAiOpsDetectorSolution { 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("")) .build(); ShowAiOpsDetectorRequest request = new ShowAiOpsDetectorRequest(); request.withClusterId("{cluster_id}"); try { ShowAiOpsDetectorResponse response = client.showAiOpsDetector(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] ``` # 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("")) \ .build() try: request = ShowAiOpsDetectorRequest() request.cluster_id = "{cluster_id}" response = client.show_ai_ops_detector(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] ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := css.NewCssClient(hcClient) request := &model.ShowAiOpsDetectorRequest{} request.ClusterId = "{cluster_id}" response, err := client.ShowAiOpsDetector(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CSS/sdk?api=ShowAiOpsDetector&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 智能运维检测项 | | 400 | 非法请求。 建议直接修改该请求，不要重试该请求。 | | 409 | 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 | | 412 | 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-css/css_03_0076.html)。