获取边缘容器应用列表，包括用户该账号下创建的所有边缘应用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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 |
返回参数
示例
正常返回示例
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。 |
| 404 | InvalidApp.NotFound | The application does not exist. Check whether the application ID you specified is correct and try again. | 您传入的应用ID对应的应用不存在，请检查后重试。 |
| 500 | InternalError | Failed to call the service. Try again later or contact technical support. | 调用服务失败，请稍后重试或联系客服咨询详情。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-15 | OpenAPI 错误码发生变更 | 查看变更详情 |