GetTransportLayerApplication - Edge Security Acceleration

Gets 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. Call the ListSites operation to get this ID.	123456****
ApplicationId	integer	Yes	The application ID. Call the ListTransportLayerApplications operation to get this ID.	170997271816****

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The ID of the request.	EB635996-1FD6-5DFD-BA57-27A849599940
SiteId	integer	The ID of the Site.	123456****
ApplicationId	integer	The ID of the Transport Layer Application.	17099311410****
RulesCount	integer	The number of Forwarding Rules in the Transport Layer Application.	1
Rules	array<object>	A list of Forwarding Rules.
	object	The details of a Forwarding Rule.
Source	string	The address of the Origin, which must match the specified SourceType.	1.1.1.1
Protocol	string	The protocol for the Forwarding Rule. Valid values: TCP: The TCP protocol. UDP: The 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 includes ports 81, 82, 83, 84, and 85. A combination of ports and port ranges separated by commas, such as `80,81-85,90`, which includes ports 80, 81, 82, 83, 84, 85, and 90.	80
SourceType	string	The origin type. Valid values: ip: An IP address. domain: A Domain Name. OP: An Origin Address Pool. LB: A Load Balancer.	domain
SourcePort	string	The Origin Port. The following formats are supported: A single port. If the Origin Port is a single port, any valid combination of Edge Ports is supported. A port range. A range is valid only if the Edge Port is also a port range and both ranges have the same number of ports. For example, if the Edge Port is `90-93` (4 ports), you cannot set the Origin Port to `81-85` (5 ports) because the ranges are different sizes.	80
ClientIPPassThroughMode	string	The client IP pass-through mode. Valid values: off: Client IP pass-through is disabled. PPv1: PROXY Protocol v1, which supports client IP pass-through for TCP. PPv2: PROXY Protocol v2, which supports client IP pass-through for both TCP and UDP. SPP: Simple Proxy Protocol, which supports client IP pass-through for UDP.	off
Comment	string	The comment for the Forwarding Rule.	测试
RuleId	integer	The ID of the Forwarding Rule.	1234323***
Cname	string	The CNAME domain name of the Transport Layer Application. This field is returned only when the Site was added using the CNAME method.	example.com.ialicdn.com
RecordName	string	The Domain Name of the Transport Layer Application.	test.example.com
IpAccessRule	string	Indicates whether the IP Access Rule feature is enabled. If enabled, the IP Access Rules in WAF take effect for the Transport Layer Application. Valid values: on: Enabled. off: Disabled. Valid values: off : off on : on	on
Ipv6	string	Indicates whether IPv6 is enabled. Valid values: Valid values: off : off on : on	on
Status	string	The status of the Transport Layer Application. Valid values: deploying: The application is deploying. You cannot modify or delete the application in this state. active: The application is active. Valid values: deploying : deploying active : active	active
CrossBorderOptimization	string	Indicates whether network optimization for access from the Chinese mainland is enabled. This feature is disabled by default. Valid values: on: Enabled. off: Disabled. Valid values: off : off on : on	on
StaticIp	string
StaticIpV4List	array<object>
	object
Address	string
Status	string

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": "测试",
      "RuleId": 0
    }
  ],
  "Cname": "example.com.ialicdn.com",
  "RecordName": "test.example.com",
  "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.
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.