文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API(V2)/ 基线运维/ 查询基线实例列表 - ListFactorySearchBaselineInstances
更新时间:2026-09-09 GMT+08:00
分享

查询基线实例列表 - ListFactorySearchBaselineInstances

功能介绍

查询基线实例列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/factory/aiops/{instance_id}/baselineinstance

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

instance_id

String

DataArts Studio实例ID,获取方法请参见实例ID和工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

String

工作空间ID,获取方法请参见实例ID和工作空间ID

baseline_name

String

基线任务名称。

owner_name

String

责任人。

type

String

基线类型,DAY天基线,HOUR小时基线,默认查询所有基线类型。

priority

Integer

优先级,取值有1/2/3/4/5,默认查询所有优先级。当同时查询优先级为1/2/3时,样例如下:priority=1&priority=2&priority=3

status

String

状态:

  • ERROR:异常

  • SAFE:安全

  • DANGEROUS:预警

  • OVER:破线

默认查询所有状态。

finish_status

String

完成状态:UNFINISH未完成,FINISH完成,默认查询所有状态。

start_time

Long

开始时间戳,用于检索基线任务实例的承诺时间,单位毫秒。默认为当天0点0分0秒,当end_time有值时,该值不能为空。

end_time

Long

终止时间戳,用于检索基线任务实例的承诺时间,单位毫秒。默认为当天23点59分59秒,当start_time有值时,该值不能为空,最大查询范围为180天。

order_by

String

排序规则,示例 start_time_ms asc,表示按照开始时间升序排序,有如下取值:

  • start_time_ms asc:按照开始时间升序。

  • start_time_ms desc:按照开始时间降序。

  • end_time_ms asc:按照结束时间升序。

  • end_time_ms desc:按照结束时间降序。

默认不排序。

offset

Integer

分页列表的页数,默认值为1。取值范围大于等于1。

limit

Integer

分页返回结果,指定每页最大记录数。范围[1,100]

默认值:10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

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

表4 响应Body参数

参数

参数类型

描述

total

Integer

基线实例总数。

baseline_instances

Array of BaselineInstance objects

基线实例列表信息。

表5 BaselineInstance

参数

参数类型

描述

id

String

基线实例ID。

baseline

Object

基线明细。

baseline_id

String

基线ID。

baseline_name

String

基线任务名称。

baseline_version

Integer

版本号。

priority

Integer

优先级。

dag

String

基线任务实例作业依赖图(包含JOB_ID+JOB名称+版本号+是否为关键路径节点)。

status

String

基线实例状态。

buffer

Long

基线实例余量,单位为s。

estimate_complete_time

Long

预计完成时间戳,单位毫秒。

expect_time

Long

实例预警时间戳,单位毫秒。

finish_status

String

基线实例是否完成。

start_time

Long

基线实例开始时间戳,单位毫秒。

end_time

Long

基线实例结束时间戳,单位毫秒,finish_status(基线实例完成状态)为FINISH(已完成)时,返回基线实例的完成时间戳。

execute_time

Long

运行时间戳,单位毫秒。

error_code

String

错误编码。

error_message

String

错误信息。

task_instances

Object

任务实例信息。

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。

first_alarm_time

Long

首次告警时间戳,单位毫秒。

last_alarm_time

Long

最后告警时间戳,单位毫秒。

sla_time

Long

实例承诺时间戳,单位毫秒。

process_time

Long

处理时间戳,单位毫秒。

recover_time

Long

恢复时间戳,单位毫秒。

ignore_time

Long

忽略时间戳,单位毫秒。

process_buffer

Long

处理时长,设置处理时间所需要的时间,设置后在该时间段内将暂停事件报警,事件的处理操作记录会被记录。

create_day

Integer

创建时间的天数,表示一年的第几天。

instance_type

String

实例类型。

process_user_id

String

基线处理人用户ID。

process_user_name

String

基线处理人用户名称。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询基线实例列表

GET /v2/62099355b894428e8916573ae635f1f9/factory/aiops/65212faf-91e2-4914-a116-be71b1aaf49e/baselineinstance

响应示例

状态码:200

返回基线实例列表信息。

{
  "total" : 1,
  "baseline_instances" : [ {
    "id" : "1036839684825106585",
    "baseline" : null,
    "baseline_id" : "5888778043559265437",
    "baseline_name" : "44",
    "baseline_version" : 1,
    "priority" : 3,
    "dag" : null,
    "status" : "ERROR",
    "buffer" : 3600000,
    "estimate_complete_time" : 1737178200533,
    "expect_time" : 1737178200533,
    "finish_status" : "UNFINISH",
    "start_time" : null,
    "end_time" : null,
    "execute_time" : null,
    "error_code" : null,
    "error_message" : null,
    "task_instances" : null,
    "owner_id" : "7b71e498e75d44048c9a22dd3c54f978",
    "owner_name" : "test_user1",
    "domain_id" : "61c2cde19d9c47cfb2123d4c8ec0d1e8",
    "domain_name" : "test_user2",
    "project_id" : "62099355b894428e8916573ae635f1f9",
    "instance_id" : "65212faf-91e2-4914-a116-be71b1aaf49e",
    "workspace_id" : "62fbba734e634c5087656fc3ff7adf34",
    "first_alarm_time" : 1737181800168,
    "last_alarm_time" : 1737181800168,
    "sla_time" : 1737181800533,
    "process_time" : null,
    "recover_time" : null,
    "ignore_time" : null,
    "process_buffer" : null,
    "create_day" : 18,
    "instance_type" : "HOUR",
    "process_user_id" : null,
    "process_user_name" : null
  } ]
}

状态码: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 ListFactorySearchBaselineInstancesSolution {

    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();
        ListFactorySearchBaselineInstancesRequest request = new ListFactorySearchBaselineInstancesRequest();
        request.withInstanceId("{instance_id}");
        try {
            ListFactorySearchBaselineInstancesResponse response = client.listFactorySearchBaselineInstances(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 = ListFactorySearchBaselineInstancesRequest()
        request.instance_id = "{instance_id}"
        response = client.list_factory_search_baseline_instances(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.ListFactorySearchBaselineInstancesRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ListFactorySearchBaselineInstances(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

返回基线实例列表信息。

400

失败,返回信息

相关文档