接口功能介绍
查询任务状态
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/operation/list-logs
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| operationID | 是 | String | 任务ID | 717168d0-1d7a-11eb-91a1-005056898fe0 |
请求参数
请求header参数
无
请求body参数
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 总数 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 | |
| result | 否 | Array of Objects | 列表 | result |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| operationID | 否 | String | 任务ID | 717168d0-1d7a-11eb-91a1-005056898fe0 | |
| jobType | 否 | String | 本参数表示任务类型 取值范围: sdwan:sdwan |
sdwan | |
| status | 否 | String | 本参数表示任务状态 取值范围: done:完成 undone:未完成 failed:失败 unknown:未知 |
done | |
| updatedTime | 否 | String | 更新时间 | 2023-09-21 07:39:00 | |
| taskResults | 否 | Array of Objects | 任务结果 | [{"fuid": "ee24fec2-5851-11ee-a493-525400af7402"] |
请求示例
请求url
/v4/sdwan/operation/list-logs?operationID=717168d0-1d7a-11eb-91a1-005056898fe0
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"message": "",
"totalCount": 1,
"currentCount": 1,
"result": [
{
"operationID": "717168d0-1d7a-11eb-91a1-005056898fe0",
"jobType": "sdwan",
"status": "done",
"updated": "2023-09-21T07:39:00Z",
"taskResults": [{"region_id": "sdwan", "job_type": "sdwan", "task_channel": null, "created_time": null, "fuid": "ee24fec2-5851-11ee-a493- 525400af7402", "expect": null, "duration": 0, "job_id": "", "delete_time": null, "job_name": "取消跨账号授权", "updated": "2023-09-21T07:39:00Z", "task_args": {"site_id": "e0beeef2-c952-11ed-9c19-525400af7402", "customerId": "19bf37bb87cc4c86aa2542b06b4fa032"}, "task_result": {"error_code": "0000", "result": "取消跨账号授权成功"}, "entity_model": "edge", "finished": "2023-09-21T07:39:00Z", "entity": {}, "created": "2023-09-21T07:39:00Z", "expect_args": null, "timeout": null, "task_name": "EdgeCrossDelete", "operation_id": "ed81bfc8-5851-11ee-bc51-525400af7402", "task_status": "done"}]
}
]
}
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
