DescribeApplicationStatus-阿里云帮助中心

Call the DescribeApplicationStatus API to get an application's status.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:DescribeApplicationStatus

get

*All Resource

*

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 elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The response message. If the call is successful, success is returned. If the call fails, an error message is returned.	success
TraceId	string	The trace ID that is used to query the details of a request.	0a98a02315955564772843261e****
Data	object	The response data.
ArmsAdvancedEnabled	string	Indicates whether ARMS Advanced Edition is enabled. Valid values: true: enabled. false: disabled.	false
LastChangeOrderId	string	The ID of the most recently executed change order. This parameter is empty if no change order was executed or if the information about the change order has expired.	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. This value is a UNIX timestamp.	1563373372746
CurrentStatus	string	The current status of the application. Valid values: RUNNING: The application is running. STOPPED: The application is stopped. UNKNOWN: The application status is unknown.	RUNNING
AppId	string	The application ID.	0099b7be-5f5b-4512-a7fc-56049ef1****
LastChangeOrderRunning	boolean	Indicates whether the most recent 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 most recent change order. Valid values: READY: The change order is ready. RUNNING: The change order is being executed. SUCCESS: The change order was successful. FAIL: The change order failed. ABORT: The change order was aborted. WAIT_BATCH_CONFIRM: The change order is waiting for manual confirmation for the next batch. AUTO_BATCH_WAIT: The change order is in a waiting state for an automatic batch. SYSTEM_FAIL: A system error 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 is used to determine whether an exception occurs during the release process. Valid values: NORMAL: The release is normal. RUNNING_BUT_HAS_ERROR: The release is abnormal. For example, if an error occurs during a phased release, you must manually roll back the release. In this case, the change order cannot be completed and the status of the change order remains RUNNING.	NORMAL
EnableAgent	boolean	Indicates whether the SAE agent is enabled. Valid values: true false	false
FileSizeLimit	integer	The file size limit. Unit: KB. Valid values: 0 to 10240.	10240
ErrorCode	string	The error code. If the request is successful, this parameter is not returned. If the request fails, this parameter is returned. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request was invalid. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the application status was obtained. Valid values: true false	true

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.