获取边缘容器应用列表，包括用户该账号下创建的所有边缘应用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
esa:ListEdgeContainerApps |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageNumber |
integer |
否 |
当前页码。默认值：1，取值范围：1~65535。 |
1 |
| PageSize |
integer |
否 |
每页大小。默认为：20，取值范围：1~500。 |
20 |
| OrderKey |
string |
否 |
排序字段，不传则默认为空。取值：
|
CreateTime |
| OrderType |
string |
否 |
排序方向，不传则默认为空。取值：
|
Asc |
| SearchType |
string |
否 |
模糊查找的类型，取值：
|
AppId |
| SearchKey |
string |
否 |
搜索关键词。 |
ver-1005682639679266816 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
2430E05E-1340-5773-B5E1-B743929F46F2 |
| PageNumber |
integer |
当前页码。默认值;1，取值范围：1~65535。 |
1 |
| PageSize |
integer |
整页大小。取值范围：1~500。 |
10 |
| TotalCount |
integer |
总条数。 |
10 |
| Apps |
array<object> |
应用数组 |
|
|
array<object> |
描述应用的对象。 |
||
| Status |
string |
应用的状态信息，取值：
|
created |
| GatewayType |
string |
网关类型， 可能值：
|
l7 |
| CreateTime |
string |
创建时间。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2022-12-01T16:16:27.418298794+08:00 |
| VersionCount |
integer |
应用版本数量。 |
10 |
| DomainName |
string |
App 所绑定的域名。 |
test.com |
| Remarks |
string |
备注信息。 |
test app |
| ServicePort |
integer |
服务端端口号。范围：1~65535。 |
80 |
| AppId |
string |
应用 ID。 |
app-88068867578379**** |
| TargetPort |
integer |
后端端口，也是应用的服务端口。范围：1~65535。 |
80 |
| QuicCid |
string |
是否开启 quic 支持。 |
false |
| Name |
string |
应用名。 |
app-test |
| UpdateTime |
string |
应用的上次修改时间。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2023-11-15T12:11:02Z |
| HealthCheck |
object |
表示健康检查信息的对象。 |
|
| Timeout |
integer |
应用健康检查超时时间，单位为秒。 |
60 |
| Type |
string |
健康检查类型，取值：
|
l7 |
| Host |
string |
健康检查的域名。 |
test.com |
| Interval |
integer |
应用健康检查的间隔时间，单位秒。 |
5 |
| SuccTimes |
integer |
应用的健康检查连续成功次数。 |
1 |
| Method |
string |
应用的健康检查的方法。 |
GET |
| HttpCode |
string |
应用的健康检查成功的状态码范围。 |
http_2XX |
| FailTimes |
integer |
应用的健康检查连续失败次数。 |
5 |
| Port |
integer |
应用的健康检查端口。 |
8080 |
| Uri |
string |
应用的健康检查的路径。 |
/health_check |
| Percentage |
integer |
创建进度百分比。 |
100 |
示例
正常返回示例
JSON格式
{
"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
}
]
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | OrderType参数无效。请检查OrderType参数，你有可能未设置为 Asc、Desc其中一种，请进行修改后，重新调用接口。 |
| 400 | InvalidParameter.OrderKey | The specified OrderKey is invalid. Please check the OrderKey parameter. | OrderKey参数无效。请检查OrderKey参数，该参数不能赋值为非法字符如 @、#、% 等，请进行修改后，重新调用接口。 |
| 400 | InvalidParameter | 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. | 参数 PageNumber 校验不通过。请仔细检查请求参数是否存在且为正整数。 |
| 400 | InvalidParameter.appid | The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID. | 传入的应用ID格式不正确，可使用ListEdgeContainerApps接口获取应用ID。 |
| 400 | InvalidPageSize.ValueNotSupported | The PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500. | 请求PageSize值非法，默认取值为20，取值区间为1-500。 |
| 500 | InternalError | 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. | 您传入的应用ID对应的应用不存在，请检查后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。