Query Firewall Tasks with DescribeFirewallTask API - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Retrieves a firewall task.

Operation description

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribeFirewallTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type. Valid values: zh (default): Chinese en: English	zh
ChildInstanceId	string	No	The child instance ID. You must specify at least one of ChildInstanceId and TaskId. If both are empty, the error MissingParameter.TaskId (-360448) is returned.	vfw-tr-cd6000c588214403****
TaskType	string	No	The type of the task. Valid values: NAT: NAT firewall task VPC: VPC firewall task	VPC
TaskId	string	No	The task ID. You must specify at least one of TaskId and ChildInstanceId. If both are empty, the error MissingParameter.TaskId (-360448, At least one of TaskId or ChildInstanceId is required.) is returned.	199431783

Response elements

Element	Type	Description	Example
	object
IsFound	boolean	Indicates whether the task exists.	false
TaskStatus	string	The task status. Valid values: init running finished rollback rollbackDone	init
TaskWaitingTime	string	The waiting time, in minutes.	30
TaskSteps	array<object>	The task steps.
	object	The task steps.
StepStatus	string	The task step status. Valid values: init running finished failed	init
StepName	string	The name of the Cloud Firewall security step.	Create Firewall
StepProgress	string	The progress of the task step.	80
StepInfo	string	The task information.	abcd
RequestId	string	The request ID.	7D5483BF-2262-586D-8706-BDDB8B42****
TaskName	string	The task name.	egressgw
TaskStartTimestamp	string	The time when the task was created.	17151361285
TaskFinishTimestamp	string	The time when the task was completed.	17151381075
TaskId	integer	The task ID.	189997648

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParameters	A parameter error occurred.	A parameter error occurred.
400	MissingParameter.TaskId	At least one of TaskId or ChildInstanceId is required.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.