GetEdgeContainerApp - 获取边缘容器的应用信息

更新时间: 2024-12-26 17:14:14

获取边缘容器的应用信息,包括应用基础配置、健康检查等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
esa:GetEdgeContainerAppnone
*全部资源
*

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID,可使用 ListEdgeContainerApps 接口获取应用 ID。

app-88068867578379****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

156A6B-677B1A-4297B7-9187B7-2B44792
Appobject

应用基础信息

Statusstring

应用的状态信息,取值为:

  • creating:创建中
  • failed:创建失败
  • created:创建成功
created
GatewayTypestring

网关类型,可能值:

  • l7:七层网关
  • l4:四层网关
l7
CreateTimestring

创建时间。

2023-07-25T05:58:05Z
VersionCountinteger

应用版本数量。

1
DomainNamestring

当前应用绑定的域名,如果未绑定,则为空字符串。

www.1feel.cn
Remarksstring

应用的备注信息。

test app
ServicePortinteger

服务端端口号,范围 1~65535。

80
AppIdstring

应用 ID。

app-88068867578379****
TargetPortinteger

后端端口,也是应用的服务端口,范围 1~65535。

80
QuicCidstring

是否开启 QUIC 支持。

false
Namestring

应用名称

test-app1
UpdateTimestring

应用的上次修改时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-03-26T02:35:58Z
HealthCheckobject

表示健康检查信息的对象。

Timeoutinteger

应用健康检查超时时间,单位为秒。

60
Typestring

应用健康检查类型,取值:

  • l7
  • l4
l7
Hoststring

应用健康检查的域名。

test.com
Intervalinteger

应用健康检查的间隔时间,单位秒。

5
SuccTimesinteger

应用的健康检查连续成功次数。

3
Methodstring

应用的健康检查的方法。

HEAD
HttpCodestring

应用的健康检查成功的状态码范围。

http_2xx
FailTimesinteger

应用的健康检查连续失败次数。

5
Portinteger

应用的健康检查端口。

80
Uristring

应用的健康检查的路径。

/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错误码错误信息描述
400InvalidParameter.appidThe format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.传入的应用ID格式不正确,可使用ListEdgeContainerApps接口获取应用ID。
400InvalidParameterThe specified parameter is invalid.输入参数规范校验失败。
404InvalidApp.NotFoundThe application does not exist. Check whether the application ID you specified is correct and try again.您传入的应用ID对应的应用不存在,请检查后重试。
500InternalErrorFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。

访问错误中心查看更多错误码。

上一篇: GetEdgeContainerAppStatus - 获取边缘容器的应用状态信息 下一篇: DeleteEdgeContainerApp - 删除边缘容器应用