GetEdgeContainerAppStatus - 获取边缘容器的应用状态信息

获取边缘容器的应用状态信息,包括应用的部署、发布、回滚等信息。

调试

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

授权信息

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

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

请求参数

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

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

app-88068867578379****
PublishEnvstring

发布环境,支持"prod","staging"两种发布环境。

staging

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

15C66C7B-671A-4297-9187-2C4477247B78
AppStatusobject

描述应用状态信息的对象。

PublishPercentageinteger

应用的发布比例。

50%
RollbackTimestring

最近一次回滚时间。

2024-07-25T05:58:05Z
PublishEnvstring

发布的环境,取值如下:

  • prod: 生产环境。
  • staging:预发环境。
prod
PublishingVersionstring

应用的发布版本。

ver-123123123123****
BaseLineVersionstring

应用的版本基线。

ver-123123123123****
PublishStatusstring

应用的发布状态。

  • publishing:发布中。
  • published:已发布。
  • rollbacking:回滚中。
  • rollbacked:回滚完成。
pubishing
DeployTimestring

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

2024-07-25T05:58:05Z
PublishTimestring

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

2024-07-25T05:58:05Z
DeployedVersionstring

应用的发布版本。

ver-123123123123****
ExpectPercentageinteger

应用的预期发布比例。

50%
DeployStatusstring

应用的部署状态。

  • undeploy:未部署。
  • deploying:部署中。
  • deployed:已部署。
  • undeploying:取消部署中。
undeploy
UnDeployTimestring

应用的取消部署时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2024-07-25T05:58:05Z
PublishTypestring

发布类型,支持如下两种:

  • percentage:按照百分比发布。

  • region:按照区域发布。

若不填写,默认使用百分比发布。

percentage
Regionsarray

发布区域列表。

Regionstring

区域名称。

jiangsu
FullReleaseboolean

是否全量发布。该字段仅当 PublishType 设置为 region 时生效。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247B78",
  "AppStatus": {
    "PublishPercentage": 0,
    "RollbackTime": "2024-07-25T05:58:05Z\n",
    "PublishEnv": "prod",
    "PublishingVersion": "ver-123123123123****\n",
    "BaseLineVersion": "ver-123123123123****\n",
    "PublishStatus": "pubishing",
    "DeployTime": "2024-07-25T05:58:05Z\n",
    "PublishTime": "2024-07-25T05:58:05Z\n",
    "DeployedVersion": "ver-123123123123****",
    "ExpectPercentage": 0,
    "DeployStatus": "undeploy",
    "UnDeployTime": "2024-07-25T05:58:05Z\n",
    "PublishType": "percentage",
    "Regions": {
      "Region": [
        "jiangsu"
      ]
    },
    "FullRelease": true
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.appidThe format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.传入的应用ID格式不正确,可使用ListEdgeContainerApps接口获取应用ID。
400InvalidParameterInvalid parameter. Check the parameter configuration.参数正确性校验失败,请检查的参数内容。
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.调用服务失败,请稍后重试或联系客服咨询详情。

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