數據導出任務：創建
更新時間 2024-09-25 16:21:02
最近更新時間: 2024-09-25 16:21:02
分享文章
任務中心
數據導出任務：創建
接口功能介紹
調用此接口可創建數據導出任務。
接口約束
資源池ID、任務的名稱、設備類型、監控項、聚合類型、起始時間、結束時間不為空。
URI
POST /v4/monitor/task-center/create-task
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| task | 是 | Object | 任務的具體參數 | taskObj |
表 taskObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 任務名稱，必須4-20個字符，支持中英文、數字、下劃線 | 數據導出任務A | |
| description | 否 | String | 任務描述，最多50個字符 | 導出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 | 聚合周期（除raw外其他聚合類型必傳），單位：秒 | 3600 | |
| reportTemplate | 否 | Integer | 本參數表示報表模板。默認值為0。取值范圍：0：默認報表模板。1：基礎報表模板。根據以上范圍取值。 | 0 |
表 dimensionObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 設備標簽鍵 | uuid | |
| value | 是 | Array of Strings | 設備標簽鍵所對應的值 | ['9dc48979-4e19-45e2-b523-5d3c70d516b3'] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| taskID | String | 數據導出任務ID | TASKtacd8b6b4610b97d202306301808 |
請求示例
請求url
/v4/monitor/task-center/create-task
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"task": {
"name": "數據導出任務A",
"description": "用于導出云主機7月份歷史數據",
"service": "ecs",
"dimension": "ecs",
"dimensions":[
{
"name":"uuid",
"value":[
"000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
]
}
],
"itemNameList": ["cpu_util","mem_util"],
"aggregateType": ["avg"],
"startTime": 1692812541,
"endTime": 1692842541,
"period": 3600,
"reportTemplate": 0
}
}
響應示例
{
"statusCode":800,
"returnObj":{
"taskID": "TASKtacd8b6b4610b97d202306301808"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
