获取边缘容器的应用信息,包括应用基础配置、健康检查等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
esa:GetEdgeContainerApp |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppId |
string |
是 |
应用 ID,可使用 ListEdgeContainerApps 接口获取应用 ID。 |
app-88068867578379**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
156A6B-677B1A-4297B7-9187B7-2B44792 |
| App |
object |
应用基础信息 |
|
| Status |
string |
应用的状态信息,取值为:
|
created |
| GatewayType |
string |
网关类型,可能值:
|
l7 |
| CreateTime |
string |
创建时间。 |
2023-07-25T05:58:05Z |
| VersionCount |
integer |
应用版本数量。 |
1 |
| DomainName |
string |
当前应用绑定的域名,如果未绑定,则为空字符串。 |
www.1feel.cn |
| 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 |
应用名称 |
test-app1 |
| UpdateTime |
string |
应用的上次修改时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2023-03-26T02:35:58Z |
| HealthCheck |
object |
表示健康检查信息的对象。 |
|
| Timeout |
integer |
应用健康检查超时时间,单位为秒。 |
60 |
| Type |
string |
应用健康检查类型,取值:
|
l7 |
| Host |
string |
应用健康检查的域名。 |
test.com |
| Interval |
integer |
应用健康检查的间隔时间,单位秒。 |
5 |
| SuccTimes |
integer |
应用的健康检查连续成功次数。 |
3 |
| Method |
string |
应用的健康检查的方法。 |
HEAD |
| HttpCode |
string |
应用的健康检查成功的状态码范围。 |
http_2xx |
| FailTimes |
integer |
应用的健康检查连续失败次数。 |
5 |
| Port |
integer |
应用的健康检查端口。 |
80 |
| Uri |
string |
应用的健康检查的路径。 |
/health_check |
示例
正常返回示例
JSON格式
{
"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"
}
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.appid | The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID. | 传入的应用ID格式不正确,可使用ListEdgeContainerApps接口获取应用ID。 |
| 400 | InvalidParameter | The specified parameter is invalid. | 输入参数规范校验失败。 |
| 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对应的应用不存在,请检查后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。