获取边缘容器的应用状态信息,包括应用的部署、发布、回滚等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
esa:GetEdgeContainerAppStatus |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppId |
string |
是 |
应用 ID,可使用 ListEdgeContainerApps 接口获取应用 ID。 |
app-88068867578379**** |
| PublishEnv |
string |
否 |
发布环境,支持"prod","staging"两种发布环境。 |
staging |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
15C66C7B-671A-4297-9187-2C4477247B78 |
| AppStatus |
object |
描述应用状态信息的对象。 |
|
| PublishPercentage |
integer |
应用的发布比例。 |
50% |
| RollbackTime |
string |
最近一次回滚时间。 |
2024-07-25T05:58:05Z |
| PublishEnv |
string |
发布的环境,取值如下:
|
prod |
| PublishingVersion |
string |
应用的发布版本。 |
ver-123123123123**** |
| BaseLineVersion |
string |
应用的版本基线。 |
ver-123123123123**** |
| PublishStatus |
string |
应用的发布状态。
|
pubishing |
| DeployTime |
string |
应用的部署时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2024-07-25T05:58:05Z |
| PublishTime |
string |
应用的发布时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2024-07-25T05:58:05Z |
| DeployedVersion |
string |
应用的部署版本。 |
ver-123123123123**** |
| ExpectPercentage |
integer |
应用的预期发布比例。 |
50% |
| DeployStatus |
string |
应用的部署状态。
|
undeploy |
| UnDeployTime |
string |
应用的取消部署时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2024-07-25T05:58:05Z |
| PublishType |
string |
发布类型,支持如下两种:
若不填写,默认使用百分比发布。 |
percentage |
| Regions |
object |
||
| Region |
array |
发布区域列表。 |
|
|
string |
区域名称。 |
jiangsu |
|
| FullRelease |
boolean |
是否全量发布。该字段仅当 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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | 参数正确性校验失败,请检查的参数内容。 |
| 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对应的应用不存在,请检查后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。