該介面用於擷取基準列表。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Owner |
string |
否 |
責任人 |
3726346**** |
| ProjectId |
integer |
是 |
DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台,進入工作空間配置頁面擷取工作空間 ID。 |
123456 |
| Priority |
string |
否 |
基準的優先順序,取值範圍為{1,3,5,7,8}。 |
1 |
| Enable |
boolean |
否 |
是否開啟基準,包括 true(可用)和 false(不可用)。 |
true |
| BaselineTypes |
string |
否 |
基準的類型,包括 DAILY(Apsara Infrastructure Management Framework線)和 HOURLY(小時基準)。多個類型之間使用英文逗號(,)分隔。 |
DAILY |
| SearchText |
string |
否 |
基準名稱的搜尋索引鍵。 |
baselineName |
| PageNumber |
integer |
是 |
分頁查詢頁碼。大於等於 1 的正整數,預設為 1,最大為 30。 |
1 |
| PageSize |
integer |
是 |
每頁顯示的條數,預設為 10 條,最大 100 條。 |
100 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
OpenApiResultModel |
||
| Success |
boolean |
調用是否成功。取值如下:
|
true |
| ErrorCode |
string |
錯誤碼。 |
103630001 |
| ErrorMessage |
string |
調用失敗時,返回的錯誤資訊。 |
The user does not exist. 276571706358178756 |
| HttpStatusCode |
integer |
HTTP 返回碼。 |
200 |
| Data |
object |
返回的基準列表。 |
|
| PageNumber |
string |
當前的頁數。 |
1 |
| PageSize |
string |
每頁的大小。 |
10 |
| TotalCount |
string |
基準的總數。 |
100 |
| Baselines |
array<object> |
基準列表。 |
|
|
array<object> |
基準配置。 |
||
| BaselineId |
integer |
基準的 ID。 |
1234 |
| ProjectId |
integer |
基準所在工作空間的 ID。 |
9527 |
| BaselineType |
string |
基準類型,包括 DAILY(Apsara Infrastructure Management Framework線)和 HOURLY(小時基準)。 |
DAILY |
| Priority |
integer |
基準的優先順序,取值範圍為{1,2,5,7,8}。 |
1 |
| Owner |
string |
基準責任人的阿里雲 UID。有多個責任人時,使用英文逗號(,)分隔。 |
952795**** |
| BaselineName |
string |
基準的名稱。 |
BaselineName |
| Enabled |
boolean |
基準是否開啟,包括 true(可用)和 false(不可用)。 |
true |
| AlertEnabled |
boolean |
是否開啟警示,包括 true(開啟)和 false(關閉)。 |
true |
| AlertMarginThreshold |
integer |
基準執行個體的預警閾值,單位為分鐘。 |
30 |
| 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 |
| RequestId |
string |
本次調用的唯一 id。出現錯誤後,您可以根據該 ID 排查問題。 |
952795279527ab**** |
樣本
正常返回樣本
JSON格式
{
"Success": true,
"ErrorCode": "103630001",
"ErrorMessage": "The user does not exist. 276571706358178756",
"HttpStatusCode": 200,
"Data": {
"PageNumber": "1",
"PageSize": "10",
"TotalCount": "100",
"Baselines": [
{
"BaselineId": 1234,
"ProjectId": 9527,
"BaselineType": "DAILY",
"Priority": 1,
"Owner": "952795****",
"BaselineName": "BaselineName",
"Enabled": true,
"AlertEnabled": true,
"AlertMarginThreshold": 30,
"OverTimeSettings": [
{
"Cycle": 1,
"Time": "00:00"
}
]
}
]
},
"RequestId": "952795279527ab****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。