调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BaselineId | long | 是 | 基线的 ID, 可通过 ListBaselines 获取。 | 1000010800007 |
ProjectId | long | 是 | 项目 ID, 可通过 ListBaselines 获取。 | 2043 |
BaselineName | string | 否 | 基线名。 | BaselineName |
Owner | string | 否 | 基线责任人的阿里云 uid。 | 3726346**** |
Priority | integer | 否 | 基线的优先级,取值范围为{1,3,5,7,8}。 | 7 |
NodeIds | string | 否 | 基线上游节点列表,使用逗号分割,节点较多的情况下,建议在其下游增加虚节点,便于管理。 | 1,2,3 |
OvertimeSettings | array<object> | 否 | 基线承诺时间配置。 | |
object | 否 | 周期。 | ||
Cycle | integer | 否 | 承诺时间对应的周期,天基线是 1,小时基线可以配置最多 24 个周期。 | 1 |
Time | string | 否 | 承诺时间,hh:mm 格式,hh 的取值范围为[0,47],mm 的取值范围为[0,59]。 | 00:00 |
AlertMarginThreshold | integer | 否 | 基线预警余量,单位为分钟。 | 30 |
BaselineType | string | 否 | 基线类型,包括 DAILY(天基线)和 HOURLY(小时基线)。 | DAILY |
Enabled | boolean | 否 | 基线是否开启,包括 true(可用)和 false(不可用)。 | true |
AlertEnabled | boolean | 否 | 是否开启告警,包括 true(开启)和 false(关闭)。 | true |
AlertSettings | array<object> | 否 | 基线告警配置。 | |
object | 否 | 告警配置。 | ||
AlertType | string | 否 | 告警类型,BASELINE - 基线 / TOPIC - 事件。 | BASELINE |
AlertMethods | array | 否 | MAIL(邮件) SMS(短信) PHONE(电话),仅 DataWorks 专业版及以上版本支持使用电话方式接收报警。 DINGROBOTS(钉钉机器人),仅当配置 RobotUrls 参数后,该报警方式才会生效。 Webhooks(企业微信或飞书机器人),仅当配置 Webhooks 参数后,该报警方式才会生效。 | |
string | 否 | 报警的方式 | SMS | |
SilenceStartTime | string | 否 | 静默开始时间。 | 00:00:00 |
SilenceEndTime | string | 否 | 静默结束时间。 | 00:00:00 |
AlertInterval | integer | 否 | 事件告警间隔,单位为秒,最小为 900。 | 1800 |
AlertMaximum | integer | 否 | 事件告警最大次数,最大为 24。 | 1 |
DingRobots | array<object> | 否 | 钉钉机器人列表 | |
object | 否 | 钉钉机器人配置。 | ||
WebUrl | string | 否 | 钉钉群机器人的 webhook 地址。 | https://oapi.dingtalk.com/robot/send?access_token=xxx |
AtAll | boolean | 否 | 是否@所有人,包括 true(是)和 false(否)。 | false |
Webhooks | array | 否 | webhook 列表。 | |
string | 否 | 企业微信或飞书机器人的 webhook 地址,多个 webhook 地址之间使用英文逗号(,)分隔。alertMethods 中需要包含 WEBHOOKS 告警方式。当该参数配置为 undefined 时,系统会清空 WebHook 地址。 仅 DataWorks 企业版支持。 可用地域:华东 2(上海)、西南 1(成都)、华北 3(张家口)、华北 2(北京)、华东 1(杭州)、华南 1(深圳)、中国(香港)、欧洲中部 1(法兰克福)、亚太东南 1(新加坡)。 | https://open.feishu.cn/open-apis/bot/v2/hook/xxx | |
TopicTypes | array | 否 | 事件告警类型,事件特有配置。 | |
string | 否 | 事件的类型,包括 SLOW(变慢)和 ERROR(出错)。多个事件类型之间使用英文逗号(,)分隔。 | SLOW | |
BaselineAlertEnabled | boolean | 否 | 基线告警开关,基线特有配置,包括 true(是)和 false(否)。 | true |
AlertRecipientType | string | 否 | 告警接收人类型,OWNER(任务责任人)/ OTHER(指定的人)/ SHIFT_SCHEDULE(值班表)。 | OWNER |
AlertRecipient | string | 否 | 告警接收人详情,指定人:工号列表,值班表:值班表名,责任人:空。 | 123123 |
RemoveNodeIds | string | 否 | 需要从基线上提出的节点 ID,多个 ID 间使用,分隔 | 123,456 |
返回参数
示例
正常返回示例
JSON
格式
{
"Success": true,
"ErrorCode": "401",
"ErrorMessage": "The specified parameters are invalid.",
"HttpStatusCode": 200,
"Data": true,
"RequestId": "6E07E90B-D9BC-5D6B-896A-82BA41A34AE1"
}
错误码
访问错误中心查看更多错误码。