接口功能介绍
创建指定条件的数据清理任务。
接口定义
接口名称 | 获取实例详情 |
---|---|
承载协议 | HTTPS |
承载网络 | 外网 |
请求方式 | Post |
数据格式 | |
约束 | 实例处于运行状态 |
测试环境接口URL | https://influxdb-global.ctapi-test.ctyun.cn/v1/console/openapi/cleartask/create |
生产环境接口URL | https://influxdb-global.ctapi.ctyun.cn/v1/console/openapi/cleartask/create |
请求参数
header参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
regionId | 是 | header | String | 当前实例所属资源池 |
请求体body参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
spuInstId | 是 | body | String | 实例id |
bucketId | 是 | body | string | bucketId长度需要为16位 |
measurement | 否 | body | string | 不传该参数表示清理全部measurements |
rangeFrom | 否 | body | string | 日期格式:yyyy-MM-dd HH:mm:ss,rangeFrom与rangeTo都不传表示全部时间范围,传递rangeFrom不传rangeTo 表示rangeFrom至今 |
rangeTo | 否 | body | string | 日期格式:yyyy-MM-dd HH:mm:ss ,rangeFrom与rangeTo都不穿表示全部时间范围,传递rangeTo不传rangeFrom 表示1970-01-01至今 |
filters | 否 | body | object[] | 过滤标签信息 |
请求体参数表 filters
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
filterName | 是 | body | string | 标签名 |
filterValue | 是 | body | string | 标签值 |
响应结果
响应Body参数
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
code | Integer | 返回状态码 | |
message | String | 描述 | |
data | Long | 任务id | data |
请求示例
请求头header
"regionId","39h54mest675e11ea91fc9432qw12867"
请求体Body
{
"spuInstId": "",
"bucketId": "",
"measurement": "",
"rangeFrom": "",
"rangeTo": "",
"filters": [
{
"filterName": "",
"filterValue": ""
}
]
}
响应示例
{
"data": 1,
"code": 0,
"message": ""
}
状态码
状态码 | 描述 |
---|---|
0 | 请求成功 |