All Products
Search
Document Center

Enterprise Distributed Application Service:QueryApplicationStatus

Last Updated:Jan 08, 2024

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ReadApplicationRead
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

GET /pop/v5/app/app_status

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

3616cdca-4f92-441**************

Response parameters

ParameterTypeDescriptionExample
object

The content that is returned.

Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
RequestIdstring

The ID of the request.

D16979DC-4D42-********
AppInfoobject

The information about the application.

EcuListobject []

The information about elastic compute units (ECUs).

VpcIdstring

The ID of the virtual private cloud (VPC).

vpc-wz9b246zg************
UpdateTimelong

The time when the ECU was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1573635952012
IpAddrstring

The private IP address of the ECU.

172.16.*.**
AvailableCpuinteger

The number of available CPU cores.

0
CreateTimelong

The time when the ECU was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1573626207270
UserIdstring

The ID of the user associated with the ECU.

edas_com***_****@******-*****.***
InstanceIdstring

The ID of the instance.

i-wz9fp1ljg***********
RegionIdstring

The ID of the region.

cn-shen****-*
EcuIdstring

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

07bd417a-b863-477d-****-************
GroupIdstring

The ID of the group.

8123db90-880f-486f-****-************
DockerEnvboolean

Indicates whether Docker is installed.

false
Onlineboolean

Indicates whether the ECU is online.

true
AvailableMeminteger

The size of the available memory.

0
ZoneIdstring

The ID of the zone.

cn-shen****-*
Namestring

The name of the ECU.

EDAS-scaled-cluster: default cluster
HeartbeatTimelong

The time when the last heartbeat detection was performed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1573635952012
EccListobject []

The information about elastic compute containers (ECCs).

VpcIdstring

The ID of the VPC.

vpc-wz9b246zg************
UpdateTimelong

The time when the ECC was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1573635952012
EcuIdstring

The unique ID of the ECU.

07bd417a-b863-477d-****-************
EccIdstring

The unique ID of the ECC.

0cf49a6c-95a8-4aa8-****-************
GroupIdstring

The ID of the instance group.

8123db90-880f-486f-****-************
AppStateinteger

The status of the application instance. Valid values:

  • 0: AGENT_OFF: indicates that the agent is offline.
  • 1: STOPPED: indicates that the application is stopped.
  • 3: RUNNING_BUT_URL_FAILED: indicates that the health check failed.
  • 7: RUNNING: indicates that the application is running.
7
TaskStateinteger

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

  • 0: UNKNOWN: indicates that the state of the latest task is unknown.
  • 1: PROCESSING: indicates that the latest task is being processed.
  • 2: SUCCESS: indicates that the latest task is executed.
  • 3: FAILED: indicates that the latest task failed.
3
CreateTimelong

The time when the ECC was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1573626226691
AppIdstring

The ID of the application.

3616cdca-4f92-4413-****-************
ContainerStatusstring

The status of the container.

“”
Ipstring

The private IP address of the ECU.

172.16.*.***
GroupListobject []

The information about the instance groups.

UpdateTimelong

The time when the instance group was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1573627441388
GroupNamestring

The name of the instance group.

_DEFAULT_GROUP
GroupIdstring

The ID of the instance group.

8123db90-880f-486f-****-************
CreateTimelong

The time when the instance group was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1573626155185
AppVersionIdstring

The ID of the change process for application deployment in the instance group.

changeorder_a**_*******_**
AppIdstring

The ID of the application.

3616cdca-4f92-4413-****-************
PackageVersionIdstring

The version of the deployment package that was used to deploy an application in the instance group.

441beb18-da42-44dc-****-************
GroupTypeinteger

The type of the instance group. Valid values:

  • 0: default group
  • 1: self-managed group
  • 2: canary release group
0
ClusterIdstring

The ID of the cluster.

0d247b93-8d62-4e34-****-************
DeployRecordListobject []

The information about deployment records.

EccIdstring

The unique ID of the ECC.

0cf49a6c-95a8-4aa8-****-************
EcuIdstring

The unique ID of the ECU.

07bd417a-b863-477d-****-************
PackageMd5string

The MD5 hash value of the deployment package.

d0db5bcb442e492104d0f00e10a03dd9
CreateTimelong

The time when the deployment record was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1573626226691
PackageVersionIdstring

The version of the deployment package that was used to deploy an application in the instance group.

441beb18-da42-44dc-****-************
DeployRecordIdstring

The ID of the deployment record.

bbc6c0d5-d792-4907-****-************
Applicationobject

The basic information about the application.

