數據導出任務：查詢
更新(xin)時(shi)間(jian) 2024-09-25 16:21:01
最近更新時(shi)間: 2024-09-25 16:21:01
分享文章
任務中心
數據導出任務：查詢
接口功能介紹
調用此接(jie)口可查詢數據(ju)導出任務結果。
接口約束
資源(yuan)池ID不能為空。
URI
GET /v4/monitor/task-center/query-task
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| taskID | 否 | String | 任務ID | TASKtacd8b6b4610b97d202306301808 | |
| name | 否 | String | 任務名稱，支持模糊搜索 | 主機數據 | |
| pageNo | 否 | Integer | 頁碼，不傳默認為1 | 1 | |
| pageSize | 否 | Integer | 每頁大小，不傳默認為20 | 2 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| taskList | Array of Objects | 任務列表 | taskObj | |
| totalCount | Integer | 總記錄數 | 2 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前記錄數 | 2 |
表 taskObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 任務名稱 | 數據導出任務A | |
| description | String | 任務描述 | 用于導出云主機7月份歷史數據 | |
| service | String | 云監控服務 | ecs | |
| dimension | String | 云監控維度 | ecs | |
| dimensions | Array of Objects | 查詢設備標簽列表，用于定位目標設備，多標簽查詢取交集 | dimensionObj | |
| itemNameList | Array of Strings | 待查的監控項名稱，具體設備對應監控項參見監控項列表：查詢 | ['cpu_util','mem_util'] | |
| aggregateType | Array of Strings | 本參數表示數據聚合類型。取值范圍：raw：原始值。avg：平均值。max：最大值。min：最小值。根據以上范圍取值。 | ['avg'] | |
| startTime | Integer | 數據起始時間 | 1692812541 | |
| endTime | Integer | 數據截止時間 | 1692842541 | |
| period | Integer | 數據點間隔 | 3600 | |
| createTime | Integer | 創建時間,精確至毫秒 | 1692842341000 | |
| updateTime | Integer | 更新時間,精確至毫秒 | 1692842441000 | |
| status | Integer | 本參數表示任務狀態碼。取值范圍：0：待處理。1：處理中。2：已完成。3：失敗。4：過期。根據以上范圍取值。 | 1 | |
| process | Integer | 百分比進度，當status為1時有意義，范圍 0-100 | 66 | |
| msg | String | 任務詳情，可用于展示報錯信息 | 導出數據失敗，請重試 |
表 dimensionObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 設備標簽鍵 | uuid | |
| value | Array of Strings | 設備標簽鍵所對應的值 | ['9dc48979-4e19-45e2-b523-5d3c70d516b3'] |
請求示例
請求url
/v4/monitor/task-center/query-task?regionID=81f7728662dd11ec810800155d307d5b&name=mytask&pageNo=1&pageSize=10
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"errorCode":"",
"message":"Success",
"msgDesc":"成功",
"returnObj":{
"taskList":[
{
"name":"數據導出任務A",
"description":"用于導出云主機7月份歷史數據",
"service":"ecs",
"dimension":"ecs",
"dimensions":[
{
"name":"uuid",
"value":[
"1234",
"5678"
]
}
],
"itemNameList":[
"cpu_util",
"mem_util"
],
"aggregateType":[
"avg"
],
"startTime":1692812541,
"endTime":1692842541,
"period":3600,
"createTime":1692842341000,
"updateTime":1692842441000,
"status":1,
"process":66,
"msg":""
},
{
"name":"數據導出任務B",
"description":"用于導出云主機8月份歷史數據",
"service":"ecs",
"dimension":"ecs",
"dimensions":[
{
"name":"uuid",
"value":[
"1234",
"5678"
]
}
],
"itemNameList":[
"disk_write_bytes_rate"
],
"aggregateType":[
"max"
],
"startTime":1693812541,
"endTime":1693842541,
"period":7200,
"createTime":1693842341000,
"updateTime":1693842441000,
"status":3,
"process":0,
"msg":"導出數據失敗，請重試"
}
],
"totalCount":2,
"totalPage":1,
"currentCount":2
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
