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

Create 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:CreateTransportLayerApplication	create	*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****
RecordName	string	Yes	Domain name of the transport layer application.	aaa.example.com
Rules	array<object>	Yes	List of forwarding rules.
	object	Yes	Details of the rule. For each rule, except for the comment, all other parameters are required.
Protocol	string	Yes	Forwarding rule protocol, with values: TCP: TCP protocol. UDP: UDP protocol.	TCP
EdgePort	string	Yes	Edge port. Supports: A single port, such as 80. Port range, such as 81-85, representing ports 81, 82, 83, 84, and 85. Combination of ports and port ranges, separated by commas, such as 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, and 90. Edge ports within a single rule and between multiple rules must not overlap.	80
SourceType	string	Yes	Origin type, supporting: ip: IP address. domain: Domain name. OP: Origin pool. LB: Load balancer.	ip
SourcePort	string	Yes	Origin port. Supports: A single port, when the origin 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 origin port can be set to a port range, and the size of the range must match that of 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 do not match.	80
ClientIPPassThroughMode	string	Yes	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.	SPP
Source	string	Yes	Specific value of the origin, which needs to match the origin type.	1.1.1.1
Comment	string	No	Comment information for the rule (optional).	test
IpAccessRule	string	No	IP access rule switch. When enabled, the WAF's IP access rules apply to the transport layer application. on: Enabled. off: Disabled.	on
Ipv6	string	No	IPv6 switch. Enumeration Value: off: off. on: on.	off
CrossBorderOptimization	string	No	Whether to enable China mainland network access optimization, default is disabled. Value range: on: Enabled. off: Disabled.	on

Response parameters

Parameter	Type	Description	Example
	object	Request response details.
RequestId	string	Request ID.	9e5448c7-edaf-49aa-9887-0fcd0832306c
ApplicationId	long	Layer 4 application ID	165503967****

Examples

Sample success responses

JSONformat

{
  "RequestId": "9e5448c7-edaf-49aa-9887-0fcd0832306c",
  "ApplicationId": 0
}

Error codes

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

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	ApplyVipError	Failed to apply for ip resources, please contact customer service.	Failed to apply for IP resources, please contact customer service.
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	InvalidParameter.RecordData	Invalid record content. Adjust your configurations based on the API documentation.	Invalid record content. Adjust your configurations based on the API documentation.
400	InvalidParameter.RecordType	Invalid record type. Adjust your configurations based on the API documentation.	Invalid record type. Adjust your configurations based on the API documentation.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	Your plan is unavailable due to an overdue payment. Complete the payment first.
400	QuotaExceed.RecordCount	The maximum number of records has been reached. Delete some and try again or upgrade your plan.	The maximum number of records has been reached. Delete some and try again or upgrade your plan.
400	Record.Conflict	The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.	The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.
400	Site.ServiceBusy	This website is being configured. Try again later.	This website is being configured. Try again later.
400	TransportLayerRulesExceedLimit	The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.	The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.
400	TransportLayerApplicationConflict	The Layer -4 accelerated application conflicts with other applications. Check whether the application name and host record conflict with other applications in the site.	The Layer -4 accelerated application conflicts with other applications. Check whether the application name and host record conflict with other applications in the site.
400	SourceCircleExist	The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.	The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.
400	InvalidParameter.InvalidRecordName	The record name you entered does not meet the specifications. Change the record name according to the product documentation.	The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.
400	EdgePortsOverlap	There is overlap between multiple edge ports, please check and try again after modification.	There is overlap between multiple edge ports, please check and try again after modification.
400	InvalidParameter.ClientIpPassThroughMode	Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.	Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.
400	InvalidParameter.RuleSource	The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.	The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.
400	InvalidParameter.Port	Invalid edge port or origin port. Enter a valid port as required in the interface document.	Invalid edge port or origin port. Enter a valid port as required in the interface document.
400	InvalidParameter.Protocol	Invalid port protocol. Enter a valid port protocol as required by the interface documentation.	Invalid port protocol. Enter a valid port protocol as required by the interface documentation.
400	InternalError	An internal exception occurred, please try again later.	An inner exception was triggered. Please try again later.
400	IpaResourceUnavailable	The resource is unavailable.	The resource is unavailable.
400	Record.NoResource	Failed to allocate resources for the record. Please submit a ticket for processing.	Failed to allocate resources for the record. Please submit a work order for processing.