All Products
Search

This Product

    Cloud Firewall:DescribeFirewallTask

    Document Center

    Cloud Firewall:DescribeFirewallTask

    Last Updated:Oct 15, 2025

    Retrieves the details of a firewall task.

    Operation description

    QPS limit

    You can make up to 10 queries per second (QPS). If you exceed this limit, API calls are throttled, which may impact your business. We recommend that you plan your calls accordingly.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    The language of the response. Valid values:

    • zh (default): Chinese

    • en: English

    zh
    ChildInstanceId

    string

    No

    The ID of the VPC instance.

    vfw-tr-cd6000c588214403****
    Lang

    string

    No

    The language of the response. Valid values:

    • zh (default): Chinese

    • en: English

    zh
    TaskType

    string

    No

    The type of the task. Valid values:

    • NAT: NAT border task

    • VPC: VPC border task

    VPC
    TaskId

    string

    No

    The task ID.

    199431783

    Response elements

    Element

    Type

    Description

    Example

    object

    IsFound

    boolean

    Indicates whether the task exists.

    false
    TaskStatus

    string

    The status of the task. Valid values:

    • init

    • running

    • finished

    • rollback

    • rollbackDone

    init
    TaskWaitingTime

    string

    The waiting time in minutes.

    30
    TaskSteps

    array<object>

    The steps of the task.

    object

    The steps of the task.

    StepStatus

    string

    The status of the task step. Valid values:

    • init

    • running

    • finished

    • failed

    init
    StepName

    string

    Creating the Cloud Firewall.

    Create Firewall
    StepProgress

    string

    The progress of the task step.

    80
    StepInfo

    string

    The information about the task step.

    abcd
    RequestId

    string

    The ID of the request.

    7D5483BF-2262-586D-8706-BDDB8B42****
    TaskName

    string

    The name of the task.

    egressgw
    TaskStartTimestamp

    string

    The timestamp when the task started.

    17151361285
    TaskFinishTimestamp

    string

    The timestamp when the task was completed.

    17151381075
    TaskId

    integer

    The ID of the task.

    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.