ListTransportLayerApplications - Edge Security Acceleration

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

List of Transport Layer Applications

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:ListTransportLayerApplications	list	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	Site ID, which can be obtained by calling the ListSites API.	123456******
PageNumber	integer	No	Page number set for pagination. Starting value: 1. Default value: 1.	1
PageSize	integer	No	Page size. The maximum value is 500.	500
MatchType	string	No	Query type for the transport layer application host record, supporting the following 4 types, with exact query as the default. fuzzy: Fuzzy query. exact: Exact query. prefix: Prefix match query. suffix: Suffix match query.	fuzzy
RecordName	string	No	Host record of the transport layer application.	www.example.com

Response parameters

Parameter	Type	Description	Example
	object	Request response.
RequestId	string	Request ID.	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
PageNumber	integer	Current page number.	1
PageSize	integer	Page size.	1
TotalCount	integer	Total number of transport layer applications.	1
Applications	array<object>	List of transport layer applications.
item	object	Details of the transport layer application.
Rules	array<object>	List of forwarding rules.
item1	object	Details of the forwarding rule.
Protocol	string	Forwarding rule protocol, with values: TCP: TCP protocol. UDP: UDP protocol.	TCP
EdgePort	string	Edge port. Supports: A single port, e.g., 80. Port range, e.g., 81-85, representing ports 81, 82, 83, 84, 85. Combination of ports and port ranges, separated by commas, e.g., 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, 90.	80
SourcePort	string	Source port. Supports: A single port, when the source port is a single port, any valid combination of edge ports is supported. Port range, only when the edge port is a port range, the source port can be set to a port range, and the range size must be consistent with the edge port. For example, if the edge port is 90-93, the source port cannot be set to 81-85 because the source port range is 5 and the edge port range is 3, which are inconsistent.	80
Source	string	Specific value of the source, which needs to match the source type.	1.1.1.1
Comment	string	Comment information for the rule.	test
ClientIPPassThroughMode	string	Client IP pass-through protocol, supports: off: No pass-through. PPv1: PROXY Protocol v1, supports client IP pass-through for TCP protocol. PPv2: PROXY Protocol v2, supports client IP pass-through for TCP and UDP protocols. SPP: Simple Proxy Protocol, supports client IP pass-through for UDP protocol.	off
SourceType	string	Source type, supports: ip: IP. domain: Domain name. OP: Origin pool. LB: Load balancer.	ip
RuleId	long	Layer 4 acceleration rule ID.	20258028****
ApplicationId	long	Layer 4 application ID.	170997271816****
RecordName	string	Domain name of the Layer 4 application.	test.example.com
SiteId	long	Site ID.	36556540048****
RulesCount	integer	Number of forwarding rules contained in the Layer 4 acceleration application.	1
Cname	string	CNAME domain name corresponding to the Layer 4 acceleration application. This field is not empty only when the site is accessed via CNAME.	example.com.ialicdn.com
IpAccessRule	string	IP access rule switch. When enabled, the IP access rules in WAF take effect on the Layer 4 application. on: Enabled. off: Disabled.	on
Ipv6	string	IPv6 switch. Enumeration Value: off: off. on: on.	on
Status	string	Status of the Layer 4 application deploying: Deploying. In this state, modification and deletion are not allowed. active: Active.	active
CrossBorderOptimization	string	Whether to enable China mainland network access optimization. It is disabled by default. The value range is: on: Enabled. off: Disabled.	on

Examples

Sample success responses

JSONformat

{
  "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": "",
      "StaticIpV4List": [
        {
          "Address": "",
          "Status": ""
        }
      ]
    }
  ]
}

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.

For a list of error codes, visit the Service error codes.