GetApplication - Enterprise Distributed Application Service

Retrieves information about a specified application in an ECS cluster.

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

POST /pop/v5/app/app_info HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	29f0******************

Response elements

Element	Type	Description	Example
	object	The API response.
Code	integer	The status code.	200
Message	string	The additional information.	success
RequestId	string	The request ID.	F8DFGED-K98***************
Application	object	The application information.
ExtSlbIp	string	The public IP address of the SLB instance attached to the application.	47.114.xxx.xx
Owner	string	The creator of the application.	ouou@117274586608****
SlbPort	integer	The port of the internal-facing SLB instance attached to the application.	80
NameSpace	string	The namespace to which the application belongs.	doc-test
ExtSlbName	string	The name of the public-facing SLB instance attached to the application.	aa8eee383db084f42aebc4d9f52c****
CreateTime	integer	The UNIX timestamp when the application was created.	1610550324226
UserId	string	The ID of the Alibaba Cloud account.	test@dd******
Port	integer	The service port of the application.	8080
RunningInstanceCount	integer	The number of running application instances.	1
SlbIp	string	The IP address of the internal-facing SLB instance attached to the application.	192.*..**
Dockerize	boolean	Indicates whether the application is a Docker application: false: The application is not a Docker application. true: The application is a Docker application.	false
Description	string	The description of the application.	test
InstanceCount	integer	The number of instances in the application.	1
AppId	string	The application ID.	cfac**-847e-4325-ad56-b5c2bc54**
SlbInfo	string	Information about the internal-facing SLB instance attached to the application.	test
Memory	integer	The memory size for the application instance, in MB.	0
Name	string	The name of the application.	test
ClusterId	string	The ID of the ECS cluster where the application is deployed.	5ffc5895-**-b03a-c223c6c3**
SlbId	string	The ID of the internal-facing SLB instance attached to the application.	lb-bp**ck3s3b9xs6x**
HealthCheckUrl	string	The health check URL of the application.	http://127.0.0.1:8080/xyz.html
ApplicationType	string	The deployment type of the application: War: The application is deployed from a WAR package. FatJar: The application is deployed from a JAR package. Empty: The application is not deployed.	FatJar
ExtSlbId	string	The ID of the public-facing SLB instance attached to the application.	lb-bp1vceck3s3b9xs6x****
RegionId	string	The ID of the region where the application is located.	cn-hangzhou
BuildPackageId	integer	The ID of the container version.	59
Email	string	The email address.	**@*.com
Cpu	integer	The number of CPU cores.	1
ClusterType	string	The type of the application cluster: 0: A regular Docker cluster. 1: A Swarm cluster. 2: An ECS cluster. 3: A Kubernetes cluster. 4: A Pandora application cluster that supports automatic registration.	2
SlbName	string	The name of the internal-facing SLB instance attached to the application.	test
EnableUrlCheck	boolean	Indicates whether the URL health check is enabled: true: Enabled. false: Disabled. If enabled, EDAS probes the specified URL during application startup. If the URL is accessible, the application is considered started.	false
EnablePortCheck	boolean	Indicates whether the port health check is enabled: true: Enabled. false: Disabled. If enabled, EDAS checks if the port is in use during application startup. If the port is in use, the application is considered started.	false
AppPhase	string	The current phase of the Kubernetes application. This helps determine if the application is stable. Configuration operations are prohibited when the application is in an unstable state. ready: The application is ready and can be changed. progressing: The application is being changed. pending: The application change is blocked. failed: The application change failed. The ready phase is stable. Other phases are unstable.	ready
HaveManageAccess	string	Indicates whether the current user has management permissions on the application. This parameter is available only in RAM authentication mode.	true
WorkloadType	string	The workload type used to create the application. Supported types are Deployment and StatefulSet. This parameter does not apply to ECS applications.	StatefulSet
ResourceGroupId	string	The ID of the resource group.	rg-aekz****

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "F8DFGED-K98***************",
  "Application": {
    "ExtSlbIp": "47.114.xxx.xx",
    "Owner": "ouou@117274586608****",
    "SlbPort": 80,
    "NameSpace": "doc-test",
    "ExtSlbName": "aa8eee383db084f42aebc4d9f52c****",
    "CreateTime": 1610550324226,
    "UserId": "test@dd******",
    "Port": 8080,
    "RunningInstanceCount": 1,
    "SlbIp": "192.***.***.***",
    "Dockerize": false,
    "Description": "test",
    "InstanceCount": 1,
    "AppId": "cfac****-847e-4325-ad56-b5c2bc54****",
    "SlbInfo": "test",
    "Memory": 0,
    "Name": "test",
    "ClusterId": "5ffc5895-****-b03a-c223c6c3****",
    "SlbId": "lb-bp****ck3s3b9xs6x****",
    "HealthCheckUrl": "http://127.0.0.1:8080/xyz.html",
    "ApplicationType": "FatJar",
    "ExtSlbId": "lb-bp1vceck3s3b9xs6x****",
    "RegionId": "cn-hangzhou",
    "BuildPackageId": 59,
    "Email": "****@***.com",
    "Cpu": 1,
    "ClusterType": "2",
    "SlbName": "test",
    "EnableUrlCheck": false,
    "EnablePortCheck": false,
    "AppPhase": "ready",
    "HaveManageAccess": "true",
    "WorkloadType": "StatefulSet",
    "ResourceGroupId": "rg-aekz****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.