调用DescribeApplicationStatus接口获取应用状态-Serverless应用引擎-阿里云-Serverless 应用引擎(SAE)-阿里云帮助中心

调用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不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。