GetTransportLayerApplication API Reference - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries the details of a Layer 4 application.

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:GetTransportLayerApplication

get

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID, which can be obtained by calling the ListSites operation.	123456****
ApplicationId	integer	Yes	The application ID, which can be obtained by calling the ListTransportLayerApplications operation.	170997271816****

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	EB635996-1FD6-5DFD-BA57-27A849599940
SiteId	integer	The site ID.	123456****
ApplicationId	integer	The Layer 4 application ID.	17099311410****
RulesCount	integer	The number of forwarding rules in the Layer 4 acceleration application.	1
Rules	array<object>	The list of forwarding rules.
	object	The forwarding rule details.
Source	string	The specific value of the origin server, which must match the origin server type.	1.1.1.1
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
SourceType	string	The origin server type. Valid values: ip: IP address. domain: domain name. OP: IPAM pool. LB: load balancing.	domain
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 a port range, and the range size must be the same as 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
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
Comment	string	The comment for the rule.	Test
RuleId	integer	The rule ID.	1234323***
Cname	string	The CNAME domain name of the Layer 4 acceleration application. This field is non-empty only when the site is connected by using the CNAME method.	example.com.ialicdn.com
RecordName	string	The domain name of the Layer 4 application.	test.example.com
IpAccessRule	string	The IP access rule switch. When enabled, IP access rules in WAF take effect for the Layer 4 application. Valid values: 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 Layer 4 application status. Valid values: deploying: Being deployed. Modifications and deletions are not allowed in this state. active: Active. Valid values: deploying : Being deployed. active : Active.	active
CrossBorderOptimization	string	Specifies whether to enable network access optimization for the Chinese mainland. This feature is disabled by default. Valid values: on: Enabled. off: Disabled. Valid values: off : Disabled. on : Enabled.	on
StaticIp	string	Specifies whether to enable static IP. This feature is disabled by default. Valid values: on: Enabled. off: Disabled.	off
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 entry, 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.	healthy
KeepAliveProtection	string	Specifies whether to enable keep-alive protection. This feature is disabled by default. Valid values: on: Enabled. off: Disabled. Valid values: off : Disabled. on : Enabled.	off

Examples

Success response

JSON format

{
  "RequestId": "EB635996-1FD6-5DFD-BA57-27A849599940",
  "SiteId": 0,
  "ApplicationId": 0,
  "RulesCount": 1,
  "Rules": [
    {
      "Source": "1.1.1.1",
      "Protocol": "TCP",
      "EdgePort": "80",
      "SourceType": "domain",
      "SourcePort": "80",
      "ClientIPPassThroughMode": "off",
      "Comment": "Test",
      "RuleId": 0
    }
  ],
  "Cname": "example.com.ialicdn.com",
  "RecordName": "test.example.com",
  "IpAccessRule": "on",
  "Ipv6": "on",
  "Status": "active",
  "CrossBorderOptimization": "on",
  "StaticIp": "off",
  "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.
400	TransportLayerApplicationNotExist	The layer -4 accelerated application of the current operation does not exist. Modify it and try again.	The layer -4 accelerated application of the current operation does not exist. Modify it and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.