Queries all containerized applications in your Alibaba Cloud account.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| esa:ListEdgeContainerApps | none | *All Resources * |
| 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. This parameter is left empty by default. Valid values:
| CreateTime |
| OrderType | string | No | The order in which you want to sort the query results. This parameter is left empty by default. Valid values:
| Asc |
| SearchType | string | No | The search criterion based on which you want to perform fuzzy search. Valid values:
| Appid |
| SearchKey | string | No | The search keyword. | ver-1005682639679266816 |
Response parameters
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 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. |
| 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. |
| 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-15 | The Error code has changed | View Change Details |
