DescribeFirewallTask - 获取防火墙任务-云防火墙(Cloud Firewall)-阿里云帮助中心

获取防火墙任务。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:DescribeFirewallTask

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	语言类型。取值： zh（默认）：中文 en：英文	zh
ChildInstanceId	string	否	子实例 ID。ChildInstanceId 与 TaskId 至少提供一个；两者均为空时返回 MissingParameter.TaskId（-360448）。	vfw-tr-cd6000c588214403****
TaskType	string	否	任务的类型。枚举类型： NAT：NAT 边界任务 VPC：VPC 边界任务	VPC
TaskId	string	否	任务 ID。TaskId 与 ChildInstanceId 至少提供一个；两者均为空时返回 MissingParameter.TaskId（-360448，At least one of TaskId or ChildInstanceId is required.）。	199431783

返回参数

名称	类型	描述	示例值
	object
IsFound	boolean	是否存在任务。	false
TaskStatus	string	任务状态。取值： init running finished rollback rollbackDone	init
TaskWaitingTime	string	等待时间，单位：分钟。	30
TaskSteps	array<object>	任务步骤。
	object	任务步骤。
StepStatus	string	任务步骤状态。枚举类型： init running finished failed	init
StepName	string	创建云防火墙安全。	Create Firewall
StepProgress	string	任务步骤进度。	80
StepInfo	string	任务信息。	abcd
RequestId	string	返回结果的请求 ID。	7D5483BF-2262-586D-8706-BDDB8B42****
TaskName	string	任务名称。	egressgw
TaskStartTimestamp	string	任务创建时间。	17151361285
TaskFinishTimestamp	string	任务完成时间。	17151381075
TaskId	integer	任务 ID。	189997648

示例

正常返回示例

JSON格式

{
  "IsFound": false,
  "TaskStatus": "init",
  "TaskWaitingTime": "30",
  "TaskSteps": [
    {
      "StepStatus": "init",
      "StepName": "Create Firewall",
      "StepProgress": "80",
      "StepInfo": "abcd"
    }
  ],
  "RequestId": "7D5483BF-2262-586D-8706-BDDB8B42****",
  "TaskName": "egressgw",
  "TaskStartTimestamp": "17151361285",
  "TaskFinishTimestamp": "17151381075",
  "TaskId": 189997648
}

错误码

HTTP status code	错误码	错误信息	描述
400	ErrorParameters	A parameter error occurred.	参数错误
400	MissingParameter.TaskId	At least one of TaskId or ChildInstanceId is required.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。