Queries the status of an application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see the topic about common request parameters.

Request syntax

GET /pop/v5/app/app_status HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
AppId String Query Yes 3616cdca-4f92-441**************

The ID of the application.

Response parameters

Parameter Type Example Description
AppInfo Struct

The information about the application.

Application Struct

The basic information of the application.

ApplicationId String 3616cdca-4f92-4413-****-************

The ID of the application.

BuildPackageId Integer 0

The build package number of EDAS Container.

ClusterId String 0d247b93-8d62-4e34-****-************

The ID of the cluster.

Cpu Integer 0

The number of CPUs used by the application.

CreateTime Long 1573626207270

The timestamp when the application was created.

Dockerize Boolean false

Indicates whether the application is a Docker application.

Email String 1234567@qq.com

The email address of the user who created the application.

HealthCheckUrl String ""

The health check URL.

InstanceCount Integer 1

The number of application instances.

LaunchTime Long 0

The timestamp when the application was launched.

Memory Integer 0

The amount of memory occupied by the application.

Name String EDAS-scaled-cluster: default cluster

The name of the application.

Owner String edas_com***_****@******-*****.***

The ID of the user who created the application.

Phone String 1886666****

The mobile number of the user who created the application.

Port Integer 8080

The port used by the application.

RegionId String cn-shenzhen:test

The ID of the namespace.

RunningInstanceCount Integer 1

The number of application instances that are running.

UserId String edas_com***_****@******-*****.***

The ID of the Alibaba Cloud account.

DeployRecordList Array of DeployRecord

The deployment records.

DeployRecord
CreateTime Long 1573626226691

The timestamp when the deployment record was created.

DeployRecordId String bbc6c0d5-d792-4907-****-************

The ID of the deployment record.

EccId String 0cf49a6c-95a8-4aa8-****-************

The ID of the elastic compute container (ECC).

EcuId String 07bd417a-b863-477d-****-************

The ID of the elastic compute unit (ECU).

PackageMd5 String d0db5bcb442e492104d0f00e10a03dd9

The value of the MD5 message-digest algorithm used in the deployment package of the application.

PackageVersionId String 441beb18-da42-44dc-****-************

The package version ID of the application deployed to the instance group.

EccList Array of Ecc

The ECC information.

Ecc
AppId String 3616cdca-4f92-4413-****-************

The ID of the application.

AppState Integer 7

The status of the application instance. The value is returned for application change processes. Valid values:

  • 0: AGENT_OFF
  • 1: STOPPED
  • 3: RUNNING_BUT_URL_FAILED
  • 7: RUNNING
ContainerStatus String ""

The status of the container where the application is running.

CreateTime Long 1573626226691

The timestamp when the ECC was created.

EccId String 0cf49a6c-95a8-4aa8-****-************

The ID of the ECC.

EcuId String 07bd417a-b863-477d-****-************

The ID of the ECU.

GroupId String 8123db90-880f-486f-****-************

The ID of the instance group.

Ip String 172.16.*.***

The internal IP address allocated to the ECU.

TaskState Integer 3

The status of the latest task initiated on the application instance. Valid values:

  • 0: UNKNOWN
  • 1: PROCESSING
  • 2: SUCCESS
  • 3: FAILED
UpdateTime Long 1573635952012

The timestamp when the ECC was last updated.

VpcId String vpc-wz9b246zg************

The ID of the virtual private cloud (VPC).

EcuList Array of Ecu

The ECU information.

Ecu
AvailableCpu Integer 0

The number of available CPUs.

AvailableMem Integer 0

The size of available memory.

CreateTime Long 1573626207270

The timestamp when the ECU was created.

DockerEnv Boolean false

Indicates whether Docker is installed.

EcuId String 07bd417a-b863-477d-****-************

The unique ID of the ECU. You can run the dmidecode command on the ECS instance to query the ECU ID.

GroupId String 8123db90-880f-486f-****-************

The ID of the instance group.

HeartbeatTime Long 1573635952012

The heartbeat timestamp of the ECU.

InstanceId String i-wz9fp1ljg***********

The ID of the application instance.

IpAddr String 172.16.*.**

The internal IP address allocated to the ECU.

Name String EDAS-scaled-cluster: default cluster

The name of the ECU.

Online Boolean true

Indicates whether the ECU is online.

RegionId String cn-shen****-*

The ID of the region.

RegionId String cn-shen****-*

The ID of the region.

UpdateTime Long 1573635952012

The timestamp when the ECU was last updated.

UserId String edas_com***_****@******-*****.***

The ID of the user associated with the ECU.

VpcId String vpc-wz9b246zg************

The ID of the VPC.

ZoneId String cn-shen****-*

The ID of the zone.

GroupList Array of Group

The returned information about the instance group where the application is deployed.

Group
AppId String 3616cdca-4f92-4413-****-************

The ID of the application.

AppVersionId String changeorder_a**_*******_**

The change process ID of application deployment in the instance group. This parameter applies only to original applications and is no longer included in the information about a new application.

ClusterId String 0d247b93-8d62-4e34-****-************

The ID of the cluster.

CreateTime Long 1573626155185

The timestamp when the instance group was created.

GroupId String 8123db90-880f-486f-****-************

The ID of the instance group.

GroupName String _DEFAULT_GROUP

The name of the instance group.

GroupType Integer 0

The type of the instance group. Valid values: 0: default group. 1: self-managed group. 2: canary release group.

PackageVersionId String 441beb18-da42-44dc-****-************

The package version ID of the application deployed to the instance group.

UpdateTime Long 1573627441388

The timestamp when the instance group was last updated.

Code Integer 200

The HTTP status code.

Message String success

The returned message that indicates whether the call is successful.

RequestId String D16979DC-4D42-********

The ID of the request.

Examples

Sample requests

GET /pop/v5/app/app_status HTTP/1.1
Common request headers
{
"AppId": "3616cdca-4f92-441**************"
}

Sample success responses

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>

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
}

Error codes

For a list of error codes, visit the API Error Center.