You can call this operation to query the information of an application.
Debugging
Request headers
This operation only uses common request headers. For more information, see the Common request parameters topic.
Request syntax
GET /pop/v5/app/app_status HTTPS|HTTP
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
AppId | String | Yes | 3616cdca-4f92-441************** |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | Integer | 200 |
The returned code. |
Message | String | success |
The returned message. |
RequestId | String | D16979DC-4D42-******** | |
AppInfo | Struct |
The information about the application that was queried. |
|
EcuList | Array |
The returned information about the Elastic Compute Unit (ECU) where the application is deployed. |
|
EcuId | String | 07bd417a-b863-477d-****-************ |
The ID of the ECU. To query the ECU ID, you can run dmidecode on the ECS instance corresponding to the ECU. |
Online | Boolean | true |
Indicates whether the ECU is available. |
DockerEnv | Boolean | false |
Indicates whether Docker is installed on the ECS instance corresponding to the ECU. |
CreateTime | Long | 1573626207270 |
The time when the ECU was created. |
UpdateTime | Long | 1573635952012 |
The time when the ECU was updated. |
IpAddr | String | 172.16.*. ** |
The intranet IP address allocated to the ECU. |
HeartbeatTime | Long | 1573635952012 |
The heartbeat time of the ECU. |
UserId | String | edas_com***_****@******-*****. *** |
The ID of the user associated with the ECU. |
GroupId | String | 8123db90-880f-486f-****-************ |
The ID of the instance group corresponding to the ECU. |
Name | String | EDAS-scaled-cluster:default cluster |
The name of the ECU. |
ZoneId | String | cn-shen****-* |
The ID of the zone where the ECU is located. |
RegionId | String | cn-shen****-* |
The ID of the region where the ECU is located. |
InstanceId | String | i-wz9fp1ljg*********** |
The ID of the ECS instance corresponding to the ECU. |
VpcId | String | vpc-wz9b246zg************ |
The ID of the virtual private cloud (VPC) where the ECU is located. |
RegionId | String | cn-shen****-* |
The ID of the region where the ECU is located. |
AvailableCpu | Integer | 0 |
The number of available CPUs in the ECU. |
AvailableMem | Integer | 0 |
The amount of available memory in the ECU. Unit: MB |
EccList | Array |
The returned information about the Elastic Compute Container (ECC) corresponding to the ECU where the application is deployed. |
|
EccId | String | 0cf49a6c-95a8-4aa8-****-************ |
The ID of the ECC returned. |
EcuId | String | 07bd417a-b863-477d-****-************ |
The ID of the ECU corresponding to the ECC returned. |
AppId | String | 3616cdca-4f92-4413-****-************ |
The ID of the application that was queried. |
AppState | Integer | 7 |
The state of the application instance. The values are used in change processes. Valid values: AGENT_OFF(0), STOPPED(1), RUNNING_BUT_URL_FAILED(3), and RUNNING(7) |
TaskState | Integer | 3 |
The state of the most recent task in the application instance. Valid values: UNKNOWN(0), PROCESSING(1), SUCCESS(2), and FAILED(3) |
CreateTime | Long | 1573626226691 |
The time when the ECC was created. |
UpdateTime | Long | 1573635952012 |
The time when the ECC was updated. |
Ip | String | 172.16.*. *** |
The intranet IP address allocated to the ECU. |
VpcId | String | vpc-wz9b246zg************ |
The ID of the VPC where the ECS instance corresponding to the ECU is located. |
GroupId | String | 8123db90-880f-486f-****-************ |
The ID of the instance group to which the ECS instance corresponding to the ECC belongs. |
ContainerStatus | String | "" |
The status of the container where the application is running. |
GroupList | Array |
The returned information about the instance group where the application is deployed. |
|
GroupId | String | 8123db90-880f-486f-****-************ |
The ID of the instance group returned. |
GroupName | String | _DEFAULT_GROUP |
The name of the instance group returned. |
AppId | String | 3616cdca-4f92-4413-****-************ |
The ID of the application that was queried. |
PackageVersionId | String | 441beb18-da42-44dc-****-************ |
The package version ID of the application deployed to the instance group returned. |
AppVersionId | String | changeorder_a**_*******_** |
The ID of the deployment record for the instance group returned. This parameter has been obsoleted. |
GroupType | Integer | 0 |
The type of the instance group returned. Valid values: 0: Default group. 1: user-created group. 2: phased release group. |
ClusterId | String | 0d247b93-8d62-4e34-****-************ |
The ID of the cluster where the group of ECS instances are located. |
CreateTime | Long | 1573626155185 |
The time when the returned instance group was created. |
UpdateTime | Long | 1573627441388 |
The time when the returned instance group was updated. |
DeployRecordList | Array |
The information about the deployment record of the application that was queried. |
|
DeployRecordId | String | bbc6c0d5-d792-4907-****-************ |
The ID of the deployment record for the application that was queried. |
EccId | String | 0cf49a6c-95a8-4aa8-****-************ |
The ID of the ECC corresponding to the ECU where the application is deployed. |
EcuId | String | 07bd417a-b863-477d-****-************ |
The ID of the ECU where the application is deployed. |
PackageVersionId | String | 441beb18-da42-44dc-****-************ |
The package version ID of the application deployed to the instance group. |
PackageMd5 | String | d0db5bcb442e492104d0f00e10a03dd9 |
The value of the MD5 message-digest algorithm used in the deployment package of the application. |
CreateTime | Long | 1573626226691 |
The time when the deployment record of the application was created. |
Application | Struct |
The basic information of the application that was queried. |
|
ApplicationId | String | 3616cdca-4f92-4413-****-************ |
The ID of the application that was queried. |
BuildPackageId | Integer | 0 |
The version of the container where the application is running. |
ClusterId | String | 0d247b93-8d62-4e34-****-************ |
The ID of the cluster where the application is deployed. |
Cpu | Integer | 0 |
The number of CPUs used by the application that was queried. |
CreateTime | Long | 1573626207270 |
The time when the application was created. |
Dockerize | Boolean | false |
Indicates whether the application is a Docker application. |
String | 1234567@qq.com |
The email address of the user who created the application. |
|
HealthCheckUrl | String | "" |
The health check URL for the application that was queried. |
InstanceCount | Integer | 1 |
The total number of application instances for the application that was queried. |
LaunchTime | Long | 0 |
The time when the application was launched. |
Memory | Integer | 0 |
The amount of memory occupied by the application. Unit: MB |
Name | String | EDAS-scaled-cluster:default cluster |
The name of the application that was queried. |
Owner | String | edas_com***_****@******-*****. *** |
The ID of the user who created the application that was queried. |
Phone | String | 18866669999 |
The phone number of the user who created the application. |
Port | Integer | 8080 |
The number of the port occupied by the application. |
RegionId | String | cn-shenzhen:xuanye |
The ID of the region where the application is located. |
RunningInstanceCount | Integer | 1 |
The number of running application instances for the application that was queried. |
UserId | String | edas_com***_****@******-*****. *** |
The primary account of the user who created the application. |
Examples
Sample requests
GET /pop/v5/app/app_status HTTP/1.1
Common request headers
{
"AppId": ""
}
Sample success responses
JSON
format
{
"Message": "success",
"AppInfo": {
"EcuList": {
"Ecu": [
{
"AvailableMem": 0,
"AvailableCpu": 0,
"InstanceId": "i-wz9fp1ljg***********",
"Online": true,
"UpdateTime": 1573635952012,
"UserId": "edas_com***_****@******-*****. ***",
"ZoneId": "cn-shen****-*",
"GroupId": "8123db90-880f-486f-****-************",
"VpcId": "vpc-wz9b246zg************",
"IpAddr": "172.16.0.107",
"Name": "EDAS-scaled-cluster:default cluster",
"HeartbeatTime": 1573635952012,
"CreateTime": 1573626207270,
"RegionId": "cn-shenzhen:xuanye",
"EcuId": "07bd417a-b863-477d-****-************",
"DockerEnv": false
}
]
},
"EccList": {
"Ecc": [
{
"Ip": "172.16. *. ***",
"AppState": 7,
"EccId": "0cf49a6c-95a8-4aa8-****-************",
"CreateTime": 1573626226691,
"AppId": "3616cdca-4f92-4413-****-************",
"UpdateTime": 1573635952024,
"EcuId": "07bd417a-b863-477d-****-************",
"TaskState": 3,
"GroupId": "8123db90-880f-486f-****-************",
"VpcId": "vpc-wz9b246zg************"
}
]
},
"Application": {
"HealthCheckUrl": "",
"Owner": "edas_com***_****@******-*****. ***",
"Phone": "18866669999",
"RunningInstanceCount": 1,
"BuildPackageId": 0,
"UserId": "edas_com***_****@******-*****. ***",
"ApplicationId": "3616cdca-4f92-4413-****-************",
"Name": "testPopApi",
"InstanceCount": 1,
"Memory": 0,
"Cpu": 0,
"Port": 8080,
"Email": "1234567@qq.com",
"ClusterId": "0d247b93-8d62-4e34-****-************",
"Dockerize": false,
"RegionId": "cn-*******",
"CreateTime": 1573626155177,
"LaunchTime": 0
},
"DeployRecordList": {
"DeployRecord": [
{
"EccId": "0cf49a6c-95a8-4aa8-****-************",
"PackageVersionId": "441beb18-da42-44dc-****-************",
"CreateTime": 1573627453139,
"DeployRecordId": "bbc6c0d5-d792-4907-****-************",
"EcuId": "07bd417a-b863-477d-****-************",
"PackageMd5": "d0db5bcb442e492104d0f00e10a03dd9"
}
]
},
"GroupList": {
"Group": [
{
"GroupType": 0,
"GroupName": "_DEFAULT_GROUP",
"ClusterId": "0d247b93-8d62-4e34-****-************",
"PackageVersionId": "441beb18-da42-44dc-****-************",
"CreateTime": 1573626155185,
"AppId": "3616cdca-4f92-4413-****-************",
"UpdateTime": 1573627441388,
"AppVersionId": "changeorder_a**_*******_**",
"GroupId": "8123db90-880f-486f-****-************"
}
]
}
},
"Code": 200
}
XML
format
<Message>success</Message>
<AppInfo>
<EcuList>
<Ecu>
<AvailableMem>0</AvailableMem>
<AvailableCpu>0</AvailableCpu>
<InstanceId>i-wz9fp1ljg***********</InstanceId>
<Online>true</Online>
<UpdateTime>1573635952012</UpdateTime>
<UserId>edas_com***_****@******-*****. ***</UserId>
<ZoneId>cn-shen****-*</ZoneId>
<GroupId>8123db90-880f-486f-****-************</GroupId>
<VpcId>vpc-wz9b246zg************</VpcId>
<IpAddr>172.16.0.107</IpAddr>
<Name>EDAS-scaled-cluster: default cluster</Name>
<HeartbeatTime>1573635952012</HeartbeatTime>
<CreateTime>1573626207270</CreateTime>
<RegionId>cn-shenzhen:xuanye</RegionId>
<EcuId>07bd417a-b863-477d-****-************</EcuId>
<DockerEnv>false</DockerEnv>
</Ecu>
</EcuList>
<EccList>
<Ecc>
<Ip>172.16. *. ***</Ip>
<AppState>7</AppState>
<EccId>0cf49a6c-95a8-4aa8-****-************</EccId>
<CreateTime>1573626226691</CreateTime>
<AppId>3616cdca-4f92-4413-****-************</AppId>
<UpdateTime>1573635952024</UpdateTime>
<EcuId>07bd417a-b863-477d-****-************</EcuId>
<TaskState>3</TaskState>
<GroupId>8123db90-880f-486f-****-************</GroupId>
<VpcId>vpc-wz9b246zg************</VpcId>
</Ecc>
</EccList>
<Application>
<HealthCheckUrl/>
<Owner>edas_com***_****@******-*****. ***</Owner>
<Phone>18866669999</Phone>
<RunningInstanceCount>1</RunningInstanceCount>
<BuildPackageId>0</BuildPackageId>
<UserId>edas_com***_****@******-*****. ***</UserId>
<ApplicationId>3616cdca-4f92-4413-****-************</ApplicationId>
<Name>testPopApi</Name>
<InstanceCount>1</InstanceCount>
<Memory>0</Memory>
<Cpu>0</Cpu>
<Port>8080</Port>
<Email>1234567@qq.com</Email>
<ClusterId>0d247b93-8d62-4e34-****-************</ClusterId>
<Dockerize>false</Dockerize>
<RegionId>cn-*******</RegionId>
<CreateTime>1573626155177</CreateTime>
<LaunchTime>0</LaunchTime>
</Application>
<DeployRecordList>
<DeployRecord>
<EccId>0cf49a6c-95a8-4aa8-****-************</EccId>
<PackageVersionId>441beb18-da42-44dc-****-************</PackageVersionId>
<CreateTime>1573627453139</CreateTime>
<DeployRecordId>bbc6c0d5-d792-4907-****-************</DeployRecordId>
<EcuId>07bd417a-b863-477d-****-************</EcuId>
<PackageMd5>d0db5bcb442e492104d0f00e10a03dd9</PackageMd5>
</DeployRecord>
</DeployRecordList>
<GroupList>
<Group>
<GroupType>0</GroupType>
<GroupName>_DEFAULT_GROUP</GroupName>
<ClusterId>0d247b93-8d62-4e34-****-************</ClusterId>
<PackageVersionId>441beb18-da42-44dc-****-************</PackageVersionId>
<CreateTime>1573626155185</CreateTime>
<AppId>3616cdca-4f92-4413-****-************</AppId>
<UpdateTime>1573627441388</UpdateTime>
<AppVersionId>changeorder_a**_*******_**</AppVersionId>
<GroupId>8123db90-880f-486f-****-************</GroupId>
</Group>
</GroupList>
</AppInfo>
<Code>200</Code>
Error codes
For a list of error codes, visit the API Error Center.