tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Firewall
    Documentation
    Download PDF

    DescribeSwitchLists

    Last updated: 2023-05-04 17:40:14
    Download PDF

    1. API Description

    Domain name for API request: cfw.tencentcloudapi.com.

    This API is used to get the firewall status list.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeSwitchLists.
    Version Yes String Common Params. The value used for this API: 2019-09-04.
    Region No String Common Params. This parameter is not required for this API.
    Status No Integer Firewall status. 0: disabled; 1: enabled
    Type No String Asset type, e.g. CVM/NAT/VPN/CLB/others
    Area No String Region, e.g. Shanghai, Chongqing, Guangzhou, etc.
    SearchValue No String Search value, e.g. "{"common":"106.54.189.45"}"
    Limit No Integer Number of entries. Default: 10
    Offset No Integer Offset. Default: 0
    Order No String Sort order. desc: descending; asc: ascending
    By No String Sorting field. PortTimes (number of risky ports)

    3. Output Parameters

    Parameter Name Type Description
    Total Integer Total entries
    Data Array of SwitchListsData List data
    AreaLists Array of String Region list
    OnNum Integer Number of enabled firewalls
    Note: This field may return null, indicating that no valid value was found.
    OffNum Integer Number of disabled firewalls
    Note: This field may return null, indicating that no valid value was found.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the firewall status list

    Input Example

    POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSwitchLists
<Common request parameters>

{
    "SearchValue": "",
    "Status": -1,
    "Type": "",
    "Area": "",
    "Limit": 10,
    "Offset": 0,
    "Order": "",
    "By": ""
}

    Output Example

    {
    "Response": {
        "Total": 110,
        "Data": [],
        "AreaLists": [],
        "OffNum": 10,
        "OnNum": 10,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InvalidParameter Invalid parameter.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy