該介面用於更新基準。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| BaselineId |
integer |
是 |
基準的 ID, 可通過 ListBaselines 擷取。 |
1000010800007 |
| ProjectId |
integer |
是 |
專案 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 |
否 |
承諾時間對應的周期,Apsara Infrastructure Management Framework線是 1,小時基準可以配置最多 24 個周期。 |
1 |
| Time |
string |
否 |
承諾時間,hh:mm 格式,hh 的取值範圍為[0,47],mm 的取值範圍為[0,59]。 |
00:00 |
| AlertMarginThreshold |
integer |
否 |
基準預警餘量,單位為分鐘。 |
30 |
| BaselineType |
string |
否 |
基準類型,包括 DAILY(Apsara Infrastructure Management Framework線)和 HOURLY(小時基準)。 |
DAILY |
| Enabled |
boolean |
否 |
基準是否開啟,包括 true(可用)和 false(不可用)。 |
true |
| AlertEnabled |
boolean |
否 |
是否開啟警示,包括 true(開啟)和 false(關閉)。 |
true |
| AlertSettings |
array<object> |
否 |
基準警示配置。 |
|
|
array<object> |
否 |
警示配置。 |
||
| AlertType |
string |
否 |
警示類型,BASELINE - 基準 / TOPIC - 事件。 |
BASELINE |
| AlertMethods |
array |
否 |
MAIL(郵件) SMS(簡訊) PHONE(電話),僅 DataWorks 專業版及以上版本支援使用電話方式接收警示。 DINGROBOTS(DingTalk機器人),僅當配置 RobotUrls 參數後,該警示方式才會生效。 Webhooks(企業微信或飛書機器人),僅當配置 Webhooks 參數後,該警示方式才會生效。 |
|
|
string |
否 |
警示的方式 |
SMS |
|
| SilenceStartTime |
string |
否 |
靜默開始時間。 |
00:00:00 |
| SilenceEndTime |
string |
否 |
靜默結束時間。 |
00:00:00 |
| AlertInterval |
integer |
否 |
事件警示間隔,單位為分鐘,最小為 5,最大值為 1440 |
1800 |
| AlertMaximum |
integer |
否 |
事件警示最大次數,最大為 24。 |
1 |
| DingRobots |
array<object> |
否 |
DingTalk機器人列表 |
|
|
object |
否 |
DingTalk機器人配置。 |
||
| WebUrl |
string |
否 |
DingTalk群機器人的 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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
OpenApiResultModel |
||
| Success |
boolean |
請求是否成功。 |
true |
| ErrorCode |
string |
錯誤碼。 |
401 |
| ErrorMessage |
string |
錯誤資訊。 |
The specified parameters are invalid. |
| HttpStatusCode |
integer |
HTTP 狀態代碼。 |
200 |
| Data |
boolean |
基準是否更新成功。 |
true |
| RequestId |
string |
本次調用請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。 |
6E07E90B-D9BC-5D6B-896A-82BA41A34AE1 |
樣本
正常返回樣本
JSON格式
{
"Success": true,
"ErrorCode": "401",
"ErrorMessage": "The specified parameters are invalid.",
"HttpStatusCode": 200,
"Data": true,
"RequestId": "6E07E90B-D9BC-5D6B-896A-82BA41A34AE1"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。