获取智能运维任务列表及详情 - ListAiOps
功能介绍
CSS服务提供智能运维功能,支持检测集群潜在风险。检测任务完成后,可以查看集群存在的风险项详情,根据风险建议及时处理集群存在的风险。此接口用于获取智能运维任务列表及详情。
适用于Elasticsearch和OpenSearch引擎。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
css:cluster:listAiOps
List
cluster *
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
-
-
-
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/ai-ops
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 账号的项目ID。 默认取值: 不涉及 |
|
cluster_id |
是 |
String |
参数解释: 指定查询的集群ID。获取方法请参见获取集群ID。 约束限制: 不涉及 取值范围: 集群ID。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
参数解释: 分页参数,列表当前分页的数量限制。默认值为10,即一次查询10个任务信息。 约束限制: 不涉及 取值范围: 1-1000 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量。 偏移量为一个大于0小于终端节点服务总个数的整数,表示从偏移量后面的终端节点服务开始查询。 约束限制: 不涉及 取值范围: 大于或等于0 默认取值: 0 |
|
report |
否 |
String |
参数解释: 获取当前最新一份报告或历史报告 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
aiops_list |
Array of aiops_list objects |
参数解释: 集群风险检测任务详情列表。 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 集群风险检测任务ID。 取值范围: 不涉及 |
|
check_type |
String |
参数解释: 检测范围 取值范围:
|
|
trigger_type |
String |
参数解释: 触发类型 取值范围:
|
|
name |
String |
参数解释: 集群风险检测任务名称。 取值范围: 不涉及 |
|
desc |
String |
参数解释: 集群风险检测任务描述。 取值范围: 不涉及 |
|
status |
Integer |
参数解释: 任务执行状态。 取值范围:
|
|
summary |
summary object |
参数解释: 集群风险概要。 取值范围: 不涉及 |
|
create_time |
String |
参数解释: 集群风险检测任务创建时间。 取值范围: 格式:Unix时间戳格式。 |
|
task_risks |
Array of task_risks objects |
参数解释: 集群风险项详情。 取值范围: 不涉及 |
请求示例
获取智能运维任务列表及详情。
GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops
响应示例
状态码:200
请求成功。
{
"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代码示例
SDK代码示例如下。
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()); } } } |
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) |
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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := css.NewCssClient( css.CssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAiOpsRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListAiOps(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
非法请求。 建议直接修改该请求,不要重试该请求。 |
|
409 |
服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 |
|
412 |
未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。