任务中心
数据导出任务：创建
接口功能介绍
调用此接口可创建数据导出任务。
接口约束
资源池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 | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
