查询基线实例列表 - ListFactorySearchBaselineInstances
功能介绍
查询基线实例列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/factory/aiops/{instance_id}/baselineinstance
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参见项目ID和账号ID。 |
|
instance_id |
是 |
String |
DataArts Studio实例ID，获取方法请参见实例ID和工作空间ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
状态：
默认查询所有状态。 |
|
finish_status |
否 |
String |
完成状态：UNFINISH未完成，FINISH完成，默认查询所有状态。 |
|
start_time |
否 |
Long |
开始时间戳，用于检索基线任务实例的承诺时间，单位毫秒。 |
|
end_time |
否 |
Long |
终止时间戳，用于检索基线任务实例的承诺时间，单位毫秒。 |
|
order_by |
否 |
String |
排序规则，示例 start_time_ms asc，表示按照开始时间升序排序，有如下取值：
|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Long |
基线实例总数。 |
|
baseline_instances |
Array of BaselineInstance objects |
基线实例列表信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
message |
String |
返回信息。 |
|
status |
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
失败，返回信息
{
"message" : "Workspace id is invalid",
"status" : "1019"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
返回基线实例列表信息。 |
|
400 |
失败，返回信息 |
