DescribeApplicationStatus - Serverless App Engine - Alibaba Cloud Documentation Center

Queries the status of an 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
sae:DescribeApplicationStatus	get	All Resources ``	none	none

Request syntax

GET /pop/v1/sam/app/describeApplicationStatus HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application.	0099b7be-5f5b-4512-a7fc-56049ef1****

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. Valid values: success: If the call is successful, success is returned. An error code: If the call fails, an error code is returned.	success
TraceId	string	The trace ID that is used to query the details of the request.	0a98a02315955564772843261e****
Data	object	The returned result.
ArmsAdvancedEnabled	string	Indicates whether Application Real-Time Monitoring Service (ARMS) advanced monitoring is enabled. Valid values: true false	false
LastChangeOrderId	string	The ID of the latest change order that is executed. If no change orders are executed or if change orders expire, this parameter is left empty.	1ccc2339-fc19-49aa-bda0-1e7b8497****
ArmsApmInfo	string	The metadata of the application in ARMS.	{"appId":"0099b7be-5f5b-4512-a7fc-56049ef1**","licenseKey":"d5cgdt5pu0@7303f55292a**"}
CreateTime	string	The time when the application was created.	1563373372746
CurrentStatus	string	The current status of the application. Valid values: RUNNING STOPPED UNKNOWN	RUNNING
AppId	string	The ID of the application.	0099b7be-5f5b-4512-a7fc-56049ef1****
LastChangeOrderRunning	boolean	Indicates whether the latest change order is being executed. Valid values: true false	false
RunningInstances	integer	The number of running instances of the application.	1
LastChangeOrderStatus	string	The status of the latest change order. Valid values: READY: The change order is ready. RUNNING: The change order is being executed. SUCCESS: The change order was executed. FAIL: The change order failed to be executed. ABORT: The change order is stopped. WAIT_BATCH_CONFIRM: The change order is pending execution. You must manually confirm the release batch. AUTO_BATCH_WAIT: The change order is pending execution. SAE will automatically confirm the release batch. SYSTEM_FAIL: A system exception occurred. WAIT_APPROVAL: The change order is pending approval. APPROVED: The change order is approved and is pending execution.	SUCCESS
SubStatus	string	The substatus of the change order. This parameter indicates whether an exception occurred while the change order was being executed. Valid values: NORMAL RUNNING_BUT_HAS_ERROR: For example, if an error occurs during a phased release, you must manually roll back the application. In this case, the change order cannot be completed because the change order is still being executed.	NORMAL
EnableAgent	boolean	Indicates whether SAE agent is enabled. true false	false
FileSizeLimit	long	The file size limit. Unit: KB. Valid values: 0 to 10240.	10240
ErrorCode	string	The error code. Valid values: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the status of the application was queried. Valid values: true: The status was queried. false: The status failed to be queried.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ArmsAdvancedEnabled": false,
    "LastChangeOrderId": "1ccc2339-fc19-49aa-bda0-1e7b8497****",
    "ArmsApmInfo": {
      "appId": "0099b7be-5f5b-4512-a7fc-56049ef1****",
      "licenseKey": "d5cgdt5pu0@7303f55292a****"
    },
    "CreateTime": 1563373372746,
    "CurrentStatus": "RUNNING",
    "AppId": "0099b7be-5f5b-4512-a7fc-56049ef1****",
    "LastChangeOrderRunning": false,
    "RunningInstances": 1,
    "LastChangeOrderStatus": "SUCCESS",
    "SubStatus": "NORMAL",
    "EnableAgent": false,
    "FileSizeLimit": 10240
  },
  "ErrorCode": "",
  "Code": 200,
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidApplication.NotFound	The current application does not exist.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
404	InvalidAppId.NotFound	The specified AppId does not exist.

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

Change history

Change time	Summary of changes	Operation

No change history