GetEdgeContainerAppStatus - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the status information about a containerized application, including the deployment, release, and rollback of the application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:GetEdgeContainerAppStatus	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID, which can be obtained by calling the ListEdgeContainerApps operation.	app-88068867578379****
PublishEnv	string	No	The release environment. Valid values: prod and staging.	staging

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247B78
AppStatus	object	The status of the application.
PublishPercentage	integer	The release percentage of the application.	50%
RollbackTime	string	The time when the last rollback was performed.	2024-07-25T05:58:05Z
PublishEnv	string	The environment to which the application was released. Valid values: prod: the production environment. staging: the staging environment.	prod
PublishingVersion	string	The release version of the application.	ver-123123123123****
BaseLineVersion	string	The base version of the application.	ver-123123123123****
PublishStatus	string	The release status of the application. Valid values: publishing published rollbacking rollbacked	pubishing
DeployTime	string	The time when the application was deployed. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2024-07-25T05:58:05Z
PublishTime	string	The time when the application was released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2024-07-25T05:58:05Z
DeployedVersion	string	The release version of the application.	ver-123123123123****
ExpectPercentage	integer	The expected release percentage of the application.	50%
DeployStatus	string	The deployment status of the application. undeploy: The application is not deployed. deploying: The application is being deployed. deployed: The application is deployed. undeploying: The deployment is being canceled.	undeploy
UnDeployTime	string	The time when the application deployment was canceled. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2024-07-25T05:58:05Z
PublishType	string	Specifies how the version is released. Valid values: percentage: releases the version by percentage. region: releases the version by region. If you do not specify this parameter, the version is released by percentage by default.	percentage
Regions	array	The regions to which the version is released.
Region	string	The region name.	jiangsu
FullRelease	boolean	Specifies whether to fully release the version. This parameter takes effect only when PublishType is set to region.	true

Examples

Sample success responses

JSONformat

{
  "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
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.appid	The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.	The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.
400	InvalidParameter	Invalid parameter. Check the parameter configuration.	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.	The application does not exist. Check whether the application ID you specified is correct and try again.
500	InternalError	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

For a list of error codes, visit the Service error codes.