查询基线任务列表 - ListSearchFactoryBaselines
功能介绍
查询基线任务列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/factory/aiops/{instance_id}/baseline
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方法请参见项目ID和账号ID。 |
| instance_id | 是 | String | DataArts Studio实例ID,获取方法请参见实例ID和工作空间ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 是 | String | 工作空间ID,获取方法请参见实例ID和工作空间ID。 |
| name | 否 | String | 基线任务名称。 |
| owner_name | 否 | String | 责任人名称。 |
| priority | 否 | Integer | 优先级,取值有1/2/3/4/5,默认查询所有优先级。当同时查询优先级为1/2/3时,样例如下:priority=1&priority=2&priority=3。 |
| order_by | 否 | String | 排序规则,取值如下: 默认不排序。 |
| enable | 否 | Boolean | 开启基线任务。 true: 开启基线任务,系统将会监控基线任务以及其依赖链上游的所有任务。 false: 关闭基线任务,系统不会监控基线任务以及其依赖链上游的所有任务。 默认查询全部。 |
| offset | 否 | Integer | 分页列表的页数,默认值为1。取值范围大于等于1。 |
| limit | 否 | Integer | 分页返回结果,指定每页最大记录数。范围[1,100] 默认值:10 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值),使用Token认证时必选,最小长度:0,最大长度:4096。 |
| X-Project-Id | 否 | String | project_id,项目编号。获取方法请参见项目ID和账号ID, 多project场景采用AK/SK认证的接口请求,则该字段必选。 |
| workspace | 是 | String | 工作空间ID,获取方法请参见实例ID和工作空间ID。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| baselines | Array of BaselineV2 objects | 基线任务。 |
| total | Integer | 总数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 基线任务ID。 |
| name | String | 基线任务名称。 |
| version | Integer | 版本号。 |
| create_time | Long | 创建时间戳,单位毫秒。 |
| last_update_time | Long | 最后更新时间戳,单位毫秒。 |
| type | String | 基线任务类型。 |
| owner_id | String | 责任人用户ID。 |
| owner_name | String | 责任人用户名称。 |
| domain_id | String | 责任人租户ID。 |
| domain_name | String | 责任人租户名称。 |
| project_id | String | 项目ID。 |
| instance_id | String | DataArts Studio实例ID。 |
| workspace_id | String | 工作空间ID。 |
| sla_task_ids | Array of strings | 保障作业ID列表。 |
| priority | Integer | 优先级。 |
| sla_min | Integer | 天基线承诺分钟。 |
| buffer | Integer | 预警余量。 |
| sla_hour | Integer | 天基线承诺小时。 |
| exp_min | Integer | 天基线预警分钟。 |
| exp_hour | Integer | 天基线预警小时。 |
| hour_exp_detail | String | 小时基线的预警时间配置(JSON格式),key为周期号,value为hh:mm格式。hh的取值范围为[0,47],mm的取值范围为[0,59]。 |
| hour_sla_detail | String | 小时基线的承诺时间配置(JSON格式),key为周期号,value为hh:mm格式。hh的取值范围为[0,47],mm的取值范围为[0,59]。 |
| enable | Boolean | 是否生效。 |
| alarm_enable | Boolean | 报警是否打开。 |
| baseline_alarm_enable | Boolean | 基线报警是否打开。 |
| smn_topics | Array of SmnTopic objects | SMN主题列表。 |
| event_alarm | Array of strings | 事件告警开启类型。 |
| event_smn_topics | Array of SmnTopic objects | 事件告警SMN主题列表。 |
| sign_enable | Boolean | 基线签署是否打开。 |
| period | Array of PeriodSlaTimeV2 objects | 承诺时间周期列表,小时基线时生效。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 名称。 |
| urn | String | smn urn。 |
| notify_method | String | 告警方式:主题、责任人,值班表和钉钉机器人。 |
| protocol | String | 告警协议:短信、邮件、电话,示例:["email"] "email":邮件传输协议,"sms":短信传输协议,"callnotify":语音, "dingding":个人钉钉。 |
| other_persons | String | 抄送人,示例:["lin","hua"]。 |
| max_send_times | Integer | 最大告警次数。 |
| send_interval | Integer | 告警间隔。 |
| duty_schedule_id | Long | 值班表id。 |
| duty_schedule_name | String | 值班表名称。 |
| smn_config_id | String | 机器人id。 |
| smn_config_name | String | 机器人名称。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
查询基线任务列表。
GET /v2/62099355b894428e8916573ae635f1f9/factory/aiops/65212faf-91e2-4914-a116-be71b1aaf49e/baseline
响应示例
状态码:200
调用成功的响应体。
{
"total" : 40,
"baselines" : [ {
"id" : "1317695290897940652",
"name" : "11134dddd2",
"version" : 1,
"create_time" : 1770185528978,
"last_update_time" : 1770185528978,
"type" : "HOUR",
"owner_id" : "7b71e498e75d44048c9a22dd3c54f978",
"owner_name" : "ei_dlf_l00341563",
"domain_id" : "61c2cde19d9c47cfb2123d4c8ec0d1e8",
"domain_name" : "ei_dlf_l00341563",
"project_id" : "62099355b894428e8916573ae635f1f9",
"instance_id" : "undefined",
"workspace_id" : "62fbba734e634c5087656fc3ff7adf34",
"sla_task_ids" : [ "935334" ],
"priority" : 3,
"sla_min" : 59,
"buffer" : 3600000,
"sla_hour" : 0,
"exp_min" : null,
"exp_hour" : null,
"hour_exp_detail" : null,
"hour_sla_detail" : null,
"enable" : true,
"alarm_enable" : true,
"baseline_alarm_enable" : true,
"smn_topics" : [ {
"name" : null,
"urn" : null,
"notify_method" : "DUTY_SCHEDULE",
"protocol" : "[\"sms\",\"email\",\"callnotify\"]",
"other_persons" : null,
"max_send_times" : 5,
"send_interval" : 5,
"duty_schedule_id" : 2,
"duty_schedule_name" : "444",
"smn_config_id" : null,
"smn_config_name" : null
} ],
"event_alarm" : [ ],
"event_smn_topics" : [ ],
"sign_enable" : false,
"period" : [ {
"period_num" : 1,
"period_time" : "00:59"
} ]
} ]
} 状态码:400
调用失败的返回体。
{
"error_msg" : "The value of parameter [workspace_id] does not exist, please check again its value.",
"error_code" : "DLF.21203"
} 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.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListSearchFactoryBaselinesSolution { 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); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ListSearchFactoryBaselinesRequest request = new ListSearchFactoryBaselinesRequest(); request.withInstanceId("{instance_id}"); try { ListSearchFactoryBaselinesResponse response = client.listSearchFactoryBaselines(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 huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.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 = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSearchFactoryBaselinesRequest() request.instance_id = "{instance_id}" response = client.list_search_factory_baselines(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 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" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/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 := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.ListSearchFactoryBaselinesRequest{} request.InstanceId = "{instance_id}" response, err := client.ListSearchFactoryBaselines(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 调用成功的响应体。 |
| 400 | 调用失败的返回体。 |