Function
Queries an application.
Request URL
/pop/v5/app/app_status
Request method
POST
Request parameters
Parameter | Type | Required? | Description |
---|---|---|---|
appId | String | Yes | Target application ID |
Response parameters
Parameter | Type | Description |
---|---|---|
Code | Integer | Code |
Message | String | Message |
AppInfo | Map | Application information |
AppInfo
Parameter | Type | Description |
---|---|---|
Application | Application | For details, see the definition of ApplicationEntity. |
GroupList | List<Group> | For details, see the definition of GroupEntity. |
EcuList | List<Ecu> | For details, see the definition of EcuEntity. |
EccList | List<Ecc> | For details, see the definition of EccEntity. |
DeployRecordList | List<DeployRecord> | For details, see the definition of DeployRecord. |
ApplicationEntity: Basic application information
Parameter | Type | Description |
---|---|---|
AppId | String | Application ID |
Name | String | Application name |
RegionId | String | Region ID |
Description | String | Application description |
Owner | String | Application creator |
InstanceCount | Integer | Number of included application instances |
RunningInstanceCount | Integer | Number of running application instances |
Port | Integer | Port occupied by the application |
UserId | String | Primary account ID |
SlbId | String | ID of the intranet-based SLB instance |
SlbIp | String | IP address of the intranet-based SLB instance |
SlbPort | Integer | Port occupied by the intranet-based SLB instance |
ExtSlbId | String | ID of the Internet-based SLB instance |
ExtSlbIp | String | IP address of the Internet-based SLB instance |
ApplicationType | String | Application deployment type, which can be War (WAR package deployment) or FatJar (JAR package deployment). If this parameter is set to null, the application is not deployed. |
ClusterType | Integer | Environmental type of the application cluster. Optional values: 0 (common Docker cluster); 1 (Swarm cluster); 2 (ECS cluster); 3 (Kubernetes cluster); 4 (automatically registered Pandora cluster). |
ClusterId | String | Cluster ID |
Dockerize | Boolean | Indicates whether the application is a Docker application |
Cpu | Integer | Number of CPU cores |
Memory | Integer | Memory size (MB) configured for the application instance |
HealthCheckUrl | String | Health check URL |
BuildpackId | Long | Container version ID |
CreateTime | Long | Creation time |
GroupEntity: Group information
Parameter | Type | Description |
---|---|---|
GroupId | String | Group ID |
GroupName | String | Group name |
GroupType | Integer | Group type. Optional values: 0 (default); 1 (created by user); 2 (grayscale group). |
AppId | String | Application ID |
ClusterId | String | Cluster ID |
PackageVersionId | String | Group deployment package ID |
AppVersionId | String | Group deployment record ID (obsolete) |
CreateTime | Long | Creation time |
UpdateTime | Long | Update time |
Expired | Boolean | Group deletion mark (hidden) |
EcuEntity: ECU information
Parameter | Type | Description |
---|---|---|
EcuId | String | Unique ID of the ECU instance, which can be obtained by running dmidecode on the ECS instance |
Online | Boolean | Indicates whether the ECU instance is online |
DockerEnv | Boolean | Indicates whether Docker is installed |
CreateTime | long | Creation time |
UpdateTime | long | Update time |
HeartbeatTime | long | Heartbeat time |
UserId | String | Associated user ID |
IpAddr | String | Intranet IP address of the ECU instance |
Name | String | Name |
ZoneId | String | ID of the zone where the instance is located |
RegionId | String | ID of the region where the instance is located |
InstanceId | String | Instance ID |
VpcId | String | VPC ID |
AvailableCpu | Integer | Available CPU |
AvailableMem | Integer | Available memory |
Cpu | Integer | Total number of CPUs |
Mem | Integer | Total memory |
EccEntity: ECC information
Parameter | Type | Description |
---|---|---|
EccId | String | Unique ID of an ECC instance |
EcuId | String | Unique ID of an ECU instance |
AppId | String | Unique ID of an application |
AppState | Integer | Status of an application instance (which is used by the change process). Optional values: AGENT_OFF(0); STOPPED(1); RUNNING_BUT_URL_FAILED(3); RUNNING(7). |
TaskState | Integer | Status of the most recent task on the instance. Optional values: UNKNOWN(0); PROCESSING(1); SUCCESS(2); FAILED(3). |
createTime | Long | Creation time |
updateTime | Long | Update time |
Ip | String | Intranet IP address of the ECU instance |
VpcId | String | VPC ID |
GroupId | String | Group ID |
DeployRecord: DeployRecord information
Parameter | Type | Description |
---|---|---|
EccId | String | Unique ID of an ECC instance |
EcuId | String | Unique ID of an ECU instance |
DeployRecordId | String | Deployment record ID |
PackageVersionId | String | Group deployment package ID |
PackageMd5 | String | MD5 value of the deployment package |
createTime | Long | Creation time |