HealthCheckUrlstring

The health check URL.

“”
Ownerstring

The ID of the user who created the application.

edas_com***_****@******-*****.***
CreateTimelong

The time when the application was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1573626207270
UserIdstring

The ID of the Alibaba Cloud account.

edas_com***_****@******-*****.***
Portinteger

The port used by the application.

8080
RunningInstanceCountinteger

The number of application instances that are running.

1
Phonestring

The mobile number of the user who created the application.

1886666****
RegionIdstring

The ID of the namespace.

cn-shenzhen:test
BuildPackageIdinteger

The build package number of Enterprise Distributed Application Service (EDAS) Container.

0
Dockerizeboolean

Indicates whether the application is a Docker application.

false
Emailstring

The email address of the user who created the application.

1234567@qq.com
Cpuinteger

The number of CPU cores used by the application.

0
InstanceCountinteger

The number of application instances.

1
LaunchTimelong

The time when the application was launched. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

0
Memoryinteger

The memory size.

0
Namestring

The name of the application.

EDAS-scaled-cluster:default cluster
ApplicationIdstring

The ID of the application.

3616cdca-4f92-4413-****-************
ClusterIdstring

The ID of the cluster.

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

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "D16979DC-4D42-********",
  "AppInfo": {
    "EcuList": {
      "Ecu": [
        {
          "VpcId": "vpc-wz9b246zg************",
          "UpdateTime": 1573635952012,
          "IpAddr": "172.16.*.**",
          "AvailableCpu": 0,
          "CreateTime": 1573626207270,
          "UserId": "edas_com***_****@******-*****.***",
          "InstanceId": "i-wz9fp1ljg***********",
          "RegionId": "cn-shen****-*",
          "EcuId": "07bd417a-b863-477d-****-************",
          "GroupId": "8123db90-880f-486f-****-************",
          "DockerEnv": false,
          "Online": true,
          "AvailableMem": 0,
          "ZoneId": "cn-shen****-*",
          "Name": "EDAS-scaled-cluster: default cluster\n",
          "HeartbeatTime": 1573635952012
        }
      ]
    },
    "EccList": {
      "Ecc": [
        {
          "VpcId": "vpc-wz9b246zg************",
          "UpdateTime": 1573635952012,
          "EcuId": "07bd417a-b863-477d-****-************",
          "EccId": "0cf49a6c-95a8-4aa8-****-************",
          "GroupId": "8123db90-880f-486f-****-************",
          "AppState": 7,
          "TaskState": 3,
          "CreateTime": 1573626226691,
          "AppId": "3616cdca-4f92-4413-****-************",
          "ContainerStatus": "“”",
          "Ip": "172.16.*.***"
        }
      ]
    },
    "GroupList": {
      "Group": [
        {
          "UpdateTime": 1573627441388,
          "GroupName": "_DEFAULT_GROUP",
          "GroupId": "8123db90-880f-486f-****-************",
          "CreateTime": 1573626155185,
          "AppVersionId": "changeorder_a**_*******_**",
          "AppId": "3616cdca-4f92-4413-****-************",
          "PackageVersionId": "441beb18-da42-44dc-****-************",
          "GroupType": 0,
          "ClusterId": "0d247b93-8d62-4e34-****-************"
        }
      ]
    },
    "DeployRecordList": {
      "DeployRecord": [
        {
          "EccId": "0cf49a6c-95a8-4aa8-****-************",
          "EcuId": "07bd417a-b863-477d-****-************",
          "PackageMd5": "d0db5bcb442e492104d0f00e10a03dd9",
          "CreateTime": 1573626226691,
          "PackageVersionId": "441beb18-da42-44dc-****-************",
          "DeployRecordId": "bbc6c0d5-d792-4907-****-************"
        }
      ]
    },
    "Application": {
      "HealthCheckUrl": "“”",
      "Owner": "edas_com***_****@******-*****.***",
      "CreateTime": 1573626207270,
      "UserId": "edas_com***_****@******-*****.***",
      "Port": 8080,
      "RunningInstanceCount": 1,
      "Phone": "1886666****",
      "RegionId": "cn-shenzhen:test",
      "BuildPackageId": 0,
      "Dockerize": false,
      "Email": "1234567@qq.com",
      "Cpu": 0,
      "InstanceCount": 1,
      "LaunchTime": 0,
      "Memory": 0,
      "Name": "EDAS-scaled-cluster:default cluster\n",
      "ApplicationId": "3616cdca-4f92-4413-****-************",
      "ClusterId": "0d247b93-8d62-4e34-****-************"
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.