获取CFW任务执行状态
功能介绍
获取CFW任务执行状态
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/jobs/{job_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
job_id |
是 |
String |
任务ID,可通过创建防火墙接口返回值获得。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
执行结果 |
trace_id |
String |
trace id |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
任务ID |
status |
String |
任务执行状态。 取值: 值为“Running”,表示任务正在执行。 值为“Success”,表示任务执行成功。 值为“Failed”,表示任务执行失败。 |
begin_time |
String |
创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 |
end_time |
String |
结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 |
请求示例
获取项目09bb24e6fe80d23d2fa2c010b53b418c下的jobid为的f588ce71-e26c-400d-8981-f854355f6849的任务情况
/v3/09bb24e6fe80d23d2fa2c010b53b418c/jobs/f588ce71-e26c-400d-8981-f854355f6849
响应示例
状态码: 200
获取任务情况接口返回值
{ "data" : { "begin_time" : 1641370501000, "end_time" : 1641370515000, "id" : "f588ce71-e26c-400d-8981-f854355f6849", "status" : "Success" } }
状态码
状态码 |
描述 |
---|---|
200 |
获取任务情况接口返回值 |
错误码
请参见错误码。