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

Query details of the transport layer application

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:GetTransportLayerApplication	get	*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 interface.	123456****
ApplicationId	long	Yes	Application ID, which can be obtained by calling the ListTransportLayerApplications interface.	170997271816****

Response parameters

Parameter	Type	Description	Example
	object	Request response.
RequestId	string	Id of the request	EB635996-1FD6-5DFD-BA57-27A849599940
SiteId	long	Site ID.	123456****
ApplicationId	long	Transport layer application ID.	17099311410****
RulesCount	integer	Number of forwarding rules contained in the transport layer acceleration application.	1
Rules	array<object>	List of forwarding rules.
item	object	Details of the forwarding rule.
Source	string	Specific value of the origin, which needs to match the type of the origin.	1.1.1.1
Protocol	string	Forwarding rule protocol, with values: TCP: TCP protocol. UDP: UDP protocol.	TCP
EdgePort	string	Edge port. Supports: A single port, such as 80. Port range, such as 81-85, representing ports 81, 82, 83, 84, 85. Combination of ports and port ranges, separated by commas, for example 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, 90.	80
SourceType	string	Origin type, supporting: ip: IP. domain: Domain name. OP: Origin pool. LB: Load balancer.	domain
SourcePort	string	Origin port. Supports: A single port, when the origin port is a single port, any valid edge port combination is supported. Port range, only when the edge port is a port range, the origin port can be set as a port range and the size of the range must be consistent with the edge port. For example, if the edge port is 90-93, the origin port cannot be set to 81-85 because the origin port range is 5 and the edge port range is 3, which are inconsistent.	80
ClientIPPassThroughMode	string	Client IP pass-through protocol, supporting: 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
Comment	string	Comment information of the rule.	测试
RuleId	long	Rule ID.	1234323***
Cname	string	The CNAME domain corresponding to the transport layer acceleration application. This field is not empty only when the site is accessed via CNAME.	example.com.ialicdn.com
RecordName	string	The domain name of the transport layer application.	test.example.com
IpAccessRule	string	Switch for IP access rules. When turned on, the IP access rules in WAF take effect on the transport layer application. on: Turned on. off: Turned off.	on
Ipv6	string	IPv6 switch. Enumeration Value: off: off. on: on.	on
Status	string	Status of the transport layer 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, default is off. Value range: on: Enabled. off: Disabled.	on

Examples

Sample success responses

JSONformat

{
  "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.

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