文档首页/云防火墙 CFW/API参考 (联盟区域) /API/防火墙管理/获取CFW任务执行状态
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取CFW任务执行状态

功能介绍

获取CFW任务执行状态

URI

GET /v3/{project_id}/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式

job_id

是

String

创建按需防火墙返回的任务ID，可通过调用创建防火墙接口返回值获得。返回值中job_id即为此处的job_id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型，只有application/json的值是适用的

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

data

GetCreateFirewallJobResponseData object

创建按需防火墙返回数据。

表4 GetCreateFirewallJobResponseData

参数

参数类型

描述

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下的创建按需防火墙的job ID为的f588ce71-e26c-400d-8981-f854355f6849的任务情况。

https://{Endpoint}/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

获取创建按需防火墙任务情况接口返回值

错误码

请参见错误码。

父主题：防火墙管理