更新时间:2025-12-30 GMT+08:00
分享

编辑基线任务 - UpdateFactoryBaseline

功能介绍

编辑基线任务。

调用方法

请参见如何调用API

授权信息

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

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

URI

PUT /v2/{project_id}/factory/aiops/{instance_id}/baseline/{baseline_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

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

baseline_id

String

基线任务ID。

请求参数

表2 请求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

Content-Type

String

默认值:application/json;charset=UTF-8

可选,有Body体的情况下必选,没有Body体则无需填写和校验。

表3 请求Body参数

参数

是否必选

参数类型

描述

workspace_id

String

工作空间ID。

name

String

基线任务名称。

owner_name

String

责任人用户名称。

type

String

基线任务类型。取值为 DAY和HOUR。

sla_task_ids

Array of strings

保障作业ID列表。

priority

Integer

优先级。

buffer

Integer

预警余量。

enable

Boolean

是否生效。

alarm_enable

Boolean

报警是否打开。

sign_enable

Boolean

基线签署是否打开。

sla_hour

String

天基线承诺小时。

sla_min

String

天基线承诺分钟。

baseline_alarm_enable

Boolean

基线报警是否打开。

smn_topics

Array of SmnTopicRequest objects

SMN主题列表。

event_alarm

Array of strings

事件告警开启类型,取值为ERROR和SLOW_DOWN。

表4 SmnTopicRequest

参数

是否必选

参数类型

描述

name

String

名称。

urn

String

smn urn。

notify_method

String

告警方式:主题、责任人、值班表和钉钉机器人,取值如下:

  • SUBJECT: 主题

  • OWNER: 责任人

  • DUTY_SCHEDULE: 值班表

  • DINGDING: 钉钉机器人

protocol

String

告警协议:短信、邮件、电话,示例:["email"] "email":邮件传输协议,"sms":短信传输协议,"callnotify":语音, "dingding":个人钉钉。

other_persons

String

抄送人,示例:["lin","hua"]。

max_send_times

Integer

最大告警次数,取值为 [1, 50]。

send_interval

Integer

告警间隔,取值为[5, 60],单位:分钟。

duty_schedule_name

String

值班表名称。

smn_config_name

String

机器人名称。

响应参数

状态码:200

成功,状态响应200。

状态码:400

表5 响应Body参数

参数

参数类型

描述

message

String

返回信息。

status

String

返回状态码。

请求示例

编辑基线任务。

PUT /v2/62099355b894428e8916573ae635f1f9/factory/aiops/65212faf-91e2-4914-a116-be71b1aaf49e/baseline/1241325900378950667

{
  "workspace_id" : "62fbba734e634c5087656fc3ff7adf34",
  "name" : "3333334457",
  "owner_name" : "test",
  "type" : "DAY",
  "sla_task_ids" : [ "935280" ],
  "priority" : 3,
  "buffer" : 3600000,
  "enable" : true,
  "alarm_enable" : true,
  "sign_enable" : false,
  "sla_hour" : "00",
  "sla_min" : "00",
  "baseline_alarm_enable" : true,
  "smn_topics" : [ {
    "name" : null,
    "urn" : null,
    "notify_method" : "DUTY_SCHEDULE",
    "protocol" : "[\"sms\",\"email\",\"callnotify\"]",
    "other_persons" : null,
    "max_send_times" : 1,
    "send_interval" : 60,
    "duty_schedule_name" : "444",
    "smn_config_name" : null
  } ],
  "event_alarm" : [ ]
}

响应示例

状态码:400

失败,返回信息。

{
  "message" : "duty scheduler not found.",
  "status" : "10001"
}

状态码

状态码

描述

200

成功,状态响应200。

400

失败,返回信息。

相关文档