調用DescribeApplicationStatus API查詢應用狀態-Serverless 應用引擎-阿里雲 - Serverless App Engine

調用DescribeApplicationStatus介面擷取應用的狀態資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:DescribeApplicationStatus

get

*全部資源

*

無

請求文法

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

請求參數

名稱	類型	必填	描述	樣本值
AppId	string	是	目標應用 ID。	0099b7be-5f5b-4512-a7fc-56049ef1****

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
RequestId	string	請求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	附加資訊。取值說明如下：請求正常，返回 success。請求異常，返回具體異常錯誤碼。	success
TraceId	string	調用鏈 ID，用於精確查詢調用資訊。	0a98a02315955564772843261e****
Data	object	返回結果。
ArmsAdvancedEnabled	string	是否開通 ARMS 進階版。取值說明如下： true：開通 ARMS 進階版。 false：不開通 ARMS 進階版。	false
LastChangeOrderId	string	最近一次執行的發布單 ID，未執行過或發布單資訊到期則為空白。	1ccc2339-fc19-49aa-bda0-1e7b8497****
ArmsApmInfo	string	該應用在 ARMS 側中繼資料資訊。	{"appId":"0099b7be-5f5b-4512-a7fc-56049ef1**","licenseKey":"d5cgdt5pu0@7303f55292a**"}
CreateTime	string	應用建立時間。	1563373372746
CurrentStatus	string	應用目前狀態。取值說明如下： RUNNING：應用正在運行。 STOPPED：應用停止運行。 UNKNOWN：應用狀態未知。	RUNNING
AppId	string	當前應用 ID。	0099b7be-5f5b-4512-a7fc-56049ef1****
LastChangeOrderRunning	boolean	最近一次發布單是否處於執行中。取值說明如下： true：最近一次發布單處於執行中。 false：最近一次發布單不處於執行中。	false
RunningInstances	integer	當前應用運行中的執行個體數。	1
LastChangeOrderStatus	string	最近一次發布單狀態。取值說明如下： READY：最近一次發布單準備就緒。 RUNNING：最近一次發布單處於執行中。 SUCCESS：最近一次發布單發布成功。 FAIL：最近一次發布單發布失敗。 ABORT：最近一次發布單中止運行。 WAIT_BATCH_CONFIRM：最近一次發布單等待手工批量確認。 AUTO_BATCH_WAIT：最近一次發布單處於自動批量等待狀態。 SYSTEM_FAIL：系統故障。 WAIT_APPROVAL：最近一次發布單等待審批。 APPROVED：最近一次發布單處於審批通過的待執行狀態。	SUCCESS
SubStatus	string	發布單子狀態，用於判斷髮布單是否在發布過程中存在異常。取值說明如下： NORMAL：發布正常。 RUNNING_BUT_HAS_ERROR：發布異常。例如分批發布時出錯，需要您手動復原，此時發布單雖然出錯，但因不能完結而依然處於執行中。	NORMAL
EnableAgent	boolean	是否啟用 SAE Agent。 true：啟用。 false：不啟用。	false
FileSizeLimit	integer	檔案大小限制。取值範圍[0,10240]，單位為 KB。	10240
ErrorCode	string	錯誤碼。取值說明如下：請求成功：不返回 ErrorCode 欄位。請求失敗：返回 ErrorCode 欄位。具體資訊，請參見本文的錯誤碼列表。
Code	string	介面狀態或 POP 錯誤碼。取值說明如下： 2xx：成功。 3xx：重新導向。 4xx：請求錯誤。 5xx：伺服器錯誤。	200
Success	boolean	擷取應用狀態資訊是否成功。取值說明如下： true：擷取成功。 false：擷取失敗。	true

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidApplication.NotFound	The current application does not exist.	找不到當前應用。
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的參數：%s不可為空。
404	InvalidAppId.NotFound	The specified AppId does not exist.	指定的AppId不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。