Use ListEdgeContainerApps to Query Edge Container Apps - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries all containerized applications in your Alibaba Cloud account.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Default value: 1. Valid values: 1 to 65535.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Valid values: 1 to 500.	20
OrderKey	string	No	The sorting field. Empty by default. Valid values: Name: the version name. CreateTime: the time when the version was created. UpdateTime: the time when the version was last modified.	CreateTime
OrderType	string	No	The sort order. Empty by default. Valid values: ASC: in ascending order. DESC: in descending order.	Asc
SearchType	string	No	The field used for fuzzy search. Valid values: Appid: the application ID. Name: the application name.	AppId
SearchKey	string	No	The search keyword.	ver-1005682639679266816

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2430E05E-1340-5773-B5E1-B743929F46F2
PageNumber	integer	The page number. Default value: 1. Valid values: 1 to 65535.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 500.	10
TotalCount	integer	The total number of entries.	10
Apps	array<object>	The queried applications.
	array<object>	The queried application.
Status	string	The status of the application. Valid values: creating: The application is being created. failed: The application failed to be created. created: The application is created.	created
GatewayType	string	The type of the gateway. Valid values: l7: Layer 7 gateway. l4: Layer 4 gateway.	l7
CreateTime	string	The time when the version was created.	2022-12-01T16:16:27.418298794+08:00
VersionCount	integer	The number of versions of the application.	10
DomainName	string	The domain name associated with the application.	test.com
Remarks	string	The remarks.	test app
ServicePort	integer	The server port. 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 is enabled.	false
Name	string	The application name.	app-test
UpdateTime	string	The time when the application was last modified, in UTC. Format: YYYY-MM-DDThh:mm:ss (ISO 8601).	2023-11-15T12:11:02Z
HealthCheck	object	The health check configuration.
Timeout	integer	The timeout period of health checks. Unit: seconds.	60
Type	string	The type of health checks. Valid values: l7 l4	l7
Host	string	The domain name 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 for an application to be considered healthy.	1
Method	string	The HTTP method used for health checks.	GET
HttpCode	string	The HTTP status codes that indicate a successful health check.	http_2XX
FailTimes	integer	The number of consecutive failed health checks for an application to be considered unhealthy.	5
Port	integer	The health check port.	8080
Uri	string	The health check URL.	/health_check
Percentage	integer	The creation progress of the application, in percentage.	100

Examples

Success response

JSON format

{
  "RequestId": "2430E05E-1340-5773-B5E1-B743929F46F2",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10,
  "Apps": [
    {
      "Status": "created",
      "GatewayType": "l7",
      "CreateTime": "2022-12-01T16:16:27.418298794+08:00",
      "VersionCount": 10,
      "DomainName": "test.com",
      "Remarks": "test app",
      "ServicePort": 80,
      "AppId": "app-88068867578379****",
      "TargetPort": 80,
      "QuicCid": "false",
      "Name": "app-test",
      "UpdateTime": "2023-11-15T12:11:02Z",
      "HealthCheck": {
        "Timeout": 60,
        "Type": "l7",
        "Host": "test.com",
        "Interval": 5,
        "SuccTimes": 1,
        "Method": "GET",
        "HttpCode": "http_2XX",
        "FailTimes": 5,
        "Port": 8080,
        "Uri": "/health_check"
      },
      "Percentage": 100
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.OrderType	The specified OrderType is invalid. Please check the OrderType parameter. You may not have set it to either Asc or Desc. Please make the necessary changes and call the interface again.	The OrderType parameter is invalid. Please check the OrderType parameter. You may not have set it to Asc or Desc. Please modify it and call the interface again.
400	InvalidParameter.OrderKey	The specified OrderKey is invalid. Please check the OrderKey parameter.	The OrderKey parameter is invalid. Please check the OrderKey parameter, as it cannot be assigned illegal characters such as @, #, % etc. Please make the necessary modifications and call the interface again.
400	InvalidParameter	Invalid parameter. Check the parameter configuration.	Invalid parameter. Check the parameter configuration.
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	InvalidPageSize.ValueNotSupported	The PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500.	The request PageSize value is invalid. The default value is 20 and the value range is 1-500.
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.