GetEdgeContainerApp API Overview & Container App Details - ESA - Alibaba Cloud - Edge Security Acceleration

Retrieves application information for an edge container, including basic application configurations and health check settings.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID. You can obtain the application ID by calling the ListEdgeContainerApps operation.	app-88068867578379****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	156A6B-677B1A-4297B7-9187B7-2B44792
App	object	The basic application information.
Status	string	The status of the application. Valid values: creating: Being created. failed: Creation failed. created: Created.	created
GatewayType	string	The gateway type. Valid values: l7: Layer 7 gateway. l4: Layer 4 gateway.	l7
CreateTime	string	The creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-07-25T05:58:05Z
VersionCount	integer	The number of application versions.	1
DomainName	string	The domain name bound to the application. If no domain name is bound, an empty string is returned.	www.1feel.cn
Remarks	string	The remarks of the application.	test app
ServicePort	integer	The service port number. Valid values: 1 to 65535.	80
AppId	string	The application ID.	app-88068867578379****
TargetPort	integer	The backend port, which is also the service port of the application. Valid values: 1 to 65535.	80
QuicCid	string	Indicates whether QUIC support is enabled.	false
Name	string	The application name.	test-app1
UpdateTime	string	The last modification time of the application. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-03-26T02:35:58Z
HealthCheck	object	The health check information.
Timeout	integer	The timeout period of the health check. Unit: seconds.	60
Type	string	The health check type. Valid values: l7 l4	l7
Host	string	The domain name that is used for health checks.	test.com
Interval	integer	The interval between health checks. Unit: seconds.	5
SuccTimes	integer	The number of consecutive successful health checks required for an application to be considered as healthy.	3
Method	string	The HTTP method that the health check request uses.	HEAD
HttpCode	string	The range of health check status codes that indicate successful health checks.	http_2xx
FailTimes	integer	The number of consecutive failed health checks required for an application to be considered as unhealthy.	5
Port	integer	The health check port.	80
Uri	string	The health check URL.	/health_check

Examples

Success response

JSON format

{
  "RequestId": "156A6B-677B1A-4297B7-9187B7-2B44792",
  "App": {
    "Status": "created",
    "GatewayType": "l7",
    "CreateTime": "2023-07-25T05:58:05Z",
    "VersionCount": 1,
    "DomainName": "www.1feel.cn",
    "Remarks": "test app",
    "ServicePort": 80,
    "AppId": "app-88068867578379****",
    "TargetPort": 80,
    "QuicCid": "false",
    "Name": "test-app1",
    "UpdateTime": "2023-03-26T02:35:58Z",
    "HealthCheck": {
      "Timeout": 60,
      "Type": "l7",
      "Host": "test.com",
      "Interval": 5,
      "SuccTimes": 3,
      "Method": "HEAD",
      "HttpCode": "http_2xx",
      "FailTimes": 5,
      "Port": 80,
      "Uri": "/health_check"
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.
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.