接口功能介绍
获取指定用户的清理任务列表。
接口定义
接口名称 | 获取数据清理任务列表 |
---|---|
承载协议 | HTTPS |
承载网络 | 外网 |
请求方式 | Get |
数据格式 | |
约束 | 实例处于运行状态 |
测试环境接口URL | https://influxdb-global.ctapi-test.ctyun.cn/v1/console/openapi/cleartask/list |
生产环境接口URL | https://influxdb-global.ctapi.ctyun.cn/v1/console/openapi/cleartask/list |
请求参数
header参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
regionId | 是 | header | String | 当前实例所属资源池 |
query参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
spuInstId | 是 | query | String | 产品实例id |
pageNum | 否 | query | Integer | 当前页 |
pageSize | 否 | query | Integer | 单页记录数量 |
响应结果
响应Body参数
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
code | Integer | 返回状态码 | |
message | String | 描述 | |
data | String | 描述信息 |
表data
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
total | integer | 查询实例总数 | |
pageRecords | object[] | 当前页实例列表 | pageRecords |
表pageRecords
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
id | integer | id | |
spuInstId | string | 产品实例id | |
bucketId | string | bucketId | |
state | integer | 任务状态,0-待启动;1-运行中;2-已成功;3-已取消;4-失败; | |
bucketName | string | 清理bucket-name | |
measurement | string | 清理指标名 | |
startTime | string | 任务开始时间 | |
endTime | string | 任务结束时间 | |
gmtModified | string | 更新时间 | |
gmtCreate | string | 创建时间 |
请求示例
请求头header
"regionId","39h54mest675e11ea91fc9432qw12867"
请求query
spuInstId=15377b3d15414dbd8efe394e5e981h97
请求体Boby
无
响应示例
{
"data": {
"total": 0,
"pageRecords": [
{
"id": 0,
"spuInstId": "",
"bucketId": "",
"state": 0,
"bucketName": "",
"measurement": "",
"startTime": "",
"endTime": "",
"gmtModified": "",
"gmtCreate": ""
}
]
},
"code": 0,
"message": ""
}
状态码
状态码 | 描述 |
---|---|
0 | 请求成功 |