Get Layer 7 Forwarding Rule

Last updated: 2020-06-09 15:28:24


    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new Anti-DDoS Advanced API 3.0 which is standardized and faster.

    API Description

    This API (BGPIPGetWadTransRules) is used to get the list of layer-7 forwarding rules of an Anti-DDoS Advanced instance
    Protocol: HTTPS
    Domain Name:
    API: BGPIPGetWadTransRules

    Request Parameters

    Below is a list of API request parameters. You need to add common request parameters to your request when calling this API. For more information, see Common Request Parameters. The Action field for this API is BGPIPGetWadTransRules.

    Parameter Required Type Description
    bgpId Yes String Resource ID of the Anti-DDoS Advanced instance
    paging.index Yes Integer Page Index. 0: page 1.
    paging.count Yes Integer Number of results per page

    Response Parameters

    Parameter Example Type Description
    total 123 Integer Number of forwarding rules that have been configured for the Anti-DDoS Advanced instance
    transRules [obj,…] Array Attack details. Elements:
    "id": "rule-00000001",
    "protocol": "http"
    "domain": "",
    "sourceType": 1/2,
    "ipList": ";",
    "certType": 1,
    "cert": "",
    "privateKey": "",
    "status": 1/2/3,
    "ssl_id": ""
    id rule-00000001 String ID of the forwarding rule
    protocol http String IP Protocol of the forwarding rule
    The value can be http, https or http/https.
    domain String Public domain name (accessible to the clients)
    sourceType 1
    Integer Types of real servers
    1: Domain name
    2: IP
    ipList; String a list of IPs or domain names of the real server.
    IPs or domain names are returned according to the value of sourceType.
    certType 1 Integer Certificate type. Always 1.
    cert String Certificate content
    privateKey String Certificate private key
    status 0
    Integer The status of forwarding rule configuration
    0: Configured successfully
    1: Configuring
    2: Configuration failed
    ssl_id String Optional

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback