Queries information of an application.
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request and response headers.
Syntax
GET /pop/v1/sam/app/describeApplicationStatus HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
AppId | String | Query | Yes | 0099b7be-5f5b-4512-a7fc-56049ef1**** | The ID of the application. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 91F93257-7A4A-4BD3-9A7E-2F6EAE6D**** | The ID of the request. |
Message | String | success | The returned message. Valid values:
|
TraceId | String | 0a98a02315955564772843261e**** | The ID of the trace. It is used to query the details of a request. |
Data | Object | The returned data. |
|
ArmsAdvancedEnabled | String | false | Indicates whether Application Real-Time Monitoring Service (ARMS) advanced monitoring is enabled. Valid values:
|
LastChangeOrderId | String | 1ccc2339-fc19-49aa-bda0-1e7b8497**** | The ID of the latest change order that is executed. If no change orders have been executed or if change orders have expired, an empty parameter is returned. |
ArmsApmInfo | String | {"appId":"0099b7be-5f5b-4512-a7fc-56049ef1****","licenseKey":"d5cgdt5pu0@7303f55292a****"} | The metadata of the application in ARMS. |
CreateTime | String | 1563373372746 | The time when the application was created. |
CurrentStatus | String | RUNNING | The current state of the application. Valid values:
|
AppId | String | 0099b7be-5f5b-4512-a7fc-56049ef1**** | The ID of the application. |
LastChangeOrderRunning | Boolean | false | Indicates whether the latest change order is being executed. Valid values:
|
RunningInstances | Integer | 1 | The number of running instances of the application. |
LastChangeOrderStatus | String | SUCCESS | The state of the latest change order. Valid values:
|
SubStatus | String | NORMAL | Indicates whether an error occurred while the change order was being executed. Valid values:
|
EnableAgent | Boolean | false | Indicates whether SAE agent is enabled.
|
FileSizeLimit | Long | 10240 | The file size limit. Unit: KB. Valid values: 0 to 10240. |
ErrorCode | String | The error code.
|
|
Code | String | 200 | The HTTP status code. Valid values:
|
Success | Boolean | true | Indicates whether information of the application is successfully obtained. Valid values:
|
Examples
Sample requests
GET /pop/v1/sam/app/describeApplicationStatus?AppId=0099b7be-5f5b-4512-a7fc-56049ef1**** HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeApplicationStatusResponse>
<RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
<Message>success</Message>
<TraceId>0a98a02315955564772843261e****</TraceId>
<Data>
<ArmsAdvancedEnabled>false</ArmsAdvancedEnabled>
<LastChangeOrderId>1ccc2339-fc19-49aa-bda0-1e7b8497****</LastChangeOrderId>
<ArmsApmInfo>{"appId":"0099b7be-5f5b-4512-a7fc-56049ef1****","licenseKey":"d5cgdt5pu0@7303f55292a****"}</ArmsApmInfo>
<CreateTime>1563373372746</CreateTime>
<CurrentStatus>RUNNING</CurrentStatus>
<AppId>0099b7be-5f5b-4512-a7fc-56049ef1****</AppId>
<LastChangeOrderRunning>false</LastChangeOrderRunning>
<RunningInstances>1</RunningInstances>
<LastChangeOrderStatus>SUCCESS</LastChangeOrderStatus>
<SubStatus>NORMAL</SubStatus>
<EnableAgent>false</EnableAgent>
<FileSizeLimit>10240</FileSizeLimit>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeApplicationStatusResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/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
},
"Code" : "200",
"Success" : true
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidApplication.NotFound | The current application does not exist. | The error message returned because the specified application was not found. |
400 | InvalidParameter.NotEmpty | You must specify the parameter %s. | The error message returned because the value of the %s parameter is invalid. This parameter cannot be left empty. |
404 | InvalidAppId.NotFound | The specified AppId does not exist. | The error message returned because the specified application ID does not exist. |
For a list of error codes, visit the API Error Center.