All Products
Search
Document Center

Edge Security Acceleration:GetEdgeContainerApp

Last Updated:Nov 07, 2025

Queries the information about a containerized application, including basic application configurations and health check configurations.

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:GetEdgeContainerAppnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The application ID, which can be obtained by calling the ListEdgeContainerApps operation.

app-88068867578379****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

156A6B-677B1A-4297B7-9187B7-2B44792
Appobject

The basic information about the 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 application was created.

2023-07-25T05:58:05Z
VersionCountinteger

The number of versions of the application.

1
DomainNamestring

The domain name that is associated with the application. If no domain name is associated with the application, the value is an empty string.

www.1feel.cn
Remarksstring

The remarks about the application.

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.

test-app1
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-03-26T02:35:58Z
HealthCheckobject

The information about health checks.

Timeoutinteger

The timeout period of the health check. Unit: seconds.

60
Typestring

The health check type. 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 required for an application to be considered as healthy.

3
Methodstring

The HTTP method that the health check request uses.

HEAD
HttpCodestring

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

http_2xx
FailTimesinteger

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

5
Portinteger

The health check port.

80
Uristring

The health check URL.

/health_check

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
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.
400InvalidParameterThe specified parameter is invalid.The specified parameter is invalid.
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.