Deploy ESA Edge Container Apps Across Multiple POPs - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Creates an edge container application. You can deploy and release the application by version to containerize edge services. Note: Activate the EdgeContainer service in the console before calling this operation. Calls from accounts that have not activated the service will return a service activation error.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The application name. The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name must be 6 to 128 characters in length. Important Activate the EdgeContainer service in the console before calling this operation. Calls from accounts that have not activated the service will return a service activation error.	app-test
ServicePort	integer	Yes	The server port number. Only 80 and 443 are accepted.	80
TargetPort	integer	Yes	The backend port, which is also the service port of the application. Valid values: 1 to 65535.	80
Remarks	string	No	The remarks. If this parameter is not specified, the value is empty by default.	test app
HealthCheckType	string	No	The health check type, which includes Layer 4 and Layer 7 probing. If this parameter is not specified, the value is empty by default. Valid values: l4: Layer 4 probing. l7: Layer 7 probing.	l7
HealthCheckHost	string	No	The domain name used for health checks. If this parameter is not specified, the value is empty by default.	www.aliyun.com
HealthCheckHttpCode	string	No	The HTTP status code that indicates the health check is Normal. Valid values: http_2xx (default). http_3xx.	http_2xx
HealthCheckMethod	string	No	The health check method for HTTP-type listeners. Valid values: HEAD (default): Requests only the headers of the page. GET: Requests the specified page information and returns the entity body.	HEAD
HealthCheckURI	string	No	The URI used for health checks. The length is limited to 1 to 80 characters. Default value: "/".	/health_check
HealthCheckPort	integer	No	The port used for health checks. Valid values: 1 to 65535. Default value: 80.	80
HealthCheckTimeout	integer	No	The amount of time to wait for a response from the health check. If the backend ECS instance does not respond correctly within the specified time, the health check is considered failed. Valid values: 1 to 100. Default value: 3. Unit: seconds.	5
HealthCheckInterval	integer	No	The interval between health checks. Valid values: 1 to 50. Default value: 5. Unit: seconds.	5
HealthCheckSuccTimes	integer	No	The number of consecutive successful health checks required. If an application is unhealthy, it is considered healthy again after the specified number of consecutive successful probes. Valid values: 1 to 10. Default value: 2.	2
HealthCheckFailTimes	integer	No	The number of consecutive failed health checks required. If an application is healthy, it is considered unhealthy after the specified number of consecutive failed probes. Valid values: 1 to 10. Default value: 5.	3

Response elements

Element	Type	Description	Example
	object	The response object.
AppId	string	The ID of the created application.	app-880688675783794688
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "AppId": "app-880688675783794688",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.HealthCheckType	Specified parameter HealthCheckType is not valid.	Parameter HealthCheckType format is incorrect.
400	InvalidParameter.HealthCheckHost	Specified parameter HealthCheckHost is not valid.	Parameter HealthCheckHost format is incorrect.
400	InvalidParameter.HealthCheckHttpCode	Specified parameter HealthCheckHttpCode is not valid.	Parameter HealthCheckHttpCode format is incorrect.
400	InvalidParameter.HealthCheckMethod	Specified parameter HealthCheckMethod is not valid.	Parameter HealthCheckMethod format is incorrect.
400	InvalidParameter.HealthCheckURI	Specified parameter HealthCheckURI is not valid.	Parameter HealthCheckURI format is incorrect.
400	InvalidParameter.HealthCheckInterval	Specified parameter HealthCheckInterval is not valid.	Parameter HealthCheckInterval format is incorrect.
400	InvalidParameter.HealthCheckTimeout	Specified parameter HealthCheckTimeout is not valid.	Parameter HealthCheckTimeout format is incorrect.
400	InvalidParameter.HealthCheckSuccTimes	Specified parameter HealthCheckSuccTimes is not valid.	Parameter HealthCheckHost format is incorrect.
400	InvalidParameter.HealthCheckFailTimes	Specified parameter HealthCheckFailTimes is not valid.	Parameter HealthCheckFailTimes format is incorrect.
400	InvalidParameter.HealthCheckPort	Specified parameter HealthCheckPort is not valid.	Parameter HealthCheckPort format is incorrect.
400	InvalidParameter.PageNumber	Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.	Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.
400	InvalidParameter.appid	The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.	The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	NameAlreadyExists	The name already exists.	Name already exists.
400	ParamNameError	The Name parameter is invalid.	The Name parameter is illegal.
500	InternalError	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
404	InvalidApp.NotFound	The application does not exist. Check whether the application ID you specified is correct and try again.	The application does not exist. Check whether the application ID you specified is correct and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.