获取边缘容器的应用状态信息,包括应用的部署、发布、回滚等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
esa:GetEdgeContainerAppStatus | none |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 应用 ID,可使用 ListEdgeContainerApps 接口获取应用 ID。 | app-88068867578379**** |
PublishEnv | string | 否 | 发布环境,支持"prod","staging"两种发布环境。 | staging |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 | Invalid parameter. Check the parameter configuration. | 参数正确性校验失败,请检查的参数内容。 |
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. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
访问错误中心查看更多错误码。