调用DescribeApplicationStatus接口获取应用的状态信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
AppId String Query 0099b7be-5f5b-4512-a7fc-56049ef1****

目标应用ID。

返回数据

名称 类型 示例值 描述
Code String 200

接口状态或POP错误码。取值说明如下:

  • 2XX:成功。
  • 3XX:重定向。
  • 4XX:请求错误。
  • 5XX:服务器错误。
Data Struct

返回结果。

AppId String 0099b7be-5f5b-4512-a7fc-56049ef1****

当前应用ID。

ArmsAdvancedEnabled String false

是否开通ARMS高级版。取值说明如下:

  • true:表示开通ARMS高级版。
  • false:表示不开通ARMS高级版。
ArmsApmInfo String {"appId":"0099b7be-5f5b-4512-a7fc-56049ef1****","licenseKey":"d5cgdt5pu0@7303f55292a****"}

该应用在ARMS侧元数据信息。

CreateTime String 1563373372746

应用创建时间。

CurrentStatus String RUNNING

应用当前状态。

LastChangeOrderId String 1ccc2339-fc19-49aa-bda0-1e7b8497****

上一次执行的发布单ID,未执行过或发布单信息过期则为空。

LastChangeOrderRunning Boolean false

上一次发布单是否处于执行中。取值说明如下:

  • true:表示上一次发布单处于执行中。
  • false:表示上一次发布单不处于执行中。
LastChangeOrderStatus String SUCCESS

上一次发布单状态。

RunningInstances Integer 1

当前应用运行中的实例数。

ErrorCode String success

错误码。

Message String success

附加信息。

RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

请求ID。

Success Boolean true

获取应用状态信息是否成功。取值说明如下:

  • true:表示获取成功。
  • false:表示获取失败。
TraceId String 0a98a02315955564772843261e****

调用链ID。

示例

请求示例

GET /pop/v1/sam/app/describeApplicationStatus?RegionId=cn-beijing&AppId=0099b7be-5f5b-4512-a7fc-56049ef1****

正常返回示例

XML格式

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

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidApplication.NotFound The current application does not exist. 找不到当前应用。
400 InvalidParameter.NotEmpty You must specify the parameter %s. 不合法的参数:%s不能为空。

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