Task相关接口
更新时间：2024-03-18
获取任务列表
描述
获取任务列表
请求结构
GET /v2/tasks/{taskType} HTTP/1.1
Host: cce.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| taskType | String | 是 | URL 参数 | 任务类型，目前仅支持 [InstanceGroupReplicas] |
| targetID | String | 依任务类型而定 | Query 参数 | 任务目标对象 ID，如任务类型为 InstanceGroupReplicas 时，targetID 是目标节点组的 ID |
| operationType | String | 否 | Query 参数 | 操作类型，目前支持[ScalingUp,ScalingDown,Repair] |
| phase | String | 否 | Query 参数 | 任务状态，目前支持[Pending,Processing,Done,Aborted,Collecting] |
| order | String | 否, 默认为DESC(降序) | Query 参数 | 排序方式，目前支持[ASC,DESC] |
| orderBy | String | 否, 默认为created_at（创建时间） | Query 参数 | 排序字段，目前仅支持[created_at] |
| pageNo | Integer | 否 | Query 参数 | 查询页码序号. pageNo 或 pageSize 为0时不分页 |
| pageSize | Integer | 否 | Query 参数 | 查询结果每页条目数. pageNo 或 pageSize 为0时不分页 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| page | ListTaskPage | 是 | 任务查询结果页 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
请求示例
GET /api/cce/service/v2/tasks/InstanceGroupReplicas?pageNo=1&pageSize=2&targetID=cce-ig-rw9no39g HTTP/1.1
Host: cce.bj.baidubce.com
Content-Type: application/json
Authorization: authorization string返回示例
{
"requestID": "a2babfce-eb20-45a3-9f62-4472b9e8c77a",
"Page": {
"pageNo": 1,
"pageSize": 2,
"totalCount": 86,
"items": [
{
"id": "task-cce-ig-rw9no39g-scaledown-qe4w65ed",
"type": "InstanceGroupReplicas",
"description": "remove specified instances from instance group",
"startTime": "2021-07-02T07:49:34Z",
"finishTime": "2021-07-02T07:49:54Z",
"phase": "Done",
"processes": [
{
"name": "RemoveInstancesFromInstanceGroup",
"phase": "Done",
"startTime": "2021-07-02T15:49:34+08:00",
"finishTime": "2021-07-02T15:49:54+08:00",
"metrics": {
"cce-91xd2ojb-e6w8tv9s": "Succeed"
}
}
]
},
{
"id": "task-cce-ig-rw9no39g-scaleup-94ynzbep",
"type": "InstanceGroupReplicas",
"description": "scale up instance group replicas to 1",
"startTime": "2021-07-02T06:41:23Z",
"finishTime": "2021-07-02T06:43:58Z",
"phase": "Done",
"processes": [
{
"name": "CreateMachines",
"phase": "Done",
"startTime": "2021-07-02T14:41:23+08:00",
"finishTime": "2021-07-02T14:41:27+08:00",
"metrics": {
"OrderID": "0d458620f1aa4bf1a56ba4f7c25d8691",
"TryExecuteCount": "1",
"i-Qx8MqYRX": ""
}
},
{
"name": "MoveMachinesIntoInstanceGroup",
"phase": "Done",
"startTime": "2021-07-02T14:41:27+08:00",
"finishTime": "2021-07-02T14:43:58+08:00",
"metrics": {
"cce-91xd2ojb-e6w8tv9s": "running"
}
}
]
}
]
}
}查看任务详情
描述
查看任务详情
请求结构
GET /v2/task/{taskType}/{taskID} HTTP/1.1
Host: cce.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| taskType | String | 是 | URL 参数 | 任务类型，目前仅支持 [InstanceGroupReplicas] |
| taskID | String | 是 | URL 参数 | 任务 ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| task | Task | 是 | 任务详情 |
| requestID | String | 是 | 请求 ID, 问题定位提供该 ID |
请求示例
GET /api/cce/service/v2/task/InstanceGroupReplicas/task-cce-ig-l68ajx08-scaleup-vyhwv1ch HTTP/1.1
Host: cce.bj.baidubce.com
Content-Type: application/json
Authorization: authorization string返回示例
{
"requestID": "b497e74c-27a6-4aa5-990e-3924d5668216",
"task": {
"id": "task-cce-ig-l68ajx08-scaleup-vyhwv1ch",
"type": "InstanceGroupReplicas",
"description": "scale up instance group replicas to 2",
"startTime": "2021-06-29T03:10:59Z",
"finishTime": "2021-06-29T03:27:49Z",
"phase": "Done",
"processes": [
{
"name": "CreateMachines",
"phase": "Done",
"startTime": "2021-06-29T11:10:59+08:00",
"metrics": {
"OrderID": "d3af5387cdd843df9117379424b8dd4b",
"TryExecuteCount": "1",
"i-0Ggohv2Q": "",
"i-MYoajSI5": ""
}
},
{
"name": "MoveMachinesIntoInstanceGroup",
"phase": "Done",
"startTime": "2021-06-29T11:11:02+08:00",
"metrics": {
"cce-91xd2ojb-18ebod1q": "running",
"cce-91xd2ojb-r8lrb2ih": "running"
}
}
]
}
}