All Products
Search
Document Center

Edge Security Acceleration:ListEdgeContainerApps

Last Updated:Nov 07, 2025

Queries all containerized applications in your Alibaba Cloud account.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
esa:ListEdgeContainerAppsnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number. Default value: 1. Valid values: 1 to 65535.

1
PageSizeintegerNo

The number of entries per page. Default value: 20. Valid values: 1 to 500.

20
OrderKeystringNo

The sorting field. This parameter is left 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
OrderTypestringNo

The order in which you want to sort the query results. This parameter is left empty by default. Valid values:

  • ASC: in ascending order.
  • DESC: in descending order.
Asc
SearchTypestringNo

The search criterion based on which you want to perform fuzzy search. Valid values:

  • Appid: the application ID.
  • Name: the application name.
Appid
SearchKeystringNo

The search keyword.

ver-1005682639679266816

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

2430E05E-1340-5773-B5E1-B743929F46F2
PageNumberinteger

The page number. Default value: 1. Valid values: 1 to 65535.

1
PageSizeinteger

The number of entries per page. Valid values: 1 to 500.

10
TotalCountinteger

The total number of entries.

10
Appsarray<object>

The queried applications.

Appobject

The queried application.

Statusstring

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
GatewayTypestring

The type of the gateway. Valid values:

  • l7: Layer 7 gateway.
  • l4: Layer 4 gateway.
l7
CreateTimestring

The time when the version was created.

2022-12-01T16:16:27.418298794+08:00
VersionCountinteger

The number of versions of the application.

10
DomainNamestring

The domain name associated with the application.

test.com
Remarksstring

The remarks.

test app
ServicePortinteger

The server port. Valid values: 1 to 65535.

80
AppIdstring

The application ID.

app-88068867578379****
TargetPortinteger

The backend port, which is also the service port of the application. Valid values: 1 to 65535.

80
QuicCidstring

Indicates whether QUIC is enabled.

false
Namestring

The application name.

app-test
UpdateTimestring

The time when the application was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2023-11-15T12:11:02Z
HealthCheckobject

The information about health checks.

Timeoutinteger

The timeout period of health checks. Unit: seconds.

60
Typestring

The type of health checks. Valid values:

  • l7
  • l4
l7
Hoststring

The domain name that is used for health checks.

test.com
Intervalinteger

The interval between health checks. Unit: seconds.

5
SuccTimesinteger

The number of consecutive successful health checks for an application to be considered healthy.

1
Methodstring

The HTTP method used for health checks.

GET
HttpCodestring

The range of health check status codes that indicate successful health checks.

http_2XX
FailTimesinteger

The number of consecutive failed health checks for an application to be considered unhealthy.

5
Portinteger

The health check port.

8080
Uristring

The health check URL.

/health_check
Percentageinteger

The progress of the application creation task in percentage.

100

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameter.OrderTypeThe 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.
400InvalidParameter.OrderKeyThe 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.
400InvalidParameterInvalid parameter. Check the parameter configuration.Invalid parameter. Check the parameter configuration.
400InvalidParameter.PageNumberFailed 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.
400InvalidParameter.appidThe 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.
400InvalidPageSize.ValueNotSupportedThe 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.
404InvalidApp.NotFoundThe 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.
500InternalErrorFailed 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.

Change history

Change timeSummary of changesOperation
2024-10-15The Error code has changedView Change Details