Retrieves a list of edge container applications, including all edge applications created under the current account.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
esa:ListEdgeContainerApps |
none |
*All Resource
|
None | 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 field used for sorting. If this parameter is not specified, no sorting is applied. Valid values:
|
CreateTime |
| OrderType |
string |
No |
The sort order. If this parameter is not specified, no sorting is applied. Valid values:
|
Asc |
| SearchType |
string |
No |
The type of fuzzy match. Valid values:
|
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 list of applications. |
|
|
array<object> |
The application object. |
||
| Status |
string |
The status of the application. Valid values:
|
created |
| GatewayType |
string |
The gateway type. Valid values:
|
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. |
2022-12-01T16:16:27.418298794+08:00 |
| VersionCount |
integer |
The number of application versions. |
10 |
| DomainName |
string |
The domain name bound to the application. |
test.com |
| Remarks |
string |
The remarks. |
test app |
| ServicePort |
integer |
The server 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 is enabled. |
false |
| Name |
string |
The application name. |
app-test |
| 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-11-15T12:11:02Z |
| HealthCheck |
object |
The health check information. |
|
| Timeout |
integer |
The timeout period of health checks. Unit: seconds. |
60 |
| Type |
string |
The type of health checks. Valid values:
|
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 for an application to be considered healthy. |
1 |
| Method |
string |
The HTTP method used for health checks. |
GET |
| 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 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 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.