查询事件列表 - ListSearchFactoryEvents
功能介绍
查询事件列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/factory/aiops/{instance_id}/event
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
责任人名称。 |
|
start_time |
否 |
Long |
创建时间检索区间,起始时间戳,单位毫秒。 |
|
end_time |
否 |
Long |
创建时间检索区间,终止时间戳,单位毫秒。 |
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
events |
Array of events objects |
事件。 |
|
total |
Integer |
总数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
事件ID。 |
|
name |
String |
事件名称。 |
|
type |
String |
事件类型,取值为ERROR和SLOW_DOWN。 |
|
status |
String |
事件状态,取值为NEW_DISCOVERY、PROCESSING、RESTORED和IGNORED。 |
|
project_id |
String |
项目ID。 |
|
instance_id |
String |
DataArts Studio实例ID。 |
|
workspace_id |
String |
工作空间ID。 |
|
baseline_id |
String |
基线任务ID。 |
|
baseline_name |
String |
基线任务名称。 |
|
baseline_version |
Integer |
版本号。 |
|
baseline_instance_id |
String |
基线任务实例ID。 |
|
task_instance |
task_instance object |
任务实例信息。 |
|
task_instance_id |
String |
任务实例ID,对应调度系统作业实例ID。 |
|
task_name |
String |
作业名称。 |
|
task_id |
String |
作业ID。 |
|
task_version |
Integer |
作业版本号。 |
|
happen_time |
Integer |
发生时间戳,单位毫秒。 |
|
expose_time |
Integer |
暴露时间戳,单位毫秒。 |
|
process_time |
String |
处理时间戳,单位毫秒。 |
|
recover_time |
String |
恢复时间戳,单位毫秒。 |
|
first_alarm_time |
Integer |
首次告警时间戳,单位毫秒。 |
|
last_alarm_time |
Integer |
最后告警时间戳,单位毫秒。 |
|
ignore_time |
String |
忽略时间戳,单位毫秒。 |
|
owner_id |
String |
责任人用户ID。 |
|
owner_name |
String |
责任人用户名称。 |
|
domain_id |
String |
责任人租户ID。 |
|
domain_name |
String |
责任人租户名称。 |
|
ignored |
String |
是否忽略,忽略后则不再产生报警。 |
|
process_buffer |
String |
处理时长,设置处理时间所需要的时间,设置后在该时间段内将暂停事件报警,事件的处理操作记录会被记录。 |
|
baseline_instance |
baseline_instance object |
基线实例信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
任务实例 |
|
task_running_log_id |
String |
任务实例ID,对应调度系统作业实例lts_task_running_log_id/ID |
|
create_day |
Integer |
创建时间 |
|
task_name |
String |
作业名称 |
|
task_id |
String |
作业ID |
|
task_version |
Integer |
作业版本号 |
|
task_schedule_type |
Integer |
作业调度类型:0/1/2/3 |
|
priority |
Integer |
优先级 |
|
status |
String |
状态:WAITING/RUNNING/SUCCESS/FAIL/RUNNING-EXCEPTION/PAUSE/MANUAL-STOP |
|
plan_time |
Long |
计划时间戳,单位毫秒 |
|
submit_time |
Long |
提交时间戳,单位毫秒 |
|
retry_times |
Integer |
自动重试次数 |
|
start_time |
Long |
开始时间戳,单位毫秒 |
|
end_time |
Long |
结束时间戳,单位毫秒 |
|
execute_time |
Long |
运行时间,单位毫秒 |
|
failure_job_count |
Integer |
算子失败个数 |
|
error_message |
String |
错误信息 |
|
current_min_execute_time |
Long |
截止目前历史最小执行时间,单位毫秒 |
|
current_max_execute_time |
Long |
截止目前历史最大执行时间,单位毫秒 |
|
current_avg_execute_time |
Long |
截止目前历史平均执行时间,单位毫秒 |
|
workspace_id |
String |
空间id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
编号。 |
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
message |
String |
返回信息。 |
|
status |
String |
返回状态码。 |
请求示例
查询事件列表。
GET /v2/62099355b894428e8916573ae635f1f9/factory/aiops/65212faf-91e2-4914-a116-be71b1aaf49e/event
响应示例
状态码:400
调用失败的返回体。
{
"message" : "Workspace id is invalid",
"status" : "1019"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
调用成功的响应体。 |
|
400 |
调用失败的返回体。 |