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