QueryApplicationStatus - Enterprise Distributed Application Service

Queries the status of an application.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:ReadApplication

get

*Application

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application.	3616cdca-4f92-441**************

Response elements

Element	Type	Description	Example
	object	The content that is returned.
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
RequestId	string	The ID of the request.	D16979DC-4D42-********
AppInfo	object	The information about the application.
EcuList	object
Ecu	array<object>	The information about elastic compute units (ECUs).
	object	The details of the ECU.
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-wz9b246zg************
UpdateTime	integer	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
IpAddr	string	The private IP address of the ECU.	172.16..*
AvailableCpu	integer	The number of available CPU cores.	0
CreateTime	integer	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
UserId	string	The ID of the user associated with the ECU.	edas_com*_@**-*.*
InstanceId	string	The ID of the instance.	i-wz9fp1ljg***********
RegionId	string	The ID of the region.	cn-shen***-
EcuId	string	The unique ID of the ECU. You can run the `dmidecode` command on the ECS instance to query the ECU ID.	07bd417a-b863-477d-**-**********
GroupId	string	The ID of the group.	8123db90-880f-486f-**-**********
DockerEnv	boolean	Indicates whether Docker is installed.	false
Online	boolean	Indicates whether the ECU is online.	true
AvailableMem	integer	The size of the available memory.	0
ZoneId	string	The ID of the zone.	cn-shen***-
Name	string	The name of the ECU.	EDAS-scaled-cluster：默认集群
HeartbeatTime	integer	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
EccList	object
Ecc	array<object>	The information about elastic compute containers (ECCs).
	object	The details of the ECC.
VpcId	string	The ID of the VPC.	vpc-wz9b246zg************
UpdateTime	integer	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
EcuId	string	The unique ID of the ECU.	07bd417a-b863-477d-**-**********
EccId	string	The unique ID of the ECC.	0cf49a6c-95a8-4aa8-**-**********
GroupId	string	The ID of the instance group.	8123db90-880f-486f-**-**********
AppState	integer	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
TaskState	integer	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
CreateTime	integer	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
AppId	string	The ID of the application.	3616cdca-4f92-4413-**-**********
ContainerStatus	string	The status of the container.	“”
Ip	string	The private IP address of the ECU.	172.16..**
GroupList	object
Group	array<object>	The information about the instance groups.
	object	The details of the instance group.
UpdateTime	integer	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
GroupName	string	The name of the instance group.	_DEFAULT_GROUP
GroupId	string	The ID of the instance group.	8123db90-880f-486f-**-**********
CreateTime	integer	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
AppVersionId	string	The ID of the change process for application deployment in the instance group.	changeorder_a_***_
AppId	string	The ID of the application.	3616cdca-4f92-4413-**-**********
PackageVersionId	string	The version of the deployment package that was used to deploy an application in the instance group.	441beb18-da42-44dc-**-**********
GroupType	integer	The type of the instance group. Valid values: 0: default group 1: self-managed group 2: canary release group	0
ClusterId	string	The ID of the cluster.	0d247b93-8d62-4e34-**-**********
DeployRecordList	object
DeployRecord	array<object>	The information about deployment records.
	object	The details of deployment records.
EccId	string	The unique ID of the ECC.	0cf49a6c-95a8-4aa8-**-**********
EcuId	string	The unique ID of the ECU.	07bd417a-b863-477d-**-**********
PackageMd5	string	The MD5 hash value of the deployment package.	d0db5bcb442e492104d0f00e10a03dd9
CreateTime	integer	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
PackageVersionId	string	The version of the deployment package that was used to deploy an application in the instance group.	441beb18-da42-44dc-**-**********
DeployRecordId	string	The ID of the deployment record.	bbc6c0d5-d792-4907-**-**********
Application	object	The basic information about the application.
HealthCheckUrl	string	The health check URL.	“”
Owner	string	The ID of the user who created the application.	edas_com*_@**-*.*
CreateTime	integer	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
UserId	string	The ID of the Alibaba Cloud account.	edas_com*_@**-*.*
Port	integer	The port used by the application.	8080
RunningInstanceCount	integer	The number of application instances that are running.	1
Phone	string	The mobile number of the user who created the application.	1886666****
RegionId	string	The ID of the namespace.	cn-shenzhen:test
BuildPackageId	integer	The build package number of Enterprise Distributed Application Service (EDAS) Container.	0
Dockerize	boolean	Indicates whether the application is a Docker application.	false
Email	string	The email address of the user who created the application.	1234567@qq.com
Cpu	integer	The number of CPU cores used by the application.	0
InstanceCount	integer	The number of application instances.	1
LaunchTime	integer	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
Memory	integer	The memory size.	0
Name	string	The name of the application.	EDAS-scaled-cluster：默认集群
ApplicationId	string	The ID of the application.	3616cdca-4f92-4413-**-**********
ClusterId	string	The ID of the cluster.	0d247b93-8d62-4e34-**-**********

Examples

Success response

JSON format

{
  "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：默认集群",
          "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：默认集群",
      "ApplicationId": "3616cdca-4f92-4413-****-************",
      "ClusterId": "0d247b93-8d62-4e34-****-************"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.