All Products
Search

This Product

    Edge Security Acceleration:ListTransportLayerApplications

    Document Center

    Edge Security Acceleration:ListTransportLayerApplications

    Last Updated:Jun 25, 2026

    Query the list of Layer 4 applications for a site.

    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

    esa:ListTransportLayerApplications

    list

    *Site

    acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SiteId

    integer

    Yes

    Site ID. You can obtain it by calling the ListSites API.

    123456******
    PageNumber

    integer

    No

    The page number for paginated queries. The value must be greater than or equal to 1.

    1
    PageSize

    integer

    No

    The number of entries per page for paginated queries. Valid values: 1-500.

    500
    MatchType

    string

    No

    The query type for the host record of Layer 4 applications. The following four types are supported, and the default is exact match.

    • fuzzy: Fuzzy match.

    • exact: Exact match.

    • prefix: Prefix match.

    • suffix: Suffix match.

    Valid values:

    • prefix :

      prefix match.

    • exact :

      exact match.

    • suffix :

      suffix match.

    • fuzzy :

      fuzzy match.

    fuzzy
    RecordName

    string

    No

    The host record of the Layer 4 application.

    www.example.com

    Response elements

    Element

    Type

    Description

    Example

    object

    The response.

    RequestId

    string

    The request ID.

    CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
    PageNumber

    integer

    The current page number, same as the PageNumber request parameter.

    1
    PageSize

    integer

    The number of entries per page.

    1
    TotalCount

    integer

    The total number of Layer 4 applications.

    1
    Applications

    array<object>

    The list of Layer 4 applications.

    array<object>

    Details of a Layer 4 application.

    Rules

    array<object>

    The list of forwarding rules.

    object

    Details of a forwarding rule.

    Protocol

    string

    The protocol of the forwarding rule. Valid values:

    • TCP: TCP protocol.

    • UDP: UDP protocol.

    TCP
    EdgePort

    string

    The edge port. The following formats are supported:

    • A single port, such as 80.

    • A port range, such as 81-85, which represents ports 81, 82, 83, 84, and 85.

    • A combination of ports and port ranges separated by commas, such as 80,81-85,90, which represents ports 80, 81, 82, 83, 84, 85, and 90.

    80
    SourcePort

    string

    The origin server port. The following formats are supported:

    • A single port. When the origin server port is a single port, any valid edge port combination is supported.

    • A port range. The origin server port can be set to a port range only when the edge port is also a port range, and the range size must match the edge port range. For example, if the edge port is 90-93, you cannot set the origin server port to 81-85 because the origin server port range is 5 while the edge port range is 4, which are inconsistent.

    80
    Source

    string

    The specific value of the origin server, which must match the origin server type.

    1.1.1.1
    Comment

    string

    The remarks for the rule.

    Test
    ClientIPPassThroughMode

    string

    The client IP pass-through protocol. Valid values:

    • off: Disabled.

    • PPv1: PROXY Protocol v1, which supports client IP pass-through for TCP.

    • PPv2: PROXY Protocol v2, which supports client IP pass-through for TCP and UDP.

    • SPP: Simple Proxy Protocol, which supports client IP pass-through for UDP.

    off
    SourceType

    string

    The origin server type. Valid values:

    • ip: IP address.

    • domain: domain name.

    • OP: IPAM pool.

    • LB: load balancing.

    ip
    RuleId

    integer

    The ID of the Layer 4 acceleration rule.

    20258028****
    ApplicationId

    integer

    The Layer 4 application ID.

    170997271816****
    RecordName

    string

    The domain name of the Layer 4 application.

    test.example.com

    SiteId

    integer

    The site ID.

    36556540048****
    RulesCount

    integer

    The number of forwarding rules contained in the Layer 4 acceleration application.

    1
    Cname

    string

    The CNAME domain name corresponding to the Layer 4 acceleration application. This field is non-empty only when the site is connected via the CNAME method.

    example.com.ialicdn.com

    IpAccessRule

    string

    The IP access rule switch. When enabled, the IP access rules in WAF take effect for the Layer 4 application.

    • on: Enabled.

    • off: Disabled.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    on
    Ipv6

    string

    The IPv6 switch. Valid values:

    • on: Enabled.

    • off: Disabled.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    on
    Status

    string

    The status of the Layer 4 application.

    • deploying: Deploying. Modification and deletion are not allowed in this state.

    • active: Active.

    Valid values:

    • deploying :

      Being deployed.

    • active :

      Active.

    active
    CrossBorderOptimization

    string

    Indicates whether mainland China network access optimization is enabled. Disabled by default. Valid values:

    • on: Enabled.

    • off: Disabled.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    on
    StaticIp

    string

    Indicates whether static IP is enabled. Disabled by default. Valid values:

    • on: Enabled.

    • off: Disabled.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    on
    StaticIpV4List

    array<object>

    The list of static IPv4 addresses assigned to this Layer 4 application after the static IP feature is enabled.

    object

    A single static IPv4 address, including the IP address and its status.

    Address

    string

    The IP address.

    1.1.1.2
    Status

    string

    The status of the IP address. Valid values:

    • healthy: Healthy.

    • unhealthy: Unhealthy.

    • unknown: The IP address is being prepared.

    Valid values:

    • healthy :

      Healthy.

    • unhealthy :

      Unhealthy.

    • unknown :

      The IP address is being prepared.

    healthy
    KeepAliveProtection

    string

    Indicates whether keep-alive protection is enabled. Disabled by default. Valid values:

    • on: Enabled.

    • off: Disabled.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    off

    Examples

    Success response

    JSON format

    {
  "RequestId": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE",
  "PageNumber": 1,
  "PageSize": 1,
  "TotalCount": 1,
  "Applications": [
    {
      "Rules": [
        {
          "Protocol": "TCP",
          "EdgePort": "80",
          "SourcePort": "80",
          "Source": "1.1.1.1",
          "Comment": "Test",
          "ClientIPPassThroughMode": "off",
          "SourceType": "ip",
          "RuleId": 0
        }
      ],
      "ApplicationId": 0,
      "RecordName": "test.example.com\n",
      "SiteId": 0,
      "RulesCount": 1,
      "Cname": "example.com.ialicdn.com\n",
      "IpAccessRule": "on",
      "Ipv6": "on",
      "Status": "active",
      "CrossBorderOptimization": "on",
      "StaticIp": "on",
      "StaticIpV4List": [
        {
          "Address": "1.1.1.2",
          "Status": "healthy"
        }
      ],
      "KeepAliveProtection": "off"
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InternalException Failed to call the service. Try again later or contact technical support. Failed to call the service. Try again later or contact technical support.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.