UpdateBaseline

Updated at:

Updates a baseline.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

BaselineId

integer

Yes

The ID of the baseline. You can call ListBaselines to obtain the ID.

1000010800007

ProjectId

integer

Yes

The project ID. You can call ListBaselines to obtain the ID.

2043

BaselineName

string

No

The baseline name.

BaselineName

Owner

string

No

The Alibaba Cloud UID of the baseline owner.

3726346****

Priority

integer

No

The priority of the baseline. Valid values: 1, 3, 5, 7, and 8.

7

NodeIds

string

No

The list of upstream node IDs for the baseline, separated by commas. If there are many nodes, we recommend that you add a virtual node downstream for easier management.

1,2,3

OvertimeSettings

array<object>

No

The baseline committed time configurations.

object

No

The cycle.

Cycle

integer

No

The cycle corresponding to the committed time. For daily baselines, the value is 1. For hourly baselines, you can configure up to 24 cycles.

1

Time

string

No

The committed time in hh:mm format. Valid values of hh: 0 to 47. Valid values of mm: 0 to 59.

00:00

AlertMarginThreshold

integer

No

The baseline alert margin. Unit: minutes.

30

BaselineType

string

No

The baseline type. Valid values:

  • DAILY: daily baseline.

  • HOURLY: hourly baseline.

DAILY

Enabled

boolean

No

Specifies whether the baseline is enabled. Valid values:

  • true: Enabled.

  • false: Disabled.

true

AlertEnabled

boolean

No

Specifies whether alerting is enabled. Valid values:

  • true: Enabled.

  • false: Disabled.

true

AlertSettings

array<object>

No

The baseline alert configurations.

array<object>

No

The alert configuration.

AlertInterval

integer

No

The event alerting interval. Unit: minutes. Minimum value: 5. Maximum value: 1440.

30

AlertMaximum

integer

No

The maximum number of event alerting notifications. Maximum value: 288.

1

AlertMethods

array

No

Valid values:

  • MAIL: email.

  • SMS: text message.

  • PHONE: phone call. Only DataWorks Professional Edition and higher support phone call alerts.

  • DINGROBOTS: DingTalk chatbot. This alert method takes effect only after the RobotUrls parameter is configured.

  • Webhooks: WeCom or Lark chatbot. This alert method takes effect only after the Webhooks parameter is configured.

string

No

The alert method.

SMS

AlertRecipient

string

No

The alert recipient details. For specified users: a list of employee IDs. For on-duty schedule: the schedule name. For owner: leave empty.

123123

AlertRecipientType

string

No

The alert recipient type. Valid values:

  • OWNER: node owner.

  • OTHER: specified users.

  • SHIFT_SCHEDULE: on-duty schedule.

OWNER

AlertType

string

No

The alert type. Valid values:

  • BASELINE: baseline alerting.

  • TOPIC: event alerting.

BASELINE

BaselineAlertEnabled

boolean

No

Specifies whether baseline alerting is enabled. This is a baseline-specific configuration. Valid values:

  • true: Enabled.

  • false: Disabled.

true

DingRobots

array<object>

No

The list of DingTalk chatbots.

object

No

The DingTalk chatbot configuration.

AtAll

boolean

No

Specifies whether to @all members. Valid values:

  • true: Yes.

  • false: No.

false

WebUrl

string

No

The webhook URL of the DingTalk group chatbot.

https://oapi.dingtalk.com/robot/send?access_token=xxx

SilenceEndTime

string

No

The silence end time.

00:00

SilenceStartTime

string

No

The silence start time.

00:00

TopicSlowConfig

object

No

The threshold configuration for event slowdown alerts.

MinOver

integer

No

The minimum slowdown threshold. Unit: seconds. Valid values: 300 to 18000.

3600

OverFactor

number

No

The ratio used to calculate the slowdown threshold based on the historical average execution duration of the node. Valid values: 0.1 to 2.

0.2

TopicTypes

array

No

The event alerting type. This is an event-specific configuration.

string

No

The event type. Valid values:

  • SLOW: slowdown.

  • ERROR: error.

Separate multiple event types with commas (,).

SLOW

Webhooks

array

No

The webhook list.

string

No

The webhook URL of a WeChat Work or Lark chatbot. Separate multiple webhook URLs with commas (,). The alertMethods parameter must include the WEBHOOKS alert method. If this parameter is set to undefined, the system clears the webhook URLs.

Only DataWorks Enterprise Edition is supported. Available regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), Hong Kong (China), Germany (Frankfurt), and Singapore (Singapore).

https://open.feishu.cn/open-apis/bot/v2/hook/xxx

RemoveNodeIds

string

No

The IDs of nodes to remove from the baseline. Separate multiple IDs with commas (,).

123,456

Response elements

Element

Type

Description

Example

object

OpenApiResultModel

Data

boolean

Indicates whether the baseline is updated.

true

ErrorCode

string

The error code.

401

ErrorMessage

string

The error message.

The specified parameters are invalid.

HttpStatusCode

integer

The HTTP status code.

200

RequestId

string

The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.

6E07E90B-D9BC-5D6B-896A-82BA41A34AE1

Success

boolean

Indicates whether the request was successful.

true

Examples

Success response

JSON format

{
  "Data": true,
  "ErrorCode": "401",
  "ErrorMessage": "The specified parameters are invalid.",
  "HttpStatusCode": 200,
  "RequestId": "6E07E90B-D9BC-5D6B-896A-82BA41A34AE1",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.