調用ListBaselineStatuses擷取基準執行個體列表。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PageNumber |
integer |
是 |
分頁的頁數。預設值為 1,最小值為 1,最大值為 30。 |
1 |
| PageSize |
integer |
是 |
每頁顯示的條數,預設值為 10,最大值為 100。 |
10 |
| Bizdate |
string |
是 |
業務日期,需要使用 UTC 格式(yyyy-MM-dd'T'HH:mm:ssZ)。 |
2020-07-07T00:00:00+0800 |
| Priority |
string |
否 |
基準的優先順序,取值範圍為{1,3,5,7,8}。多個優先順序之間使用英文逗號(,)分隔。 |
1,3,5,7,8 |
| SearchText |
string |
否 |
搜尋索引鍵,支援基準名稱和基準 ID,如果輸入小時基準 ID,則會返回該小時基準所有執行個體。 |
關鍵詞 |
| Owner |
string |
否 |
基準責任人的阿里雲 UID。 |
9527952795**** |
| TopicId |
integer |
否 |
相關事件的 ID。 |
1234 |
| FinishStatus |
string |
否 |
基準執行個體是否完成,包括 UNFINISH(未完成)、FINISH(已完成)。多個狀態之間使用英文逗號(,)分隔。 |
FINISH,UNFINISH |
| Status |
string |
否 |
基準的狀態,包括 ERROR(異常)、SAFE(安全)、DANGROUS(預警)和 OVER(破線)。多個狀態之間使用英文逗號(,)分隔。 |
SAFE,DANGROUS,OVER |
| BaselineTypes |
string |
否 |
基準的類型,包括 DAILY(Apsara Infrastructure Management Framework線)和 HOURLY(小時基準)。多個類型之間使用英文逗號(,)分隔。 |
DAILY,HOURLY |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回資料。 |
||
| HttpStatusCode |
integer |
HTTP 返回碼。 |
200 |
| RequestId |
string |
本次調用的唯一 ID。出現錯誤後,您可以根據該 ID 排查問題。 |
0000-ABCD-EFG**** |
| ErrorMessage |
string |
錯誤資訊。 |
The specified parameters are invalid. |
| ErrorCode |
string |
錯誤碼。 |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
調用是否成功。 |
true |
| Data |
object |
返回的基準執行個體列表。 |
|
| PageNumber |
integer |
當前的頁數。 |
1 |
| PageSize |
integer |
每頁的大小。 |
10 |
| TotalCount |
integer |
基準執行個體的總數。 |
100 |
| BaselineStatuses |
array<object> |
基準執行個體列表。 |
|
|
object |
基準執行個體列表資訊。 |
||
| Status |
string |
基準的狀態,包括 ERROR(異常)、SAFE(安全)、DANGEROUS(預警)和 OVER(破線)。 |
SAFE |
| Owner |
string |
基準責任人的阿里雲 UID。多個責任人之間使用英文逗號(,)分隔。 |
9527952795**** |
| FinishTime |
integer |
當 FinishStatus(基準執行個體完成狀態)為 FINISH(已完成)時,返回基準執行個體的完成時間戳記。 |
1553531400000 |
| ProjectId |
integer |
基準所在工作空間的 ID。 |
1234 |
| Priority |
integer |
基準的優先順序,取值範圍為{1,3,5,7,8}。 |
1 |
| EndCast |
integer |
基準執行個體的預計完成時間。 |
1553531400000 |
| InGroupId |
integer |
基準執行個體的周期號。Apsara Infrastructure Management Framework線為 1,小時基準的取值範圍為[1,24]。 |
1 |
| BaselineName |
string |
基準的名稱。 |
基準名稱 |
| BaselineId |
integer |
基準的 ID。 |
1234 |
| FinishStatus |
string |
基準執行個體是否完成,包括 UNFINISH(未完成)和 FINISH(已完成)。 |
UNFINISH |
| Bizdate |
integer |
業務日期時間戳記。 |
1553443200000 |
| Buffer |
integer |
基準執行個體的餘量,單位為秒。 |
1800 |
| SlaTime |
integer |
基準執行個體的實際完成時間。 |
1553531400000 |
| ExpTime |
integer |
基準執行個體的預警時間。 |
1553531400000 |
| BaselineType |
string |
基準的類型,包括 DAILY(Apsara Infrastructure Management Framework線)和 HOURLY(小時基準)。 |
基準類型 |
樣本
正常返回樣本
JSON格式
{
"HttpStatusCode": 200,
"RequestId": "0000-ABCD-EFG****",
"ErrorMessage": "The specified parameters are invalid.",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"BaselineStatuses": [
{
"Status": "SAFE",
"Owner": "9527952795****",
"FinishTime": 1553531400000,
"ProjectId": 1234,
"Priority": 1,
"EndCast": 1553531400000,
"InGroupId": 1,
"BaselineName": "基準名稱",
"BaselineId": 1234,
"FinishStatus": "UNFINISH",
"Bizdate": 1553443200000,
"Buffer": 1800,
"SlaTime": 1553531400000,
"ExpTime": 1553531400000,
"BaselineType": "基準類型"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | |
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 沒有許可權,請授權 |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。